Interface Action.DeidentifyOrBuilder (3.71.0)

public static interface Action.DeidentifyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCloudStorageOutput()

public abstract 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 abstract 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.

getFileTypesToTransform(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Action.Deidentify.OutputCase getOutputCase()
Returns
Type Description
Action.Deidentify.OutputCase

getTransformationConfig()

public abstract 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.

getTransformationConfigOrBuilder()

public abstract 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 abstract 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.

getTransformationDetailsStorageConfigOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.