- 3.87.0 (latest)
- 3.86.0
- 3.85.0
- 3.84.0
- 3.82.0
- 3.80.0
- 3.79.0
- 3.78.0
- 3.77.0
- 3.76.0
- 3.74.0
- 3.72.0
- 3.71.0
- 3.68.0
- 3.67.0
- 3.66.0
- 3.64.0
- 3.63.0
- 3.62.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.53.0
- 3.52.0
- 3.51.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.41.0
- 3.40.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.6
- 3.6.7
- 3.5.0
- 3.4.0
- 3.3.2
- 3.2.1
- 3.1.4
public static final class Action.Deidentify extends GeneratedMessage implements Action.DeidentifyOrBuilderCreate 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Action.DeidentifyImplements
Action.DeidentifyOrBuilderStatic 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 |
|
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 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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 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 | |
|---|---|
| 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 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 | |
|---|---|
| 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 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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 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 | |
|---|---|
| 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> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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 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 |
TransformationDetailsStorageConfig |
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 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 |
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 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()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Action.Deidentify.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Action.Deidentify.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Action.Deidentify.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Action.Deidentify.Builder |
|
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 |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|