- 3.68.0 (latest)
- 3.67.0
- 3.66.0
- 3.64.0
- 3.63.0
- 3.62.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.53.0
- 3.52.0
- 3.51.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.41.0
- 3.40.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.6
- 3.6.7
- 3.5.0
- 3.4.0
- 3.3.2
- 3.2.1
- 3.1.4
public static final class Action.Deidentify.Builder extends GeneratedMessageV3.Builder<Action.Deidentify.Builder> implements Action.DeidentifyOrBuilder
Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets.
A TransformationDetail will be created for each transformation.
Compatible with: Inspection of Cloud Storage
Protobuf type google.privacy.dlp.v2.Action.Deidentify
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Action.Deidentify.BuilderImplements
Action.DeidentifyOrBuilderStatic 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 |
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 |
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 |
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 |
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 field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred.
Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation.
Key use cases:
Auditing and compliance
- Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies.
- Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data.
Troubleshooting and debugging
- Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline.
- Helps pinpoint the exact location and nature of failures, speeding up the debugging process.
Process verification and quality assurance
- Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended.
- Helps in verifying the effectiveness of the chosen de-identification strategies.
Data lineage and impact analysis
- Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data.
- Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability.
Reporting and operational insights
- You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied.
- These insights can inform optimization of de-identification configurations and resource planning.
To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data.
.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 |
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 |
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 field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred.
Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation.
Key use cases:
Auditing and compliance
- Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies.
- Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data.
Troubleshooting and debugging
- Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline.
- Helps pinpoint the exact location and nature of failures, speeding up the debugging process.
Process verification and quality assurance
- Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended.
- Helps in verifying the effectiveness of the chosen de-identification strategies.
Data lineage and impact analysis
- Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data.
- Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability.
Reporting and operational insights
- You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied.
- These insights can inform optimization of de-identification configurations and resource planning.
To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data.
.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 field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred.
Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation.
Key use cases:
Auditing and compliance
- Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies.
- Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data.
Troubleshooting and debugging
- Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline.
- Helps pinpoint the exact location and nature of failures, speeding up the debugging process.
Process verification and quality assurance
- Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended.
- Helps in verifying the effectiveness of the chosen de-identification strategies.
Data lineage and impact analysis
- Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data.
- Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability.
Reporting and operational insights
- You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied.
- These insights can inform optimization of de-identification configurations and resource planning.
To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data.
.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 field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred.
Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation.
Key use cases:
Auditing and compliance
- Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies.
- Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data.
Troubleshooting and debugging
- Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline.
- Helps pinpoint the exact location and nature of failures, speeding up the debugging process.
Process verification and quality assurance
- Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended.
- Helps in verifying the effectiveness of the chosen de-identification strategies.
Data lineage and impact analysis
- Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data.
- Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability.
Reporting and operational insights
- You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied.
- These insights can inform optimization of de-identification configurations and resource planning.
To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data.
.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 field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred.
Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation.
Key use cases:
Auditing and compliance
- Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies.
- Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data.
Troubleshooting and debugging
- Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline.
- Helps pinpoint the exact location and nature of failures, speeding up the debugging process.
Process verification and quality assurance
- Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended.
- Helps in verifying the effectiveness of the chosen de-identification strategies.
Data lineage and impact analysis
- Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data.
- Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability.
Reporting and operational insights
- You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied.
- These insights can inform optimization of de-identification configurations and resource planning.
To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data.
.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 |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
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 |
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 field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred.
Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation.
Key use cases:
Auditing and compliance
- Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies.
- Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data.
Troubleshooting and debugging
- Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline.
- Helps pinpoint the exact location and nature of failures, speeding up the debugging process.
Process verification and quality assurance
- Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended.
- Helps in verifying the effectiveness of the chosen de-identification strategies.
Data lineage and impact analysis
- Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data.
- Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability.
Reporting and operational insights
- You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied.
- These insights can inform optimization of de-identification configurations and resource planning.
To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data.
.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 |
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 |
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 |
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 field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred.
Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation.
Key use cases:
Auditing and compliance
- Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies.
- Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data.
Troubleshooting and debugging
- Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline.
- Helps pinpoint the exact location and nature of failures, speeding up the debugging process.
Process verification and quality assurance
- Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended.
- Helps in verifying the effectiveness of the chosen de-identification strategies.
Data lineage and impact analysis
- Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data.
- Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability.
Reporting and operational insights
- You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied.
- These insights can inform optimization of de-identification configurations and resource planning.
To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data.
.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 field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred.
Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation.
Key use cases:
Auditing and compliance
- Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies.
- Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data.
Troubleshooting and debugging
- Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline.
- Helps pinpoint the exact location and nature of failures, speeding up the debugging process.
Process verification and quality assurance
- Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended.
- Helps in verifying the effectiveness of the chosen de-identification strategies.
Data lineage and impact analysis
- Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data.
- Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability.
Reporting and operational insights
- You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied.
- These insights can inform optimization of de-identification configurations and resource planning.
To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data.
.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 |