Class 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.GeneratedMessageV3
    implements Action.DeidentifyOrBuilder
     Create a de-identified copy of the requested table or files.
    
     A TransformationDetail will be created for each transformation.
    
     If any rows in BigQuery are skipped during de-identification
     (transformation errors or row size exceeds BigQuery insert API limits) they
     are placed in the failure output table. If the original row exceeds
     the BigQuery insert API limit it will be truncated when written to the
     failure output table. The failure output table can be set in the
     action.deidentify.output.big_query_output.deidentified_failure_output_table
     field, if no table is set, a table will be automatically created in the
     same project and dataset as the original table.
    
     Compatible with: Inspect
     
    Protobuf type google.privacy.dlp.v2.Action.Deidentify
    See Also:
    Serialized Form
    • Field Detail

      • TRANSFORMATION_CONFIG_FIELD_NUMBER

        public static final int TRANSFORMATION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TRANSFORMATION_DETAILS_STORAGE_CONFIG_FIELD_NUMBER

        public static final int TRANSFORMATION_DETAILS_STORAGE_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CLOUD_STORAGE_OUTPUT_FIELD_NUMBER

        public static final int CLOUD_STORAGE_OUTPUT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FILE_TYPES_TO_TRANSFORM_FIELD_NUMBER

        public static final int FILE_TYPES_TO_TRANSFORM_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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.
      • hasTransformationDetailsStorageConfig

        public boolean hasTransformationDetailsStorageConfig()
         Config for storing transformation details. This is separate from the
         de-identified content, and contains metadata about the successful
         transformations and/or failures that occurred while de-identifying. This
         needs to be set in order for users to access information about the status
         of each transformation (see
         [TransformationDetails][google.privacy.dlp.v2.TransformationDetails]
         message for more information about what is noted).
         
        .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 is separate from the
         de-identified content, and contains metadata about the successful
         transformations and/or failures that occurred while de-identifying. This
         needs to be set in order for users to access information about the status
         of each transformation (see
         [TransformationDetails][google.privacy.dlp.v2.TransformationDetails]
         message for more information about what is noted).
         
        .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 is separate from the
         de-identified content, and contains metadata about the successful
         transformations and/or failures that occurred while de-identifying. This
         needs to be set in order for users to access information about the status
         of each transformation (see
         [TransformationDetails][google.privacy.dlp.v2.TransformationDetails]
         message for more information about what is noted).
         
        .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 filetypes 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 filetypes 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 filetypes 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 filetypes 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 filetypes 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 filetypes 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 filetypes 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 filetypes 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 filetypes 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 filetypes 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.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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​(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
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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