public static final class Action.Deidentify extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CLOUD_STORAGE_OUTPUT_FIELD_NUMBER
public static final int CLOUD_STORAGE_OUTPUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILE_TYPES_TO_TRANSFORM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TRANSFORMATION_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TRANSFORMATION_DETAILS_STORAGE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Action.Deidentify getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Action.Deidentify.Builder newBuilder()
newBuilder(Action.Deidentify prototype)
public static Action.Deidentify.Builder newBuilder(Action.Deidentify prototype)
public static Action.Deidentify parseDelimitedFrom(InputStream input)
public static Action.Deidentify parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Action.Deidentify parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Action.Deidentify parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Action.Deidentify parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Action.Deidentify parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Action.Deidentify parseFrom(CodedInputStream input)
public static Action.Deidentify parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Action.Deidentify parseFrom(InputStream input)
public static Action.Deidentify parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Action.Deidentify parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Action.Deidentify parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Action.Deidentify> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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()
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.
|
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.
|
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.
|
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.
|
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()
getParserForType()
public Parser<Action.Deidentify> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public TransformationConfig getTransformationConfig()
User specified deidentify templates and configs for structured,
unstructured, and image files.
.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;
public TransformationConfigOrBuilder getTransformationConfigOrBuilder()
User specified deidentify templates and configs for structured,
unstructured, and image files.
.google.privacy.dlp.v2.TransformationConfig transformation_config = 7;
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
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;
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
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()
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.
|
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.
|
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
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Action.Deidentify.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Action.Deidentify.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Action.Deidentify.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides