Class Action.Deidentify (3.57.0) 

public static final class Action.Deidentify extends 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Action.Deidentify

Static Fields

CLOUD_STORAGE_OUTPUT_FIELD_NUMBER

public static final int CLOUD_STORAGE_OUTPUT_FIELD_NUMBER
Field Value
Type Description
int

FILE_TYPES_TO_TRANSFORM_FIELD_NUMBER

public static final int FILE_TYPES_TO_TRANSFORM_FIELD_NUMBER
Field Value
Type Description
int

TRANSFORMATION_CONFIG_FIELD_NUMBER

public static final int TRANSFORMATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

TRANSFORMATION_DETAILS_STORAGE_CONFIG_FIELD_NUMBER

public static final int TRANSFORMATION_DETAILS_STORAGE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Action.Deidentify getDefaultInstance()
Returns
Type Description
Action.Deidentify

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Action.Deidentify.Builder newBuilder()
Returns
Type Description
Action.Deidentify.Builder

newBuilder(Action.Deidentify prototype)

public static Action.Deidentify.Builder newBuilder(Action.Deidentify prototype)
Parameter
Name Description
prototype Action.Deidentify
Returns
Type Description
Action.Deidentify.Builder

parseDelimitedFrom(InputStream input)

public static Action.Deidentify parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Action.Deidentify parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Action.Deidentify parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Action.Deidentify parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Action.Deidentify parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Action.Deidentify parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Action.Deidentify parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Action.Deidentify parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Action.Deidentify parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Action.Deidentify parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Action.Deidentify parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Action.Deidentify parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Deidentify
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Action.Deidentify> parser()
Returns
Type Description
Parser<Deidentify>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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

getParserForType()

public Parser<Action.Deidentify> getParserForType()
Returns
Type Description
Parser<Deidentify>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 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 message for more information about what is noted).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Returns
Type Description
TransformationDetailsStorageConfig

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 message for more information about what is noted).

.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 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 message for more information about what is noted).

.google.privacy.dlp.v2.TransformationDetailsStorageConfig transformation_details_storage_config = 3;

Returns
Type Description
boolean

Whether the transformationDetailsStorageConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Action.Deidentify.Builder newBuilderForType()
Returns
Type Description
Action.Deidentify.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Action.Deidentify.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Action.Deidentify.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Action.Deidentify.Builder toBuilder()
Returns
Type Description
Action.Deidentify.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException