Package com.google.privacy.dlp.v2

Interface Action.DeidentifyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Action.Deidentify, Action.Deidentify.Builder
Enclosing class:
Action
public static interface Action.DeidentifyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasTransformationConfig

      boolean hasTransformationConfig()
       User specified deidentify templates and configs for structured,
 unstructured, and image files.
      .google.privacy.dlp.v2.TransformationConfig transformation_config = 7;
      Returns:
      Whether the transformationConfig field is set.

    • getTransformationConfig

      TransformationConfig getTransformationConfig()
       User specified deidentify templates and configs for structured,
 unstructured, and image files.
      .google.privacy.dlp.v2.TransformationConfig transformation_config = 7;
      Returns:
      The transformationConfig.

    • getTransformationConfigOrBuilder

      TransformationConfigOrBuilder getTransformationConfigOrBuilder()
       User specified deidentify templates and configs for structured,
 unstructured, and image files.
      .google.privacy.dlp.v2.TransformationConfig transformation_config = 7;

    • hasTransformationDetailsStorageConfig

      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][google.privacy.dlp.v2.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:
      Whether the transformationDetailsStorageConfig field is set.

    • getTransformationDetailsStorageConfig

      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][google.privacy.dlp.v2.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:
      The transformationDetailsStorageConfig.

    • getTransformationDetailsStorageConfigOrBuilder

      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][google.privacy.dlp.v2.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;

    • hasCloudStorageOutput

      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:
      Whether the cloudStorageOutput field is set.

    • getCloudStorageOutput

      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:
      The cloudStorageOutput.

    • getCloudStorageOutputBytes

      com.google.protobuf.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:
      The bytes for cloudStorageOutput.

    • getFileTypesToTransformList

      List<FileType> getFileTypesToTransformList()
       List of user-specified file type groups to transform. If specified, only
 the files with these file types are transformed. If empty, all
 supported files are transformed. Supported types may be automatically
 added over time. Any unsupported file types that are set in this field
 are excluded from de-identification. An error is recorded for each
 unsupported file in the TransformationDetails output table. Currently the
 only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.
      repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;
      Returns:
      A list containing the fileTypesToTransform.

    • getFileTypesToTransformCount

      int getFileTypesToTransformCount()
       List of user-specified file type groups to transform. If specified, only
 the files with these file types are transformed. If empty, all
 supported files are transformed. Supported types may be automatically
 added over time. Any unsupported file types that are set in this field
 are excluded from de-identification. An error is recorded for each
 unsupported file in the TransformationDetails output table. Currently the
 only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.
      repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;
      Returns:
      The count of fileTypesToTransform.

    • getFileTypesToTransform

      FileType getFileTypesToTransform(int index)
       List of user-specified file type groups to transform. If specified, only
 the files with these file types are transformed. If empty, all
 supported files are transformed. Supported types may be automatically
 added over time. Any unsupported file types that are set in this field
 are excluded from de-identification. An error is recorded for each
 unsupported file in the TransformationDetails output table. Currently the
 only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.
      repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;
      Parameters:
      index - The index of the element to return.
      Returns:
      The fileTypesToTransform at the given index.

    • getFileTypesToTransformValueList

      List<Integer> getFileTypesToTransformValueList()
       List of user-specified file type groups to transform. If specified, only
 the files with these file types are transformed. If empty, all
 supported files are transformed. Supported types may be automatically
 added over time. Any unsupported file types that are set in this field
 are excluded from de-identification. An error is recorded for each
 unsupported file in the TransformationDetails output table. Currently the
 only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.
      repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;
      Returns:
      A list containing the enum numeric values on the wire for fileTypesToTransform.

    • getFileTypesToTransformValue

      int getFileTypesToTransformValue(int index)
       List of user-specified file type groups to transform. If specified, only
 the files with these file types are transformed. If empty, all
 supported files are transformed. Supported types may be automatically
 added over time. Any unsupported file types that are set in this field
 are excluded from de-identification. An error is recorded for each
 unsupported file in the TransformationDetails output table. Currently the
 only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.
      repeated .google.privacy.dlp.v2.FileType file_types_to_transform = 8;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of fileTypesToTransform at the given index.

    • getOutputCase

      Action.Deidentify.OutputCase getOutputCase()