Class Action.Deidentify.Builder (3.57.0) 

public static final class Action.Deidentify.Builder extends GeneratedMessageV3.Builder<Action.Deidentify.Builder> implements Action.DeidentifyOrBuilder

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

Protobuf type google.privacy.dlp.v2.Action.Deidentify

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Action.Deidentify.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllFileTypesToTransform(Iterable<? extends FileType> values)

public Action.Deidentify.Builder addAllFileTypesToTransform(Iterable<? extends FileType> values)

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.FileType>

The fileTypesToTransform to add.
Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

addAllFileTypesToTransformValue(Iterable<Integer> values)

public Action.Deidentify.Builder addAllFileTypesToTransformValue(Iterable<Integer> values)

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for fileTypesToTransform to add.
Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

addFileTypesToTransform(FileType value)

public Action.Deidentify.Builder addFileTypesToTransform(FileType value)

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Parameter
Name Description
value FileType

The fileTypesToTransform to add.
Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

addFileTypesToTransformValue(int value)

public Action.Deidentify.Builder addFileTypesToTransformValue(int value)

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for fileTypesToTransform to add.
Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Action.Deidentify.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Action.Deidentify.Builder
Overrides

build()

public Action.Deidentify build()
Returns
Type Description
Action.Deidentify

buildPartial()

public Action.Deidentify buildPartial()
Returns
Type Description
Action.Deidentify

clear()

public Action.Deidentify.Builder clear()
Returns
Type Description
Action.Deidentify.Builder
Overrides

clearCloudStorageOutput()

public Action.Deidentify.Builder clearCloudStorageOutput()

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

string cloud_storage_output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Action.Deidentify.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Action.Deidentify.Builder
Overrides

clearFileTypesToTransform()

public Action.Deidentify.Builder clearFileTypesToTransform()

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Action.Deidentify.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Action.Deidentify.Builder
Overrides

clearOutput()

public Action.Deidentify.Builder clearOutput()
Returns
Type Description
Action.Deidentify.Builder

clearTransformationConfig()

public Action.Deidentify.Builder clearTransformationConfig()

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

.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

Returns
Type Description
Action.Deidentify.Builder

clearTransformationDetailsStorageConfig()

public Action.Deidentify.Builder clearTransformationDetailsStorageConfig()

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).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Returns
Type Description
Action.Deidentify.Builder

clone()

public Action.Deidentify.Builder clone()
Returns
Type Description
Action.Deidentify.Builder
Overrides

getCloudStorageOutput()

public String 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

string cloud_storage_output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The cloudStorageOutput.

getCloudStorageOutputBytes()

public ByteString getCloudStorageOutputBytes()

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

string cloud_storage_output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for cloudStorageOutput.

getDefaultInstanceForType()

public Action.Deidentify getDefaultInstanceForType()
Returns
Type Description
Action.Deidentify

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFileTypesToTransform(int index)

public FileType getFileTypesToTransform(int index)

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
FileType

The fileTypesToTransform at the given index.

getFileTypesToTransformCount()

public int getFileTypesToTransformCount()

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Returns
Type Description
int

The count of fileTypesToTransform.

getFileTypesToTransformList()

public List<FileType> getFileTypesToTransformList()

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Returns
Type Description
List<FileType>

A list containing the fileTypesToTransform.

getFileTypesToTransformValue(int index)

public int getFileTypesToTransformValue(int index)

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of fileTypesToTransform at the given index.

getFileTypesToTransformValueList()

public List<Integer> getFileTypesToTransformValueList()

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for fileTypesToTransform.

getOutputCase()

public Action.Deidentify.OutputCase getOutputCase()
Returns
Type Description
Action.Deidentify.OutputCase

getTransformationConfig()

public TransformationConfig getTransformationConfig()

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

.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

Returns
Type Description
TransformationConfig

The transformationConfig.

getTransformationConfigBuilder()

public TransformationConfig.Builder getTransformationConfigBuilder()

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

.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

Returns
Type Description
TransformationConfig.Builder

getTransformationConfigOrBuilder()

public TransformationConfigOrBuilder getTransformationConfigOrBuilder()

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

.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

Returns
Type Description
TransformationConfigOrBuilder

getTransformationDetailsStorageConfig()

public TransformationDetailsStorageConfig 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).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Returns
Type Description
TransformationDetailsStorageConfig

