Data Loss Prevention V2 Client - Class Deidentify (1.17.0)

Reference documentation and code samples for the Data Loss Prevention V2 Client class Deidentify.

Create a de-identified copy of the requested table or files.

A TransformationDetail will be created for each transformation. If any rows in BigQuery are skipped during de-identification (transformation errors or row size exceeds BigQuery insert API limits) they are placed in the failure output table. If the original row exceeds the BigQuery insert API limit it will be truncated when written to the failure output table. The failure output table can be set in the action.deidentify.output.big_query_output.deidentified_failure_output_table field, if no table is set, a table will be automatically created in the same project and dataset as the original table. Compatible with: Inspect

Generated from protobuf message google.privacy.dlp.v2.Action.Deidentify

Namespace

Google \ Cloud \ Dlp \ V2 \ Action

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ transformation_config Google\Cloud\Dlp\V2\TransformationConfig

User specified deidentify templates and configs for structured, unstructured, and image files.
↳ transformation_details_storage_config Google\Cloud\Dlp\V2\TransformationDetailsStorageConfig

Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted).
↳ cloud_storage_output string

Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket
↳ file_types_to_transform array

List of user-specified file type groups to transform. If specified, only the files with these file types will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.

getTransformationConfig

User specified deidentify templates and configs for structured, unstructured, and image files.

Returns
Type Description
Google\Cloud\Dlp\V2\TransformationConfig|null

hasTransformationConfig

clearTransformationConfig

setTransformationConfig

User specified deidentify templates and configs for structured, unstructured, and image files.

Parameter
Name Description
var Google\Cloud\Dlp\V2\TransformationConfig
Returns
Type Description
$this

getTransformationDetailsStorageConfig

Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted).

Returns
Type Description
Google\Cloud\Dlp\V2\TransformationDetailsStorageConfig|null

hasTransformationDetailsStorageConfig

clearTransformationDetailsStorageConfig

setTransformationDetailsStorageConfig

Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted).

Parameter
Name Description
var Google\Cloud\Dlp\V2\TransformationDetailsStorageConfig
Returns
Type Description
$this

getCloudStorageOutput

Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path.

Form of: gs://bucket/folder/ or gs://bucket

Returns
Type Description
string

hasCloudStorageOutput

setCloudStorageOutput

Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path.

Form of: gs://bucket/folder/ or gs://bucket

Parameter
Name Description
var string
Returns
Type Description
$this

getFileTypesToTransform

List of user-specified file type groups to transform. If specified, only the files with these file types will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFileTypesToTransform

List of user-specified file type groups to transform. If specified, only the files with these file types will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getOutput

Returns
Type Description
string