|
17 | 17 | package com.google.api.services.dlp.v2.model;
|
18 | 18 |
|
19 | 19 | /**
|
20 |
| - * Create a de-identified copy of the requested table or files. A TransformationDetail will be |
21 |
| - * created for each transformation. If any rows in BigQuery are skipped during de-identification |
22 |
| - * (transformation errors or row size exceeds BigQuery insert API limits) they are placed in the |
23 |
| - * failure output table. If the original row exceeds the BigQuery insert API limit it will be |
24 |
| - * truncated when written to the failure output table. The failure output table can be set in the |
25 |
| - * action.deidentify.output.big_query_output.deidentified_failure_output_table field, if no table is |
26 |
| - * set, a table will be automatically created in the same project and dataset as the original table. |
27 |
| - * Compatible with: Inspect |
| 20 | + * Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A |
| 21 | + * TransformationDetail will be created for each transformation. Compatible with: Inspection of |
| 22 | + * Cloud Storage |
28 | 23 | *
|
29 | 24 | * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
|
30 | 25 | * transmitted over HTTP when working with the Sensitive Data Protection (DLP). For a detailed
|
@@ -66,11 +61,34 @@ public final class GooglePrivacyDlpV2Deidentify extends com.google.api.client.js
|
66 | 61 | private GooglePrivacyDlpV2TransformationConfig transformationConfig;
|
67 | 62 |
|
68 | 63 | /**
|
69 |
| - * Config for storing transformation details. This is separate from the de-identified content, and |
70 |
| - * contains metadata about the successful transformations and/or failures that occurred while de- |
71 |
| - * identifying. This needs to be set in order for users to access information about the status of |
72 |
| - * each transformation (see TransformationDetails message for more information about what is |
73 |
| - * noted). |
| 64 | + * Config for storing transformation details. This field specifies the configuration for storing |
| 65 | + * detailed metadata about each transformation performed during a de-identification process. The |
| 66 | + * metadata is stored separately from the de-identified content itself and provides a granular |
| 67 | + * record of both successful transformations and any failures that occurred. Enabling this |
| 68 | + * configuration is essential for users who need to access comprehensive information about the |
| 69 | + * status, outcome, and specifics of each transformation. The details are captured in the |
| 70 | + * TransformationDetails message for each operation. Key use cases: * **Auditing and compliance** |
| 71 | + * * Provides a verifiable audit trail of de-identification activities, which is crucial for |
| 72 | + * meeting regulatory requirements and internal data governance policies. * Logs what data was |
| 73 | + * transformed, what transformations were applied, when they occurred, and their success status. |
| 74 | + * This helps demonstrate accountability and due diligence in protecting sensitive data. * |
| 75 | + * **Troubleshooting and debugging** * Offers detailed error messages and context if a |
| 76 | + * transformation fails. This information is useful for diagnosing and resolving issues in the de- |
| 77 | + * identification pipeline. * Helps pinpoint the exact location and nature of failures, speeding |
| 78 | + * up the debugging process. * **Process verification and quality assurance** * Allows users to |
| 79 | + * confirm that de-identification rules and transformations were applied correctly and |
| 80 | + * consistently across the dataset as intended. * Helps in verifying the effectiveness of the |
| 81 | + * chosen de-identification strategies. * **Data lineage and impact analysis** * Creates a record |
| 82 | + * of how data elements were modified, contributing to data lineage. This is useful for |
| 83 | + * understanding the provenance of de-identified data. * Aids in assessing the potential impact of |
| 84 | + * de-identification choices on downstream analytical processes or data usability. * **Reporting |
| 85 | + * and operational insights** * You can analyze the metadata stored in a queryable BigQuery table |
| 86 | + * to generate reports on transformation success rates, common error types, processing volumes |
| 87 | + * (e.g., transformedBytes), and the types of transformations applied. * These insights can inform |
| 88 | + * optimization of de-identification configurations and resource planning. To take advantage of |
| 89 | + * these benefits, set this configuration. The stored details include a description of the |
| 90 | + * transformation, success or error codes, error messages, the number of bytes transformed, the |
| 91 | + * location of the transformed content, and identifiers for the job and source data. |
74 | 92 | * The value may be {@code null}.
|
75 | 93 | */
|
76 | 94 | @com.google.api.client.util.Key
|
@@ -142,23 +160,69 @@ public GooglePrivacyDlpV2Deidentify setTransformationConfig(GooglePrivacyDlpV2Tr
|
142 | 160 | }
|
143 | 161 |
|
144 | 162 | /**
|
145 |
| - * Config for storing transformation details. This is separate from the de-identified content, and |
146 |
| - * contains metadata about the successful transformations and/or failures that occurred while de- |
147 |
| - * identifying. This needs to be set in order for users to access information about the status of |
148 |
| - * each transformation (see TransformationDetails message for more information about what is |
149 |
| - * noted). |
| 163 | + * Config for storing transformation details. This field specifies the configuration for storing |
| 164 | + * detailed metadata about each transformation performed during a de-identification process. The |
| 165 | + * metadata is stored separately from the de-identified content itself and provides a granular |
| 166 | + * record of both successful transformations and any failures that occurred. Enabling this |
| 167 | + * configuration is essential for users who need to access comprehensive information about the |
| 168 | + * status, outcome, and specifics of each transformation. The details are captured in the |
| 169 | + * TransformationDetails message for each operation. Key use cases: * **Auditing and compliance** |
| 170 | + * * Provides a verifiable audit trail of de-identification activities, which is crucial for |
| 171 | + * meeting regulatory requirements and internal data governance policies. * Logs what data was |
| 172 | + * transformed, what transformations were applied, when they occurred, and their success status. |
| 173 | + * This helps demonstrate accountability and due diligence in protecting sensitive data. * |
| 174 | + * **Troubleshooting and debugging** * Offers detailed error messages and context if a |
| 175 | + * transformation fails. This information is useful for diagnosing and resolving issues in the de- |
| 176 | + * identification pipeline. * Helps pinpoint the exact location and nature of failures, speeding |
| 177 | + * up the debugging process. * **Process verification and quality assurance** * Allows users to |
| 178 | + * confirm that de-identification rules and transformations were applied correctly and |
| 179 | + * consistently across the dataset as intended. * Helps in verifying the effectiveness of the |
| 180 | + * chosen de-identification strategies. * **Data lineage and impact analysis** * Creates a record |
| 181 | + * of how data elements were modified, contributing to data lineage. This is useful for |
| 182 | + * understanding the provenance of de-identified data. * Aids in assessing the potential impact of |
| 183 | + * de-identification choices on downstream analytical processes or data usability. * **Reporting |
| 184 | + * and operational insights** * You can analyze the metadata stored in a queryable BigQuery table |
| 185 | + * to generate reports on transformation success rates, common error types, processing volumes |
| 186 | + * (e.g., transformedBytes), and the types of transformations applied. * These insights can inform |
| 187 | + * optimization of de-identification configurations and resource planning. To take advantage of |
| 188 | + * these benefits, set this configuration. The stored details include a description of the |
| 189 | + * transformation, success or error codes, error messages, the number of bytes transformed, the |
| 190 | + * location of the transformed content, and identifiers for the job and source data. |
150 | 191 | * @return value or {@code null} for none
|
151 | 192 | */
|
152 | 193 | public GooglePrivacyDlpV2TransformationDetailsStorageConfig getTransformationDetailsStorageConfig() {
|
153 | 194 | return transformationDetailsStorageConfig;
|
154 | 195 | }
|
155 | 196 |
|
156 | 197 | /**
|
157 |
| - * Config for storing transformation details. This is separate from the de-identified content, and |
158 |
| - * contains metadata about the successful transformations and/or failures that occurred while de- |
159 |
| - * identifying. This needs to be set in order for users to access information about the status of |
160 |
| - * each transformation (see TransformationDetails message for more information about what is |
161 |
| - * noted). |
| 198 | + * Config for storing transformation details. This field specifies the configuration for storing |
| 199 | + * detailed metadata about each transformation performed during a de-identification process. The |
| 200 | + * metadata is stored separately from the de-identified content itself and provides a granular |
| 201 | + * record of both successful transformations and any failures that occurred. Enabling this |
| 202 | + * configuration is essential for users who need to access comprehensive information about the |
| 203 | + * status, outcome, and specifics of each transformation. The details are captured in the |
| 204 | + * TransformationDetails message for each operation. Key use cases: * **Auditing and compliance** |
| 205 | + * * Provides a verifiable audit trail of de-identification activities, which is crucial for |
| 206 | + * meeting regulatory requirements and internal data governance policies. * Logs what data was |
| 207 | + * transformed, what transformations were applied, when they occurred, and their success status. |
| 208 | + * This helps demonstrate accountability and due diligence in protecting sensitive data. * |
| 209 | + * **Troubleshooting and debugging** * Offers detailed error messages and context if a |
| 210 | + * transformation fails. This information is useful for diagnosing and resolving issues in the de- |
| 211 | + * identification pipeline. * Helps pinpoint the exact location and nature of failures, speeding |
| 212 | + * up the debugging process. * **Process verification and quality assurance** * Allows users to |
| 213 | + * confirm that de-identification rules and transformations were applied correctly and |
| 214 | + * consistently across the dataset as intended. * Helps in verifying the effectiveness of the |
| 215 | + * chosen de-identification strategies. * **Data lineage and impact analysis** * Creates a record |
| 216 | + * of how data elements were modified, contributing to data lineage. This is useful for |
| 217 | + * understanding the provenance of de-identified data. * Aids in assessing the potential impact of |
| 218 | + * de-identification choices on downstream analytical processes or data usability. * **Reporting |
| 219 | + * and operational insights** * You can analyze the metadata stored in a queryable BigQuery table |
| 220 | + * to generate reports on transformation success rates, common error types, processing volumes |
| 221 | + * (e.g., transformedBytes), and the types of transformations applied. * These insights can inform |
| 222 | + * optimization of de-identification configurations and resource planning. To take advantage of |
| 223 | + * these benefits, set this configuration. The stored details include a description of the |
| 224 | + * transformation, success or error codes, error messages, the number of bytes transformed, the |
| 225 | + * location of the transformed content, and identifiers for the job and source data. |
162 | 226 | * @param transformationDetailsStorageConfig transformationDetailsStorageConfig or {@code null} for none
|
163 | 227 | */
|
164 | 228 | public GooglePrivacyDlpV2Deidentify setTransformationDetailsStorageConfig(GooglePrivacyDlpV2TransformationDetailsStorageConfig transformationDetailsStorageConfig) {
|
|
0 commit comments