The transformationDetailsStorageConfig.

getTransformationDetailsStorageConfigBuilder()

public TransformationDetailsStorageConfig.Builder getTransformationDetailsStorageConfigBuilder()

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).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Returns
Type Description
TransformationDetailsStorageConfig.Builder

getTransformationDetailsStorageConfigOrBuilder()

public TransformationDetailsStorageConfigOrBuilder getTransformationDetailsStorageConfigOrBuilder()

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).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Returns
Type Description
TransformationDetailsStorageConfigOrBuilder

hasCloudStorageOutput()

public boolean hasCloudStorageOutput()

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

string cloud_storage_output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the cloudStorageOutput field is set.

hasTransformationConfig()

public boolean hasTransformationConfig()

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

.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

Returns
Type Description
boolean

Whether the transformationConfig field is set.

hasTransformationDetailsStorageConfig()

public boolean hasTransformationDetailsStorageConfig()

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).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Returns
Type Description
boolean

Whether the transformationDetailsStorageConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Action.Deidentify other)

public Action.Deidentify.Builder mergeFrom(Action.Deidentify other)
Parameter
Name Description
other Action.Deidentify
Returns
Type Description
Action.Deidentify.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Action.Deidentify.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Deidentify.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Action.Deidentify.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Action.Deidentify.Builder
Overrides

mergeTransformationConfig(TransformationConfig value)

public Action.Deidentify.Builder mergeTransformationConfig(TransformationConfig value)

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

.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

Parameter
Name Description
value TransformationConfig
Returns
Type Description
Action.Deidentify.Builder

mergeTransformationDetailsStorageConfig(TransformationDetailsStorageConfig value)

public Action.Deidentify.Builder mergeTransformationDetailsStorageConfig(TransformationDetailsStorageConfig value)

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).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Parameter
Name Description
value TransformationDetailsStorageConfig
Returns
Type Description
Action.Deidentify.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Action.Deidentify.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Action.Deidentify.Builder
Overrides

setCloudStorageOutput(String value)

public Action.Deidentify.Builder setCloudStorageOutput(String value)

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

string cloud_storage_output = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The cloudStorageOutput to set.
Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

setCloudStorageOutputBytes(ByteString value)

public Action.Deidentify.Builder setCloudStorageOutputBytes(ByteString value)

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

string cloud_storage_output = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for cloudStorageOutput to set.
Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Action.Deidentify.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Action.Deidentify.Builder
Overrides

setFileTypesToTransform(int index, FileType value)

public Action.Deidentify.Builder setFileTypesToTransform(int index, FileType value)

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Parameters
Name Description
index int

The index to set the value at.
value FileType

The fileTypesToTransform to set.
Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

setFileTypesToTransformValue(int index, int value)

public Action.Deidentify.Builder setFileTypesToTransformValue(int index, int value)

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.

repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for fileTypesToTransform to set.
Returns
Type Description
Action.Deidentify.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Action.Deidentify.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Action.Deidentify.Builder
Overrides

setTransformationConfig(TransformationConfig value)

public Action.Deidentify.Builder setTransformationConfig(TransformationConfig value)

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

.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

Parameter
Name Description
value TransformationConfig
Returns
Type Description
Action.Deidentify.Builder

setTransformationConfig(TransformationConfig.Builder builderForValue)

public Action.Deidentify.Builder setTransformationConfig(TransformationConfig.Builder builderForValue)

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

.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

Parameter
Name Description
builderForValue TransformationConfig.Builder
Returns
Type Description
Action.Deidentify.Builder

setTransformationDetailsStorageConfig(TransformationDetailsStorageConfig value)

public Action.Deidentify.Builder setTransformationDetailsStorageConfig(TransformationDetailsStorageConfig value)

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).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Parameter
Name Description
value TransformationDetailsStorageConfig
Returns
Type Description
Action.Deidentify.Builder

setTransformationDetailsStorageConfig(TransformationDetailsStorageConfig.Builder builderForValue)

public Action.Deidentify.Builder setTransformationDetailsStorageConfig(TransformationDetailsStorageConfig.Builder builderForValue)

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).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Parameter
Name Description
builderForValue TransformationDetailsStorageConfig.Builder
Returns
Type Description
Action.Deidentify.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Action.Deidentify.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Action.Deidentify.Builder
Overrides