Package com.google.privacy.dlp.v2

Class Action.Deidentify

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.privacy.dlp.v2.Action.Deidentify
All Implemented Interfaces:
Action.DeidentifyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Action
public static final class Action.Deidentify extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • TRANSFORMATION_CONFIG_FIELD_NUMBER

      public static final int TRANSFORMATION_CONFIG_FIELD_NUMBER
      See Also:

    • TRANSFORMATION_DETAILS_STORAGE_CONFIG_FIELD_NUMBER

      public static final int TRANSFORMATION_DETAILS_STORAGE_CONFIG_FIELD_NUMBER
      See Also:

    • CLOUD_STORAGE_OUTPUT_FIELD_NUMBER

      public static final int CLOUD_STORAGE_OUTPUT_FIELD_NUMBER
      See Also:

    • FILE_TYPES_TO_TRANSFORM_FIELD_NUMBER

      public static final int FILE_TYPES_TO_TRANSFORM_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getOutputCase

      public Action.Deidentify.OutputCase getOutputCase()
      Specified by:
      getOutputCase in interface Action.DeidentifyOrBuilder

    • hasTransformationConfig

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

    • getTransformationConfig

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

    • getTransformationConfigOrBuilder

      public TransformationConfigOrBuilder getTransformationConfigOrBuilder()
       User specified deidentify templates and configs for structured,
 unstructured, and image files.
      .google.privacy.dlp.v2.TransformationConfig transformation_config = 7;
      Specified by:
      getTransformationConfigOrBuilder in interface Action.DeidentifyOrBuilder

    • 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][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;
      Specified by:
      hasTransformationDetailsStorageConfig in interface Action.DeidentifyOrBuilder
      Returns:
      Whether the transformationDetailsStorageConfig field is set.

    • 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][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;
      Specified by:
      getTransformationDetailsStorageConfig in interface Action.DeidentifyOrBuilder
      Returns:
      The transformationDetailsStorageConfig.

    • 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][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;
      Specified by:
      getTransformationDetailsStorageConfigOrBuilder in interface Action.DeidentifyOrBuilder

    • 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];
      Specified by:
      hasCloudStorageOutput in interface Action.DeidentifyOrBuilder
      Returns:
      Whether the cloudStorageOutput field is set.

    • 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];
      Specified by:
      getCloudStorageOutput in interface Action.DeidentifyOrBuilder
      Returns:
      The cloudStorageOutput.

    • getCloudStorageOutputBytes

      public 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];
      Specified by:
      getCloudStorageOutputBytes in interface Action.DeidentifyOrBuilder
      Returns:
      The bytes for cloudStorageOutput.

    • getFileTypesToTransformList

      public 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;
      Specified by:
      getFileTypesToTransformList in interface Action.DeidentifyOrBuilder
      Returns:
      A list containing the fileTypesToTransform.

    • getFileTypesToTransformCount

      public 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;
      Specified by:
      getFileTypesToTransformCount in interface Action.DeidentifyOrBuilder
      Returns:
      The count of fileTypesToTransform.

    • getFileTypesToTransform

      public 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;
      Specified by:
      getFileTypesToTransform in interface Action.DeidentifyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The 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 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;
      Specified by:
      getFileTypesToTransformValueList in interface Action.DeidentifyOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for fileTypesToTransform.

    • getFileTypesToTransformValue

      public 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;
      Specified by:
      getFileTypesToTransformValue in interface Action.DeidentifyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of fileTypesToTransform at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Action.Deidentify parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action.Deidentify parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action.Deidentify parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action.Deidentify parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action.Deidentify parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action.Deidentify parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Action.Deidentify parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Action.Deidentify parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Action.Deidentify parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Action.Deidentify parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Action.Deidentify parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Action.Deidentify parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Action.Deidentify.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Action.Deidentify.Builder newBuilder()

    • newBuilder

      public static Action.Deidentify.Builder newBuilder(Action.Deidentify prototype)

    • toBuilder

      public Action.Deidentify.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Action.Deidentify.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Action.Deidentify getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Action.Deidentify> parser()

    • getParserForType

      public com.google.protobuf.Parser<Action.Deidentify> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Action.Deidentify getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder