Types for Google Cloud Dlp v2 API¶
- class google.cloud.dlp_v2.types.Action(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- save_findings¶
Save resulting findings in a provided location.
This field is a member of oneof
action.
- publish_summary_to_cscc¶
Publish summary to Cloud Security Command Center (Alpha).
This field is a member of oneof
action.
- publish_findings_to_cloud_data_catalog¶
Publish findings to Cloud Datahub.
This field is a member of oneof
action.
- job_notification_emails¶
Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts.
This field is a member of oneof
action.
- publish_to_stackdriver¶
Enable Stackdriver metric dlp.googleapis.com/finding_count.
This field is a member of oneof
action.
- class Deidentify(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreate 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
- transformation_config¶
User specified deidentify templates and configs for structured, unstructured, and image files.
- transformation_details_storage_config¶
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).
- cloud_storage_output¶
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
This field is a member of oneof
output.- Type
- file_types_to_transform¶
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.
- Type
MutableSequence[google.cloud.dlp_v2.types.FileType]
- class JobNotificationEmails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts.
- class PublishFindingsToCloudDataCatalog(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePublish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the
roles/datacatalog.tagTemplateOwnerpermission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. [InfoType naming patterns][google.privacy.dlp.v2.InfoType] are strictly enforced when using this feature.Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see Service Specific Terms.
Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect
- class PublishSummaryToCscc(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePublish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish the count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect
- class PublishToPubSub(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePublish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field,
DlpJobName, which is equal to the finished job’s`DlpJob.name<https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob>`__. Compatible with: Inspect, Risk
- class PublishToStackdriver(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEnable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as ‘Custom’ under the Stackdriver label ‘info_type’.
- class SaveFindings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIf set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk
- output_config¶
Location to store findings outside of DLP.
- class google.cloud.dlp_v2.types.ActivateJobTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ActivateJobTrigger.
- class google.cloud.dlp_v2.types.AnalyzeDataSourceRiskDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult of a risk analysis operation request.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- requested_privacy_metric¶
Privacy metric to compute.
- requested_source_table¶
Input dataset to compute metrics over.
- requested_options¶
The configuration used for this job.
- class CategoricalStatsResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult of the categorical stats computation.
- value_frequency_histogram_buckets¶
Histogram of value frequencies in the column.
- class CategoricalStatsHistogramBucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHistogram of value frequencies in the column.
- value_frequency_lower_bound¶
Lower bound on the value frequency of the values in this bucket.
- Type
- value_frequency_upper_bound¶
Upper bound on the value frequency of the values in this bucket.
- Type
- bucket_values¶
Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20.
- Type
MutableSequence[google.cloud.dlp_v2.types.ValueFrequency]
- class DeltaPresenceEstimationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult of the δ-presence computation. Note that these results are an estimation, not exact values.
- delta_presence_estimation_histogram¶
The intervals [min_probability, max_probability) do not overlap. If a value doesn’t correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4.
- class DeltaPresenceEstimationHistogramBucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which δ is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset.
- bucket_values¶
Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.
- class DeltaPresenceEstimationQuasiIdValues(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA tuple of values for the quasi-identifier columns.
- quasi_ids_values¶
The quasi-identifier values.
- Type
MutableSequence[google.cloud.dlp_v2.types.Value]
- estimated_probability¶
The estimated probability that a given individual sharing these quasi-identifier values is in the dataset. This value, typically called δ, is the ratio between the number of records in the dataset with these quasi-identifier values, and the total number of individuals (inside and outside the dataset) with these quasi-identifier values. For example, if there are 15 individuals in the dataset who share the same quasi-identifier values, and an estimated 100 people in the entire population with these values, then δ is 0.15.
- Type
- class KAnonymityResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult of the k-anonymity computation.
- equivalence_class_histogram_buckets¶
Histogram of k-anonymity equivalence classes.
- class KAnonymityEquivalenceClass(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe set of columns’ values that share the same ldiversity value
- quasi_ids_values¶
Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message. The order is always the same as the original request.
- Type
MutableSequence[google.cloud.dlp_v2.types.Value]
- class KAnonymityHistogramBucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHistogram of k-anonymity equivalence classes.
- equivalence_class_size_lower_bound¶
Lower bound on the size of the equivalence classes in this bucket.
- Type
- equivalence_class_size_upper_bound¶
Upper bound on the size of the equivalence classes in this bucket.
- Type
- bucket_values¶
Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.
- class KMapEstimationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult of the reidentifiability analysis. Note that these results are an estimation, not exact values.
- k_map_estimation_histogram¶
The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn’t correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10.
- class KMapEstimationHistogramBucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records.
- bucket_values¶
Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.
- class KMapEstimationQuasiIdValues(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA tuple of values for the quasi-identifier columns.
- quasi_ids_values¶
The quasi-identifier values.
- Type
MutableSequence[google.cloud.dlp_v2.types.Value]
- class LDiversityResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult of the l-diversity computation.
- sensitive_value_frequency_histogram_buckets¶
Histogram of l-diversity equivalence class sensitive value frequencies.
- class LDiversityEquivalenceClass(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe set of columns’ values that share the same ldiversity value.
- quasi_ids_values¶
Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request.
- Type
MutableSequence[google.cloud.dlp_v2.types.Value]
- num_distinct_sensitive_values¶
Number of distinct sensitive values in this equivalence class.
- Type
- top_sensitive_values¶
Estimated frequencies of top sensitive values.
- Type
MutableSequence[google.cloud.dlp_v2.types.ValueFrequency]
- class LDiversityHistogramBucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHistogram of l-diversity equivalence class sensitive value frequencies.
- sensitive_value_frequency_lower_bound¶
Lower bound on the sensitive value frequencies of the equivalence classes in this bucket.
- Type
- sensitive_value_frequency_upper_bound¶
Upper bound on the sensitive value frequencies of the equivalence classes in this bucket.
- Type
- bucket_values¶
Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.
- class NumericalStatsResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult of the numerical stats computation.
- min_value¶
Minimum value appearing in the column.
- max_value¶
Maximum value appearing in the column.
- quantile_values¶
List of 99 values that partition the set of field values into 100 equal sized buckets.
- Type
MutableSequence[google.cloud.dlp_v2.types.Value]
- class RequestedRiskAnalysisOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRisk analysis options.
- job_config¶
The job config for the risk job.
- class google.cloud.dlp_v2.types.BigQueryField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage defining a field of a BigQuery table.
- table¶
Source table of the field.
- field¶
Designated field in the BigQuery table.
- class google.cloud.dlp_v2.types.BigQueryKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRow key for identifying a record in BigQuery table.
- table_reference¶
Complete BigQuery table reference.
- class google.cloud.dlp_v2.types.BigQueryOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions defining BigQuery table and row identifiers.
- table_reference¶
Complete BigQuery table reference.
- identifying_fields¶
Table fields that may uniquely identify a row within the table. When
actions.saveFindings.outputConfig.tableis specified, the values of columns specified here are available in the output table underlocation.content_locations.record_location.record_key.id_values. Nested fields such asperson.birthdate.yearare allowed.- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- rows_limit¶
Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.
- Type
- rows_limit_percent¶
Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.
- Type
- sample_method¶
- excluded_fields¶
References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- included_fields¶
Limit scanning only to these fields.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- class SampleMethod(value)[source]¶
Bases:
proto.enums.EnumHow to sample rows if not all rows are scanned. Meaningful only when used in conjunction with either rows_limit or rows_limit_percent. If not specified, rows are scanned in the order BigQuery reads them.
- Values:
- SAMPLE_METHOD_UNSPECIFIED (0):
No description available.
- TOP (1):
Scan groups of rows in the order BigQuery provides (default). Multiple groups of rows may be scanned in parallel, so results may not appear in the same order the rows are read.
- RANDOM_START (2):
Randomly pick groups of rows to scan.
- class google.cloud.dlp_v2.types.BigQueryTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of:
<project_id>:<dataset_id>.<table_id>or<project_id>.<dataset_id>.<table_id>.- project_id¶
The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.
- Type
- class google.cloud.dlp_v2.types.BoundingBox(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBounding box encompassing detected text within an image.
- class google.cloud.dlp_v2.types.BucketingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGeneralization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be used on data of type: number, long, string, timestamp. If the bound
Valuetype differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.- buckets¶
Set of buckets. Ranges must be non-overlapping.
- Type
MutableSequence[google.cloud.dlp_v2.types.BucketingConfig.Bucket]
- class Bucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBucket is represented as a range, along with replacement values.
- min_¶
Lower bound of the range, inclusive. Type should be the same as max if used.
- max_¶
Upper bound of the range, exclusive; type must match min.
- replacement_value¶
Required. Replacement value for this bucket.
- class google.cloud.dlp_v2.types.ByteContentItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContainer for bytes to inspect or redact.
- type_¶
The type of data stored in the bytes string. Default will be TEXT_UTF8.
- class BytesType(value)[source]¶
Bases:
proto.enums.EnumThe type of data being sent for inspection. To learn more, see Supported file types.
- Values:
- BYTES_TYPE_UNSPECIFIED (0):
Unused
- IMAGE (6):
Any image type.
- IMAGE_JPEG (1):
jpeg
- IMAGE_BMP (2):
bmp
- IMAGE_PNG (3):
png
- IMAGE_SVG (4):
svg
- TEXT_UTF8 (5):
plain text
- WORD_DOCUMENT (7):
docx, docm, dotx, dotm
- PDF (8):
pdf
- POWERPOINT_DOCUMENT (9):
pptx, pptm, potx, potm, pot
- EXCEL_DOCUMENT (10):
xlsx, xlsm, xltx, xltm
- AVRO (11):
avro
- CSV (12):
csv
- TSV (13):
tsv
- class google.cloud.dlp_v2.types.CancelDlpJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for canceling a DLP job.
- class google.cloud.dlp_v2.types.CharacterMaskConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePartially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string. This can be used on data of any type (numbers, longs, and so on) and when de-identifying structured data we’ll attempt to preserve the original data’s type. (This allows you to take a long like 123 and modify it to a string like **3.
- masking_character¶
Character to use to mask the sensitive values—for example,
*for an alphabetic string such as a name, or0for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to*for strings, and0for digits.- Type
- number_to_mask¶
Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.
If
number_to_maskis negative, this denotes inverse masking. Cloud DLP masks all but a number of characters. For example, suppose you have the following values:masking_characteris*number_to_maskis-4reverse_orderisfalseCharsToIgnoreincludes-Input string is
1234-5678-9012-3456
The resulting de-identified string is
****-****-****-3456. Cloud DLP masks all but the last four characters. Ifreverse_orderistrue, all but the first four characters are masked as1234-****-****-****.- Type
- reverse_order¶
Mask characters in reverse order. For example, if
masking_characteris0,number_to_maskis14, andreverse_orderisfalse, then the input string1234-5678-9012-3456is masked as00000000000000-3456. Ifmasking_characteris*,number_to_maskis3, andreverse_orderistrue, then the string12345is masked as12***.- Type
- characters_to_ignore¶
When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is
555-555-5555and you instruct Cloud DLP to skip-and mask 5 characters with*, Cloud DLP returns***-**5-5555.- Type
MutableSequence[google.cloud.dlp_v2.types.CharsToIgnore]
- class google.cloud.dlp_v2.types.CharsToIgnore(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCharacters to skip when doing deidentification of a value. These will be left alone and skipped.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- characters_to_skip¶
Characters to not transform when masking.
This field is a member of oneof
characters.- Type
- common_characters_to_ignore¶
Common characters to not transform when masking. Useful to avoid removing punctuation.
This field is a member of oneof
characters.
- class CommonCharsToIgnore(value)[source]¶
Bases:
proto.enums.EnumConvenience enum for indicating common characters to not transform.
- Values:
- COMMON_CHARS_TO_IGNORE_UNSPECIFIED (0):
Unused.
- NUMERIC (1):
0-9
- ALPHA_UPPER_CASE (2):
A-Z
- ALPHA_LOWER_CASE (3):
a-z
- PUNCTUATION (4):
US Punctuation, one of !”#$%&’()*+,-./:;<=>?@[]^_`{|}~
- WHITESPACE (5):
Whitespace character, one of [ \tnx0Bfr]
- class google.cloud.dlp_v2.types.CloudStorageFileSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage representing a set of files in Cloud Storage.
- class google.cloud.dlp_v2.types.CloudStorageOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions defining a file or a set of files within a Cloud Storage bucket.
- file_set¶
The set of one or more files to scan.
- bytes_limit_per_file¶
Max number of bytes to scan from a file. If a scanned file’s size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. Cannot be set if de-identification is requested.
- Type
- bytes_limit_per_file_percent¶
Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. Cannot be set if de-identification is requested.
- Type
- file_types¶
List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to ‘global’, ‘us’, ‘asia’, and ‘europe’.
- Type
MutableSequence[google.cloud.dlp_v2.types.FileType]
- sample_method¶
- files_limit_percent¶
Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.
- Type
- class FileSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSet of files to scan.
- url¶
The Cloud Storage url of the file(s) to scan, in the format
gs://<bucket>/<path>. Trailing wildcard in the path is allowed.If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that
gs://mybucket/is equivalent togs://mybucket/*, andgs://mybucket/directory/is equivalent togs://mybucket/directory/*.Exactly one of
urlorregex_file_setmust be set.- Type
- regex_file_set¶
The regex-filtered set of files to scan. Exactly one of
urlorregex_file_setmust be set.
- class SampleMethod(value)[source]¶
Bases:
proto.enums.EnumHow to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytes_limit_per_file. If not specified, scanning would start from the top.
- Values:
- SAMPLE_METHOD_UNSPECIFIED (0):
No description available.
- TOP (1):
Scan from the top (default).
- RANDOM_START (2):
For each file larger than bytes_limit_per_file, randomly pick the offset to start scanning. The scanned bytes are contiguous.
- class google.cloud.dlp_v2.types.CloudStoragePath(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage representing a single file or path in Cloud Storage.
- class google.cloud.dlp_v2.types.CloudStorageRegexFileSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include.
Included files are those that match at least one item in
include_regexand do not match any items inexclude_regex. Note that a file that matches items from both lists will not be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression.For example, given the input
{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}:gs://mybucket/directory1/myfilewill be includedgs://mybucket/directory1/directory2/myfilewill be included (.*matches across/)gs://mybucket/directory0/directory1/myfilewill not be included (the full path doesn’t match any items ininclude_regex)gs://mybucket/directory1/excludedfilewill not be included (the path matches an item inexclude_regex)
If
include_regexis left empty, it will match all files by default (this is equivalent to settinginclude_regex: [".*"]).Some other common use cases:
{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}will include all files inmybucketexcept for .pdf files{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}will include all files directly undergs://mybucket/directory/, without matching across/
- include_regex¶
A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in
exclude_regex. Leaving this field empty will match all files by default (this is equivalent to including.*in the list).Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub.
- Type
MutableSequence[str]
- exclude_regex¶
A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan.
Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub.
- Type
MutableSequence[str]
- class google.cloud.dlp_v2.types.Color(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a color in the RGB color space.
- class google.cloud.dlp_v2.types.Container(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a container that may contain DLP findings. Examples of a container include a file, table, or database record.
- project_id¶
Project where the finding was found. Can be different from the project that owns the finding.
- Type
- full_path¶
A string representation of the full container name. Examples:
BigQuery: ‘Project:DataSetId.TableId’
Cloud Storage: ‘gs://Bucket/folders/filename.txt’
- Type
- root_path¶
The root of the container. Examples:
For BigQuery table
project_id:dataset_id.table_id, the root isdataset_idFor Cloud Storage file
gs://bucket/folder/filename.txt, the root isgs://bucket
- Type
- relative_path¶
The rest of the path after the root. Examples:
For BigQuery table
project_id:dataset_id.table_id, the relative path istable_idFor Cloud Storage file
gs://bucket/folder/filename.txt, the relative path isfolder/filename.txt
- Type
- update_time¶
Findings container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn’t populated.
- class google.cloud.dlp_v2.types.ContentItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- table¶
Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more.
This field is a member of oneof
data_item.
- class google.cloud.dlp_v2.types.ContentLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePrecise location of the finding within a document, record, image, or metadata container.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- container_name¶
Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows:
BigQuery tables:
{project_id}:{dataset_id}.{table_id}Cloud Storage files:
gs://{bucket}/{path}Datastore namespace: {namespace}
Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).
- Type
- record_location¶
Location within a row or record of a database table.
This field is a member of oneof
location.
- metadata_location¶
Location within the metadata for inspected content.
This field is a member of oneof
location.
- container_timestamp¶
Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn’t populated.
- class google.cloud.dlp_v2.types.ContentOption(value)[source]¶
Bases:
proto.enums.EnumDeprecated and unused.
- Values:
- CONTENT_UNSPECIFIED (0):
Includes entire content of a file or a data stream.
- CONTENT_TEXT (1):
Text content within the data, excluding any metadata.
- CONTENT_IMAGE (2):
Images found in the data.
- class google.cloud.dlp_v2.types.CreateDeidentifyTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateDeidentifyTemplate.
- parent¶
Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_IDOrganizations scope, location specified:
organizations/ORG_ID/locations/LOCATION_IDOrganizations scope, no location specified (defaults to global):
organizations/ORG_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- deidentify_template¶
Required. The DeidentifyTemplate to create.
- template_id¶
The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression:
[a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.- Type
- class google.cloud.dlp_v2.types.CreateDlpJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- parent¶
Required. Parent resource name.
The format of this value varies depending on whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- inspect_job¶
An inspection job scans a storage repository for InfoTypes.
This field is a member of oneof
job.
- risk_job¶
A risk analysis job calculates re-identification risk metrics for a BigQuery table.
This field is a member of oneof
job.
- job_id¶
The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression:
[a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.- Type
- class google.cloud.dlp_v2.types.CreateInspectTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateInspectTemplate.
- parent¶
Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_IDOrganizations scope, location specified:
organizations/ORG_ID/locations/LOCATION_IDOrganizations scope, no location specified (defaults to global):
organizations/ORG_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- inspect_template¶
Required. The InspectTemplate to create.
- template_id¶
The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression:
[a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.- Type
- class google.cloud.dlp_v2.types.CreateJobTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateJobTrigger.
- parent¶
Required. Parent resource name.
The format of this value varies depending on whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- job_trigger¶
Required. The JobTrigger to create.
- trigger_id¶
The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression:
[a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.- Type
- class google.cloud.dlp_v2.types.CreateStoredInfoTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateStoredInfoType.
- parent¶
Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_IDOrganizations scope, location specified:
organizations/ORG_ID/locations/LOCATION_IDOrganizations scope, no location specified (defaults to global):
organizations/ORG_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- config¶
Required. Configuration of the storedInfoType to create.
- stored_info_type_id¶
The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression:
[a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.- Type
- class google.cloud.dlp_v2.types.CryptoDeterministicConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297.
- crypto_key¶
The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use.
- surrogate_info_type¶
The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate}
For example, if the name of custom info type is ‘MY_TOKEN_INFO_TYPE’ and the surrogate is ‘abc’, the full replacement value will be: ‘MY_TOKEN_INFO_TYPE(3):abc’
This annotation identifies the surrogate when inspecting content using the custom info type ‘Surrogate’. This facilitates reversal of the surrogate when it occurs in free text.
Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text.
In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either
reverse a surrogate that does not correspond to an actual identifier
be unable to parse the surrogate and result in an error
Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE.
- context¶
A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well.
If the context is not set, plaintext would be used as is for encryption. If the context is set but:
there is no record present when transforming a given value or
the field is not present when transforming a given value,
plaintext would be used as is for encryption.
Note that case (1) is expected when an
InfoTypeTransformationis applied to both structured and unstructuredContentItems.
- class google.cloud.dlp_v2.types.CryptoHashConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/dlp/docs/pseudonymization to learn more.
- crypto_key¶
The key used by the hash function.
- class google.cloud.dlp_v2.types.CryptoKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.dlp_v2.types.CryptoReplaceFfxFpeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReplaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the
ReidentifyContentAPI method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more.Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- crypto_key¶
Required. The key used by the encryption algorithm.
- context¶
The ‘tweak’, a context may be used for higher security since the same identifier in two different contexts won’t be given the same surrogate. If the context is not set, a default tweak will be used.
If the context is set but:
there is no record present when transforming a given value or
the field is not present when transforming a given value,
a default tweak will be used.
Note that case (1) is expected when an
InfoTypeTransformationis applied to both structured and unstructuredContentItems. Currently, the referenced field may be of value type integer or string.The tweak is constructed as a sequence of bytes in big endian byte order such that:
a 64 bit integer is encoded followed by a single byte of value 1
a string is encoded in UTF-8 format followed by a single byte of value 2
- custom_alphabet¶
This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|:;”’<,>.?/
This field is a member of oneof
alphabet.- Type
- radix¶
The native way to select the alphabet. Must be in the range [2, 95].
This field is a member of oneof
alphabet.- Type
- surrogate_info_type¶
The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate
For example, if the name of custom infoType is ‘MY_TOKEN_INFO_TYPE’ and the surrogate is ‘abc’, the full replacement value will be: ‘MY_TOKEN_INFO_TYPE(3):abc’
This annotation identifies the surrogate when inspecting content using the custom infoType
`SurrogateType<https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype>`__. This facilitates reversal of the surrogate when it occurs in free text.In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE
- class FfxCommonNativeAlphabet(value)[source]¶
Bases:
proto.enums.EnumThese are commonly used subsets of the alphabet that the FFX mode natively supports. In the algorithm, the alphabet is selected using the “radix”. Therefore each corresponds to a particular radix.
- Values:
- FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED (0):
Unused.
- NUMERIC (1):
[0-9](radix of 10)- HEXADECIMAL (2):
[0-9A-F](radix of 16)- UPPER_CASE_ALPHA_NUMERIC (3):
[0-9A-Z](radix of 36)- ALPHA_NUMERIC (4):
[0-9A-Za-z](radix of 62)
- class google.cloud.dlp_v2.types.CustomInfoType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCustom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- info_type¶
CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in
InspectContent.info_typesfield. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified inInspectContent.info_typeslist then the name is treated as a custom info type.
- likelihood¶
Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to
VERY_LIKELYif not specified.
- surrogate_type¶
Message for detecting output from deidentification transformations that support reversing.
This field is a member of oneof
type.
- stored_type¶
Load an existing
StoredInfoTyperesource for use inInspectDataSource. Not currently supported inInspectContent.This field is a member of oneof
type.
- detection_rules¶
Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the
surrogate_typeCustomInfoType.- Type
MutableSequence[google.cloud.dlp_v2.types.CustomInfoType.DetectionRule]
- exclusion_type¶
If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.
- class DetectionRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeprecated; use
InspectionRuleSetinstead. Rule for modifying aCustomInfoTypeto alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for thesurrogate_typecustom infoType.- class HotwordRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe rule that adjusts the likelihood of findings within a certain proximity of hotwords.
- hotword_regex¶
Regular expression pattern defining what qualifies as a hotword.
- proximity¶
Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex “(d{3}) \d{3}-d{4}” if the area code is known to be the area code of a company’s office. In this case, use the hotword regex “(xxx)”, where “xxx” is the area code in question.
For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
- likelihood_adjustment¶
Likelihood adjustment to apply to all matching findings.
- class LikelihoodAdjustment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage for specifying an adjustment to the likelihood of a finding as part of a detection rule.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- fixed_likelihood¶
Set the likelihood of a finding to a fixed value.
This field is a member of oneof
adjustment.
- relative_likelihood¶
Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be
POSSIBLEwithout the detection rule andrelative_likelihoodis 1, then it is upgraded toLIKELY, while a value of -1 would downgrade it toUNLIKELY. Likelihood may never drop belowVERY_UNLIKELYor exceedVERY_LIKELY, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood isVERY_LIKELYwill result in a final likelihood ofLIKELY.This field is a member of oneof
adjustment.- Type
- class Proximity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage for specifying a window around a finding to apply a detection rule.
- window_before¶
Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
- Type
- class Dictionary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCustom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles.
Dictionary words are case-insensitive and all characters other than letters and digits in the unicode Basic Multilingual Plane will be replaced with whitespace when scanning for matches, so the dictionary phrase “Sam Johnson” will match all three phrases “sam johnson”, “Sam, Johnson”, and “Sam (Johnson)”. Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word “jen” will match the first three letters of the text “jen123” but will return no matches for “jennifer”.
Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The limits page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using
LargeCustomDictionaryConfigin theStoredInfoTypeAPI.This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- cloud_storage_path¶
Newline-delimited file of words in Cloud Storage. Only a single file is accepted.
This field is a member of oneof
source.
- class WordList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage defining a list of words or phrases to search for in the data.
- class ExclusionType(value)[source]¶
Bases:
proto.enums.Enum- Values:
- EXCLUSION_TYPE_UNSPECIFIED (0):
A finding of this custom info type will not be excluded from results.
- EXCLUSION_TYPE_EXCLUDE (1):
A finding of this custom info type will be excluded from final results, but can still affect rule execution.
- class Regex(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage defining a custom regular expression.
- pattern¶
Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.
- Type
- class SurrogateType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage for detecting output from deidentification transformations such as
`CryptoReplaceFfxFpeConfig<https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig>`__. These types of transformations are those that perform pseudonymization, thereby producing a “surrogate” as output. This should be used in conjunction with a field on the transformation such assurrogate_info_type. This CustomInfoType does not support the use ofdetection_rules.
- class google.cloud.dlp_v2.types.DataProfileAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA task to execute when a data profile has been generated.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- pub_sub_notification¶
Publish a message into the Pub/Sub topic.
This field is a member of oneof
action.
- class EventType(value)[source]¶
Bases:
proto.enums.EnumTypes of event that can trigger an action.
- Values:
- EVENT_TYPE_UNSPECIFIED (0):
Unused.
- NEW_PROFILE (1):
New profile (not a re-profile).
- CHANGED_PROFILE (2):
Changed one of the following profile metrics:
Table data risk score
Table sensitivity score
Table resource visibility
Table encryption type
Table predicted infoTypes
Table other infoTypes
- SCORE_INCREASED (3):
Table data risk score or sensitivity score increased.
- ERROR_CHANGED (4):
A user (non-internal) error occurred.
- class Export(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIf set, the detailed data profiles will be persisted to the location of your choice whenever updated.
- profile_table¶
Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in a new row in BigQuery.
- class PubSubNotification(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSend a Pub/Sub message into the given Pub/Sub topic to connect other systems to data profile generation. The message payload data will be the byte serialization of
DataProfilePubSubMessage.- topic¶
Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}.
- Type
- event¶
The type of event that triggers a Pub/Sub. At most one
PubSubNotificationper EventType is permitted.
- pubsub_condition¶
Conditions (e.g., data risk or sensitivity level) for triggering a Pub/Sub.
- detail_of_message¶
How much data to include in the Pub/Sub message. If the user wishes to limit the size of the message, they can use resource_name and fetch the profile fields they wish to. Per table profile (not per column).
- class DetailLevel(value)[source]¶
Bases:
proto.enums.EnumThe levels of detail that can be included in the Pub/Sub message.
- Values:
- DETAIL_LEVEL_UNSPECIFIED (0):
Unused.
- TABLE_PROFILE (1):
The full table data profile.
- RESOURCE_NAME (2):
The resource name of the table.
- class google.cloud.dlp_v2.types.DataProfileConfigSnapshot(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSnapshot of the configurations used to generate the profile.
- inspect_config¶
A copy of the inspection config used to generate this profile. This is a copy of the inspect_template specified in
DataProfileJobConfig.
- data_profile_job¶
A copy of the configuration used to generate this profile.
- class google.cloud.dlp_v2.types.DataProfileJobConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project.
The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/dlp/docs/data-profiles#retention).
- location¶
The data to scan.
- project_id¶
The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.
- Type
- inspect_templates¶
Detection logic for profile generation.
Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling.
Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including “global”). Each region is scanned using the applicable template. If no region-specific template is specified, but a “global” template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region’s data will not be scanned.
For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.
- Type
MutableSequence[str]
- data_profile_actions¶
Actions to execute at the completion of the job.
- Type
MutableSequence[google.cloud.dlp_v2.types.DataProfileAction]
- class google.cloud.dlp_v2.types.DataProfileLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe data that will be profiled.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.dlp_v2.types.DataProfilePubSubCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA condition for determining whether a Pub/Sub should be triggered.
- expressions¶
An expression.
- class ProfileScoreBucket(value)[source]¶
Bases:
proto.enums.EnumVarious score levels for resources.
- Values:
- PROFILE_SCORE_BUCKET_UNSPECIFIED (0):
Unused.
- HIGH (1):
High risk/sensitivity detected.
- MEDIUM_OR_HIGH (2):
Medium or high risk/sensitivity detected.
- class PubSubCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA condition consisting of a value.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- minimum_risk_score¶
The minimum data risk score that triggers the condition.
This field is a member of oneof
value.
- class PubSubExpressions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn expression, consisting of an operator and conditions.
- logical_operator¶
The operator to apply to the collection of conditions.
- conditions¶
Conditions to apply to the expression.
- Type
MutableSequence[google.cloud.dlp_v2.types.DataProfilePubSubCondition.PubSubCondition]
- class PubSubLogicalOperator(value)[source]¶
Bases:
proto.enums.EnumLogical operators for conditional checks.
- Values:
- LOGICAL_OPERATOR_UNSPECIFIED (0):
Unused.
- OR (1):
Conditional OR.
- AND (2):
Conditional AND.
- class google.cloud.dlp_v2.types.DataProfilePubSubMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePub/Sub topic message for a DataProfileAction.PubSubNotification event. To receive a message of protocol buffer schema type, convert the message data to an object of this proto class.
- profile¶
If
DetailLevelisTABLE_PROFILEthis will be fully populated. Otherwise, ifDetailLevelisRESOURCE_NAME, then onlynameandfull_resourcewill be populated.
- event¶
The event that caused the Pub/Sub message to be sent.
- class google.cloud.dlp_v2.types.DataRiskLevel(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageScore is a summary of all elements in the data profile. A higher number means more risk.
- score¶
The score applied to the resource.
- class DataRiskLevelScore(value)[source]¶
Bases:
proto.enums.EnumVarious score levels for resources.
- Values:
- RISK_SCORE_UNSPECIFIED (0):
Unused.
- RISK_LOW (10):
Low risk - Lower indication of sensitive data that appears to have additional access restrictions in place or no indication of sensitive data found.
- RISK_MODERATE (20):
Medium risk - Sensitive data may be present but additional access or fine grain access restrictions appear to be present. Consider limiting access even further or transform data to mask.
- RISK_HIGH (30):
High risk – SPII may be present. Access controls may include public ACLs. Exfiltration of data may lead to user data loss. Re-identification of users may be possible. Consider limiting usage and or removing SPII.
- class google.cloud.dlp_v2.types.DatastoreKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRecord key for a finding in Cloud Datastore.
- entity_key¶
Datastore entity key.
- class google.cloud.dlp_v2.types.DatastoreOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions defining a data set within Google Cloud Datastore.
- partition_id¶
A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.
- kind¶
The kind to process.
- class google.cloud.dlp_v2.types.DateShiftConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageShifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting to learn more.
- upper_bound_days¶
Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction.
For example, 3 means shift date to at most 3 days into the future.
- Type
- lower_bound_days¶
Required. For example, -5 means shift date to at most 5 days back in the past.
- Type
- context¶
Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context.
- class google.cloud.dlp_v2.types.DateTime(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage for a date time object. e.g. 2018-01-01, 5th August.
- date¶
One or more of the following must be set. Must be a valid date or time value.
- Type
google.type.date_pb2.Date
- day_of_week¶
Day of week
- Type
google.type.dayofweek_pb2.DayOfWeek
- time¶
Time of day
- Type
google.type.timeofday_pb2.TimeOfDay
- time_zone¶
Time zone
- class TimeZone(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTime zone of the date time object.
- class google.cloud.dlp_v2.types.DeidentifyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration that controls how the data will change.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- info_type_transformations¶
Treat the dataset as free-form text and apply the same free text transformation everywhere.
This field is a member of oneof
transformation.
- record_transformations¶
Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table.
This field is a member of oneof
transformation.
- image_transformations¶
Treat the dataset as an image and redact.
This field is a member of oneof
transformation.
- transformation_error_handling¶
Mode for handling transformation errors. If left unspecified, the default mode is
TransformationErrorHandling.ThrowError.
- class google.cloud.dlp_v2.types.DeidentifyContentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to de-identify a ContentItem.
- parent¶
Parent resource name.
The format of this value varies depending on whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- deidentify_config¶
Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument.
- inspect_config¶
Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument.
- item¶
The item to de-identify. Will be treated as text.
This value must be of type [Table][google.privacy.dlp.v2.Table] if your [deidentify_config][google.privacy.dlp.v2.DeidentifyContentRequest.deidentify_config] is a [RecordTransformations][google.privacy.dlp.v2.RecordTransformations] object.
- inspect_template_name¶
Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- Type
- deidentify_template_name¶
Template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- Type
- class google.cloud.dlp_v2.types.DeidentifyContentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResults of de-identifying a ContentItem.
- item¶
The de-identified item.
- overview¶
An overview of the changes that were made on the
item.
- class google.cloud.dlp_v2.types.DeidentifyTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.
- name¶
Output only. The template name.
The template will have one of the following formats:
projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_IDORorganizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID- Type
- create_time¶
Output only. The creation timestamp of an inspectTemplate.
- update_time¶
Output only. The last update timestamp of an inspectTemplate.
- deidentify_config¶
The core content of the template.
- class google.cloud.dlp_v2.types.DeleteDeidentifyTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteDeidentifyTemplate.
- class google.cloud.dlp_v2.types.DeleteDlpJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for deleting a DLP job.
- class google.cloud.dlp_v2.types.DeleteInspectTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteInspectTemplate.
- class google.cloud.dlp_v2.types.DeleteJobTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteJobTrigger.
- class google.cloud.dlp_v2.types.DeleteStoredInfoTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteStoredInfoType.
- class google.cloud.dlp_v2.types.DlpJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCombines all of the information about a DLP job.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- type_¶
The type of job.
- state¶
State of a job.
- risk_details¶
Results from analyzing risk of a data source.
This field is a member of oneof
details.
- create_time¶
Time when the job was created.
- start_time¶
Time when the job started.
- end_time¶
Time when the job finished.
- job_trigger_name¶
If created by a job trigger, the resource name of the trigger that instantiated the job.
- Type
- errors¶
A stream of errors encountered running the job.
- Type
MutableSequence[google.cloud.dlp_v2.types.Error]
- class JobState(value)[source]¶
Bases:
proto.enums.EnumPossible states of a job. New items may be added.
- Values:
- JOB_STATE_UNSPECIFIED (0):
Unused.
- PENDING (1):
The job has not yet started.
- RUNNING (2):
The job is currently running. Once a job has finished it will transition to FAILED or DONE.
- DONE (3):
The job is no longer running.
- CANCELED (4):
The job was canceled before it could be completed.
- FAILED (5):
The job had an error and did not complete.
- ACTIVE (6):
The job is currently accepting findings via hybridInspect. A hybrid job in ACTIVE state may continue to have findings added to it through the calling of hybridInspect. After the job has finished no more calls to hybridInspect may be made. ACTIVE jobs can transition to DONE.
- class google.cloud.dlp_v2.types.DlpJobType(value)[source]¶
Bases:
proto.enums.EnumAn enum to represent the various types of DLP jobs.
- Values:
- DLP_JOB_TYPE_UNSPECIFIED (0):
Defaults to INSPECT_JOB.
- INSPECT_JOB (1):
The job inspected Google Cloud for sensitive data.
- RISK_ANALYSIS_JOB (2):
The job executed a Risk Analysis computation.
- class google.cloud.dlp_v2.types.DocumentLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLocation of a finding within a document.
- class google.cloud.dlp_v2.types.EncryptionStatus(value)[source]¶
Bases:
proto.enums.EnumHow a resource is encrypted.
- Values:
- ENCRYPTION_STATUS_UNSPECIFIED (0):
Unused.
- ENCRYPTION_GOOGLE_MANAGED (1):
Google manages server-side encryption keys on your behalf.
- ENCRYPTION_CUSTOMER_MANAGED (2):
Customer provides the key.
- class google.cloud.dlp_v2.types.EntityId(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the
EntityIdmight be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity.- field¶
Composite key indicating which field contains the entity identifier.
- class google.cloud.dlp_v2.types.Error(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
- details¶
Detailed error codes and messages.
- Type
google.rpc.status_pb2.Status
- timestamps¶
The times the error occurred.
- Type
MutableSequence[google.protobuf.timestamp_pb2.Timestamp]
- class google.cloud.dlp_v2.types.ExcludeByHotword(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if a BigQuery column matches a specific pattern.
- hotword_regex¶
Regular expression pattern defining what qualifies as a hotword.
- proximity¶
Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header.
- class google.cloud.dlp_v2.types.ExcludeInfoTypes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList of excluded infoTypes.
- info_types¶
InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for
InspectionRuleSet.info_typescontaining “PHONE_NUMBER”andexclusion_rulecontainingexclude_info_types.info_types` with “EMAIL_ADDRESS” the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to “555-222-2222@example.org” to generate only a single finding, namely email address.- Type
MutableSequence[google.cloud.dlp_v2.types.InfoType]
- class google.cloud.dlp_v2.types.ExclusionRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe rule that specifies conditions when findings of infoTypes specified in
InspectionRuleSetare removed from results.This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- exclude_info_types¶
Set of infoTypes for which findings would affect this rule.
This field is a member of oneof
type.
- exclude_by_hotword¶
Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name.
This field is a member of oneof
type.
- matching_type¶
How the rule is applied, see MatchingType documentation for details.
- class google.cloud.dlp_v2.types.FieldId(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGeneral identifier of a data field in a storage service.
- class google.cloud.dlp_v2.types.FieldTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe transformation to apply to the field.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- fields¶
Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of “contact.nums[0].type”, use “contact.nums.type”.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- condition¶
Only apply the transformation if the condition evaluates to true for the given
RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.Example Use Cases:
Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
Redact a field if the date of birth field is greater than 85.
- primitive_transformation¶
Apply the transformation to the entire field.
This field is a member of oneof
transformation.
- class google.cloud.dlp_v2.types.FileType(value)[source]¶
Bases:
proto.enums.EnumDefinitions of file type groups to scan. New types will be added to this list.
- Values:
- FILE_TYPE_UNSPECIFIED (0):
Includes all files.
- BINARY_FILE (1):
Includes all file extensions not covered by another entry. Binary scanning attempts to convert the content of the file to utf_8 to scan the file. If you wish to avoid this fall back, specify one or more of the other FileType’s in your storage scan.
- TEXT_FILE (2):
Included file extensions:
asc,asp, aspx, brf, c, cc,cfm, cgi, cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, xhtml, lhs, ics, ini, java, js, json, kix, kml, ocaml, md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, xsd, yml, yaml.
- IMAGE (3):
Included file extensions: bmp, gif, jpg, jpeg, jpe, png. bytes_limit_per_file has no effect on image files. Image inspection is restricted to ‘global’, ‘us’, ‘asia’, and ‘europe’.
- WORD (5):
Word files >30 MB will be scanned as binary files. Included file extensions:
docx, dotx, docm, dotm
- PDF (6):
PDF files >30 MB will be scanned as binary files. Included file extensions:
pdf
- AVRO (7):
Included file extensions:
avro
- CSV (8):
Included file extensions:
csv
- TSV (9):
Included file extensions:
tsv
- POWERPOINT (11):
Powerpoint files >30 MB will be scanned as binary files. Included file extensions:
pptx, pptm, potx, potm, pot
- EXCEL (12):
Excel files >30 MB will be scanned as binary files. Included file extensions:
xlsx, xlsm, xltx, xltm
- class google.cloud.dlp_v2.types.Finding(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a piece of potentially sensitive content.
- name¶
Resource name in format projects/{project}/locations/{location}/findings/{finding} Populated only when viewing persisted findings.
- Type
- quote¶
The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if
include_quoteis true and the finding is less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes in length, the quote may be omitted.- Type
- info_type¶
The type of content that might have been found. Provided if
excluded_typesis false.
- likelihood¶
Confidence of how likely it is that the
info_typeis correct.
- location¶
Where the content was found.
- create_time¶
Timestamp when finding was detected.
- quote_info¶
Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME.
- labels¶
The labels associated with this
Finding.Label keys must be between 1 and 63 characters long and must conform to the following regular expression:
[a-z]([-a-z0-9]*[a-z0-9])?.Label values must be between 0 and 63 characters long and must conform to the regular expression
([a-z]([-a-z0-9]*[a-z0-9])?)?.No more than 10 labels can be associated with a given finding.
Examples:
"environment" : "production""pipeline" : "etl"
- job_create_time¶
Time the job started that produced this finding.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.dlp_v2.types.FinishDlpJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for finishing a DLP hybrid job.
- class google.cloud.dlp_v2.types.FixedSizeBucketingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBuckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies.
The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with “10-20”.
This can be used on data of type: double, long.
If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing.
See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.
- lower_bound¶
Required. Lower bound value of buckets. All values less than
lower_boundare grouped together into a single bucket; for example iflower_bound= 10, then all values less than 10 are replaced with the value “-10”.
- upper_bound¶
Required. Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if
upper_bound= 89, then all values greater than 89 are replaced with the value “89+”.
- bucket_size¶
Required. Size of each bucket (except for minimum and maximum buckets). So if
lower_bound= 10,upper_bound= 89, andbucket_size= 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works.- Type
- class google.cloud.dlp_v2.types.GetDeidentifyTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetDeidentifyTemplate.
- class google.cloud.dlp_v2.types.GetDlpJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for [DlpJobs.GetDlpJob][].
- class google.cloud.dlp_v2.types.GetInspectTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetInspectTemplate.
- class google.cloud.dlp_v2.types.GetJobTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetJobTrigger.
- class google.cloud.dlp_v2.types.GetStoredInfoTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetStoredInfoType.
- class google.cloud.dlp_v2.types.HybridContentItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn individual hybrid item to inspect. Will be stored temporarily during processing.
- item¶
The item to inspect.
- finding_details¶
Supplementary information that will be added to each finding.
- class google.cloud.dlp_v2.types.HybridFindingDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePopulate to associate additional data with each finding.
- container_details¶
Details about the container where the content being inspected is from.
- file_offset¶
Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.
- Type
- row_offset¶
Offset of the row for tables. Populate if the row(s) being scanned are part of a bigger dataset and you want to keep track of their absolute position.
- Type
- table_options¶
If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. If not known ahead of time, can also be set within each inspect hybrid call and the two will be merged. Note that identifying_fields will only be stored to BigQuery, and only if the BigQuery action has been included.
- labels¶
Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with
Finding’s produced by hybrid inspection.Label keys must be between 1 and 63 characters long and must conform to the following regular expression:
[a-z]([-a-z0-9]*[a-z0-9])?.Label values must be between 0 and 63 characters long and must conform to the regular expression
([a-z]([-a-z0-9]*[a-z0-9])?)?.No more than 10 labels can be associated with a given finding.
Examples:
"environment" : "production""pipeline" : "etl"
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.dlp_v2.types.HybridInspectDlpJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to search for potentially sensitive info in a custom location.
- name¶
Required. Resource name of the job to execute a hybrid inspect on, for example
projects/dlp-test-project/dlpJob/53234423.- Type
- hybrid_item¶
The item to inspect.
- class google.cloud.dlp_v2.types.HybridInspectJobTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to search for potentially sensitive info in a custom location.
- name¶
Required. Resource name of the trigger to execute a hybrid inspect on, for example
projects/dlp-test-project/jobTriggers/53234423.- Type
- hybrid_item¶
The item to inspect.
- class google.cloud.dlp_v2.types.HybridInspectResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageQuota exceeded errors will be thrown once quota has been met.
- class google.cloud.dlp_v2.types.HybridInspectStatistics(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatistics related to processing hybrid inspect requests.
- aborted_count¶
The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed.
- Type
- pending_count¶
The number of hybrid requests currently being processed. Only populated when called via method
getDlpJob. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for.- Type
- class google.cloud.dlp_v2.types.HybridOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration to control jobs where the content being inspected is outside of Google Cloud Platform.
- description¶
A short description of where the data is coming from. Will be stored once in the job. 256 max length.
- Type
- required_finding_label_keys¶
These are labels that each inspection request must include within their ‘finding_labels’ map. Request may contain others, but any missing one of these will be rejected.
Label keys must be between 1 and 63 characters long and must conform to the following regular expression:
[a-z]([-a-z0-9]*[a-z0-9])?.No more than 10 keys can be required.
- Type
MutableSequence[str]
- labels¶
To organize findings, these labels will be added to each finding.
Label keys must be between 1 and 63 characters long and must conform to the following regular expression:
[a-z]([-a-z0-9]*[a-z0-9])?.Label values must be between 0 and 63 characters long and must conform to the regular expression
([a-z]([-a-z0-9]*[a-z0-9])?)?.No more than 10 labels can be associated with a given finding.
Examples:
"environment" : "production""pipeline" : "etl"
- table_options¶
If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.dlp_v2.types.ImageLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLocation of the finding within an image.
- bounding_boxes¶
Bounding boxes locating the pixels within the image containing the finding.
- Type
MutableSequence[google.cloud.dlp_v2.types.BoundingBox]
- class google.cloud.dlp_v2.types.ImageTransformations(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA type of transformation that is applied over images.
- transforms¶
- Type
MutableSequence[google.cloud.dlp_v2.types.ImageTransformations.ImageTransformation]
- class ImageTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for determining how redaction of images should occur.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- selected_info_types¶
Apply transformation to the selected info_types.
This field is a member of oneof
target.
- all_info_types¶
Apply transformation to all findings not specified in other ImageTransformation’s selected_info_types. Only one instance is allowed within the ImageTransformations message.
This field is a member of oneof
target.
- all_text¶
Apply transformation to all text that doesn’t match an infoType. Only one instance is allowed within the ImageTransformations message.
This field is a member of oneof
target.
- redaction_color¶
The color to use when redacting content from an image. If not specified, the default is black.
- class AllInfoTypes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageApply transformation to all findings.
- class AllText(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageApply to all text.
- class SelectedInfoTypes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageApply transformation to the selected info_types.
- info_types¶
Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoType]
- class google.cloud.dlp_v2.types.InfoType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageType of information detected by the API.
- name¶
Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern
[A-Za-z0-9$_-]{1,64}.- Type
- class google.cloud.dlp_v2.types.InfoTypeCategory(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageClassification of infoTypes to organize them according to geographic location, industry, and data type.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- location_category¶
The region or country that issued the ID or document represented by the infoType.
This field is a member of oneof
category.
- industry_category¶
The group of relevant businesses where this infoType is commonly used
This field is a member of oneof
category.
- type_category¶
The class of identifiers where this infoType belongs
This field is a member of oneof
category.
- class IndustryCategory(value)[source]¶
Bases:
proto.enums.EnumEnum of the current industries in the category. We might add more industries in the future.
- Values:
- INDUSTRY_UNSPECIFIED (0):
Unused industry
- FINANCE (1):
The infoType is typically used in the finance industry.
- HEALTH (2):
The infoType is typically used in the health industry.
- TELECOMMUNICATIONS (3):
The infoType is typically used in the telecommunications industry.
- class LocationCategory(value)[source]¶
Bases:
proto.enums.EnumEnum of the current locations. We might add more locations in the future.
- Values:
- LOCATION_UNSPECIFIED (0):
Unused location
- GLOBAL (1):
The infoType is not issued by or tied to a specific region, but is used almost everywhere.
- ARGENTINA (2):
The infoType is typically used in Argentina.
- AUSTRALIA (3):
The infoType is typically used in Australia.
- BELGIUM (4):
The infoType is typically used in Belgium.
- BRAZIL (5):
The infoType is typically used in Brazil.
- CANADA (6):
The infoType is typically used in Canada.
- CHILE (7):
The infoType is typically used in Chile.
- CHINA (8):
The infoType is typically used in China.
- COLOMBIA (9):
The infoType is typically used in Colombia.
- DENMARK (10):
The infoType is typically used in Denmark.
- FRANCE (11):
The infoType is typically used in France.
- FINLAND (12):
The infoType is typically used in Finland.
- GERMANY (13):
The infoType is typically used in Germany.
- HONG_KONG (14):
The infoType is typically used in Hong Kong.
- INDIA (15):
The infoType is typically used in India.
- INDONESIA (16):
The infoType is typically used in Indonesia.
- IRELAND (17):
The infoType is typically used in Ireland.
- ISRAEL (18):
The infoType is typically used in Israel.
- ITALY (19):
The infoType is typically used in Italy.
- JAPAN (20):
The infoType is typically used in Japan.
- KOREA (21):
The infoType is typically used in Korea.
- MEXICO (22):
The infoType is typically used in Mexico.
- THE_NETHERLANDS (23):
The infoType is typically used in the Netherlands.
- NORWAY (24):
The infoType is typically used in Norway.
- PARAGUAY (25):
The infoType is typically used in Paraguay.
- PERU (26):
The infoType is typically used in Peru.
- POLAND (27):
The infoType is typically used in Poland.
- PORTUGAL (28):
The infoType is typically used in Portugal.
- SINGAPORE (29):
The infoType is typically used in Singapore.
- SOUTH_AFRICA (30):
The infoType is typically used in South Africa.
- SPAIN (31):
The infoType is typically used in Spain.
- SWEDEN (32):
The infoType is typically used in Sweden.
- TAIWAN (33):
The infoType is typically used in Taiwan.
- THAILAND (34):
The infoType is typically used in Thailand.
- TURKEY (35):
The infoType is typically used in Turkey.
- UNITED_KINGDOM (36):
The infoType is typically used in the United Kingdom.
- UNITED_STATES (37):
The infoType is typically used in the United States.
- URUGUAY (38):
The infoType is typically used in Uruguay.
- VENEZUELA (39):
The infoType is typically used in Venezuela.
- INTERNAL (40):
The infoType is typically used in Google internally.
- NEW_ZEALAND (41):
The infoType is typically used in New Zealand.
- class TypeCategory(value)[source]¶
Bases:
proto.enums.EnumEnum of the current types in the category. We might add more types in the future.
- Values:
- TYPE_UNSPECIFIED (0):
Unused type
- PII (1):
Personally identifiable information, for example, a name or phone number
- SPII (2):
Personally identifiable information that is especially sensitive, for example, a passport number.
- DEMOGRAPHIC (3):
Attributes that can partially identify someone, especially in combination with other attributes, like age, height, and gender.
- CREDENTIAL (4):
Confidential or secret information, for example, a password.
- GOVERNMENT_ID (5):
An identification document issued by a government.
- DOCUMENT (6):
A document, for example, a resume or source code.
- CONTEXTUAL_INFORMATION (7):
Information that is not sensitive on its own, but provides details about the circumstances surrounding an entity or an event.
- class google.cloud.dlp_v2.types.InfoTypeDescription(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInfoType description.
- supported_by¶
Which parts of the API supports this InfoType.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoTypeSupportedBy]
- description¶
Description of the infotype. Translated when language is provided in the request.
- Type
- versions¶
A list of available versions for the infotype.
- Type
MutableSequence[google.cloud.dlp_v2.types.VersionDescription]
- categories¶
The category of the infoType.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoTypeCategory]
- class google.cloud.dlp_v2.types.InfoTypeStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatistics regarding a specific InfoType.
- info_type¶
The type of finding this stat is for.
- class google.cloud.dlp_v2.types.InfoTypeSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe infoType details for this column.
- info_type¶
The infoType.
- class google.cloud.dlp_v2.types.InfoTypeSupportedBy(value)[source]¶
Bases:
proto.enums.EnumParts of the APIs which use certain infoTypes.
- Values:
- ENUM_TYPE_UNSPECIFIED (0):
Unused.
- INSPECT (1):
Supported by the inspect operations.
- RISK_ANALYSIS (2):
Supported by the risk analysis operations.
- class google.cloud.dlp_v2.types.InfoTypeTransformations(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA type of transformation that will scan unstructured text and apply various
PrimitiveTransformations to each finding, where the transformation is applied to only values that were identified as a specific info_type.- transformations¶
Required. Transformation for each infoType. Cannot specify more than one for a given infoType.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoTypeTransformations.InfoTypeTransformation]
- class InfoTypeTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA transformation to apply to text that is identified as a specific info_type.
- info_types¶
InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in
InspectConfig.- Type
MutableSequence[google.cloud.dlp_v2.types.InfoType]
- primitive_transformation¶
Required. Primitive transformation to apply to the infoType.
- class google.cloud.dlp_v2.types.InspectConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.
- info_types¶
Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference.
When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoType]
- min_likelihood¶
Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.
- limits¶
Configuration to control the number of findings returned. This is not used for data profiling.
When redacting sensitive data from images, finding limits don’t apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don’t include finding limits in [RedactImage][google.privacy.dlp.v2.DlpService.RedactImage] requests. Otherwise, Cloud DLP returns an error.
- include_quote¶
When true, a contextual quote from the data that triggered a finding is included in the response; see [Finding.quote][google.privacy.dlp.v2.Finding.quote]. This is not used for data profiling.
- Type
- exclude_info_types¶
When true, excludes type information of the findings. This is not used for data profiling.
- Type
- custom_info_types¶
CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
- Type
MutableSequence[google.cloud.dlp_v2.types.CustomInfoType]
- content_options¶
Deprecated and unused.
- Type
MutableSequence[google.cloud.dlp_v2.types.ContentOption]
- rule_set¶
Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.
- Type
MutableSequence[google.cloud.dlp_v2.types.InspectionRuleSet]
- class FindingLimits(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration to control the number of findings returned for inspection. This is not used for de-identification or data profiling.
When redacting sensitive data from images, finding limits don’t apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don’t include finding limits in [RedactImage][google.privacy.dlp.v2.DlpService.RedactImage] requests. Otherwise, Cloud DLP returns an error.
- max_findings_per_item¶
Max number of findings that will be returned for each item scanned. When set within
InspectJobConfig, the maximum returned is 2000 regardless if this is set higher. When set withinInspectContentRequest, this field is ignored.- Type
- max_findings_per_request¶
Max number of findings that will be returned per request/job. When set within
InspectContentRequest, the maximum returned is 2000 regardless if this is set higher.- Type
- max_findings_per_info_type¶
Configuration of findings limit given for specified infoTypes.
- Type
MutableSequence[google.cloud.dlp_v2.types.InspectConfig.FindingLimits.InfoTypeLimit]
- class InfoTypeLimit(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMax findings configuration per infoType, per content item or long running DlpJob.
- info_type¶
Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.
- class google.cloud.dlp_v2.types.InspectContentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to search for potentially sensitive info in a ContentItem.
- parent¶
Parent resource name.
The format of this value varies depending on whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- inspect_config¶
Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument.
- item¶
The item to inspect.
- inspect_template_name¶
Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- Type
- class google.cloud.dlp_v2.types.InspectContentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResults of inspecting an item.
- result¶
The findings.
- class google.cloud.dlp_v2.types.InspectDataSourceDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe results of an inspect DataSource job.
- requested_options¶
The configuration used for this job.
- result¶
A summary of the outcome of this inspection job.
- class RequestedOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSnapshot of the inspection configuration.
- snapshot_inspect_template¶
If run with an InspectTemplate, a snapshot of its state at the time of this run.
- job_config¶
Inspect config.
- class Result(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAll result fields mentioned below are updated while the job is processing.
- info_type_stats¶
Statistics of how many instances of each info type were found during inspect job.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoTypeStats]
- hybrid_stats¶
Statistics related to the processing of hybrid inspect.
- class google.cloud.dlp_v2.types.InspectJobConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageControls what and how to inspect for findings.
- storage_config¶
The data to scan.
- inspect_config¶
How and what to scan for.
- inspect_template_name¶
If provided, will be used as the default for all values in InspectConfig.
inspect_configwill be merged into the values persisted as part of the template.- Type
- actions¶
Actions to execute at the completion of the job.
- Type
MutableSequence[google.cloud.dlp_v2.types.Action]
- class google.cloud.dlp_v2.types.InspectResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAll the findings for a single scanned item.
- findings¶
List of findings for an item.
- Type
MutableSequence[google.cloud.dlp_v2.types.Finding]
- findings_truncated¶
If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call. For best results, divide the input into smaller batches.
- Type
- class google.cloud.dlp_v2.types.InspectTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates to learn more.
- name¶
Output only. The template name.
The template will have one of the following formats:
projects/PROJECT_ID/inspectTemplates/TEMPLATE_IDORorganizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID;- Type
- create_time¶
Output only. The creation timestamp of an inspectTemplate.
- update_time¶
Output only. The last update timestamp of an inspectTemplate.
- inspect_config¶
The core content of the template. Configuration of the scanning process.
- class google.cloud.dlp_v2.types.InspectionRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA single inspection rule to be applied to infoTypes, specified in
InspectionRuleSet.This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.dlp_v2.types.InspectionRuleSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.
- info_types¶
List of infoTypes this rule set is applied to.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoType]
- rules¶
Set of rules to be applied to infoTypes. The rules are applied in order.
- Type
MutableSequence[google.cloud.dlp_v2.types.InspectionRule]
- class google.cloud.dlp_v2.types.JobTrigger(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.
- name¶
Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example
projects/dlp-test-project/jobTriggers/53234423.- Type
- inspect_job¶
For inspect jobs, a snapshot of the configuration.
This field is a member of oneof
job.
- triggers¶
A list of triggers which will be OR’ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
- Type
MutableSequence[google.cloud.dlp_v2.types.JobTrigger.Trigger]
- errors¶
Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.
- Type
MutableSequence[google.cloud.dlp_v2.types.Error]
- create_time¶
Output only. The creation timestamp of a triggeredJob.
- update_time¶
Output only. The last update timestamp of a triggeredJob.
- last_run_time¶
Output only. The timestamp of the last time this trigger executed.
- status¶
Required. A status for this trigger.
- class Status(value)[source]¶
Bases:
proto.enums.EnumWhether the trigger is currently active. If PAUSED or CANCELLED, no jobs will be created with this configuration. The service may automatically pause triggers experiencing frequent errors. To restart a job, set the status to HEALTHY after correcting user errors.
- Values:
- STATUS_UNSPECIFIED (0):
Unused.
- HEALTHY (1):
Trigger is healthy.
- PAUSED (2):
Trigger is temporarily paused.
- CANCELLED (3):
Trigger is cancelled and can not be resumed.
- class Trigger(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWhat event needs to occur for a new job to be started.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- schedule¶
Create a job on a repeating basis based on the elapse of time.
This field is a member of oneof
trigger.
- class google.cloud.dlp_v2.types.Key(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA unique identifier for a Datastore entity. If a key’s partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.
- partition_id¶
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- path¶
The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element’s ancestors.
A path can never be empty, and a path can have at most 100 elements.
- Type
MutableSequence[google.cloud.dlp_v2.types.Key.PathElement]
- class PathElement(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA (kind, ID/name) pair used to construct a key path.
If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- kind¶
The kind of the entity. A kind matching regex
__.*__is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be"".- Type
- class google.cloud.dlp_v2.types.KindExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of a Datastore kind.
- class google.cloud.dlp_v2.types.KmsWrappedCryptoKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInclude to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt
For more information, see [Creating a wrapped key] (https://cloud.google.com/dlp/docs/create-wrapped-key).
Note: When you use Cloud KMS for cryptographic operations, charges apply.
- class google.cloud.dlp_v2.types.LargeCustomDictionaryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for a custom dictionary created from a data source of any size up to the maximum size defined in the limits page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using
CustomInfoType.Dictionaryfor smaller dictionaries that satisfy the size requirements.This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- output_path¶
Location to store dictionary artifacts in Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used.
- cloud_storage_file_set¶
Set of files containing newline-delimited lists of dictionary phrases.
This field is a member of oneof
source.
- class google.cloud.dlp_v2.types.LargeCustomDictionaryStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSummary statistics of a custom dictionary.
- class google.cloud.dlp_v2.types.Likelihood(value)[source]¶
Bases:
proto.enums.EnumCategorization of results based on how likely they are to represent a match, based on the number of elements they contain which imply a match.
- Values:
- LIKELIHOOD_UNSPECIFIED (0):
Default value; same as POSSIBLE.
- VERY_UNLIKELY (1):
Few matching elements.
- UNLIKELY (2):
No description available.
- POSSIBLE (3):
Some matching elements.
- LIKELY (4):
No description available.
- VERY_LIKELY (5):
Many matching elements.
- class google.cloud.dlp_v2.types.ListDeidentifyTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListDeidentifyTemplates.
- parent¶
Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_IDOrganizations scope, location specified:
organizations/ORG_ID/locations/LOCATION_IDOrganizations scope, no location specified (defaults to global):
organizations/ORG_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- page_token¶
Page token to continue retrieval. Comes from previous call to
ListDeidentifyTemplates.- Type
- page_size¶
Size of the page, can be limited by the server. If zero server returns a page of max size 100.
- Type
- order_by¶
Comma separated list of fields to order by, followed by
ascordescpostfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.Example:
name asc,update_time, create_time descSupported fields are:
create_time: corresponds to the time the template was created.update_time: corresponds to the time the template was last updated.name: corresponds to the template’s name.display_name: corresponds to the template’s display name.
- Type
- class google.cloud.dlp_v2.types.ListDeidentifyTemplatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListDeidentifyTemplates.
- deidentify_templates¶
List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest.
- Type
MutableSequence[google.cloud.dlp_v2.types.DeidentifyTemplate]
- class google.cloud.dlp_v2.types.ListDlpJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for listing DLP jobs.
- parent¶
Required. Parent resource name.
The format of this value varies depending on whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- filter¶
Allows filtering.
Supported syntax:
Filter expressions are made up of one or more restrictions.
Restrictions can be combined by
ANDorORlogical operators. A sequence of restrictions implicitly usesAND.A restriction has the form of
{field} {operator} {value}.Supported fields/values for inspect jobs:
state- PENDING|RUNNING|CANCELED|FINISHED|FAILEDinspected_storage- DATASTORE|CLOUD_STORAGE|BIGQUERYtrigger_name- The name of the trigger that created the job.‘end_time` - Corresponds to the time the job finished.
‘start_time` - Corresponds to the time the job finished.
Supported fields for risk analysis jobs:
state- RUNNING|CANCELED|FINISHED|FAILED‘end_time` - Corresponds to the time the job finished.
‘start_time` - Corresponds to the time the job finished.
The operator must be
=or!=.
Examples:
inspected_storage = cloud_storage AND state = done
inspected_storage = cloud_storage OR inspected_storage = bigquery
inspected_storage = cloud_storage AND (state = done OR state = canceled)
end_time > “2017-12-12T00:00:00+00:00”
The length of this field should be no more than 500 characters.
- Type
- type_¶
The type of job. Defaults to
DlpJobType.INSPECT
- order_by¶
Comma separated list of fields to order by, followed by
ascordescpostfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.Example:
name asc, end_time asc, create_time descSupported fields are:
create_time: corresponds to the time the job was created.end_time: corresponds to the time the job ended.name: corresponds to the job’s name.state: corresponds tostate
- Type
- class google.cloud.dlp_v2.types.ListDlpJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for listing DLP jobs.
- jobs¶
A list of DlpJobs that matches the specified filter in the request.
- Type
MutableSequence[google.cloud.dlp_v2.types.DlpJob]
- class google.cloud.dlp_v2.types.ListInfoTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for the list of infoTypes.
- parent¶
The parent resource name.
The format of this value is as follows:
locations/<var>LOCATION_ID</var>
- Type
- language_code¶
BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.
- Type
- filter¶
filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
- Type
- class google.cloud.dlp_v2.types.ListInfoTypesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse to the ListInfoTypes request.
- info_types¶
Set of sensitive infoTypes.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoTypeDescription]
- class google.cloud.dlp_v2.types.ListInspectTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListInspectTemplates.
- parent¶
Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_IDOrganizations scope, location specified:
organizations/ORG_ID/locations/LOCATION_IDOrganizations scope, no location specified (defaults to global):
organizations/ORG_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- page_token¶
Page token to continue retrieval. Comes from previous call to
ListInspectTemplates.- Type
- page_size¶
Size of the page, can be limited by the server. If zero server returns a page of max size 100.
- Type
- order_by¶
Comma separated list of fields to order by, followed by
ascordescpostfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.Example:
name asc,update_time, create_time descSupported fields are:
create_time: corresponds to the time the template was created.update_time: corresponds to the time the template was last updated.name: corresponds to the template’s name.display_name: corresponds to the template’s display name.
- Type
- class google.cloud.dlp_v2.types.ListInspectTemplatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListInspectTemplates.
- inspect_templates¶
List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.
- Type
MutableSequence[google.cloud.dlp_v2.types.InspectTemplate]
- class google.cloud.dlp_v2.types.ListJobTriggersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListJobTriggers.
- parent¶
Required. Parent resource name.
The format of this value varies depending on whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- page_token¶
Page token to continue retrieval. Comes from previous call to ListJobTriggers.
order_byfield must not change for subsequent calls.- Type
- order_by¶
Comma separated list of triggeredJob fields to order by, followed by
ascordescpostfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.Example:
name asc,update_time, create_time descSupported fields are:
create_time: corresponds to the time the JobTrigger was created.update_time: corresponds to the time the JobTrigger was last updated.last_run_time: corresponds to the last time the JobTrigger ran.name: corresponds to the JobTrigger’s name.display_name: corresponds to the JobTrigger’s display name.status: corresponds to JobTrigger’s status.
- Type
- filter¶
Allows filtering.
Supported syntax:
Filter expressions are made up of one or more restrictions.
Restrictions can be combined by
ANDorORlogical operators. A sequence of restrictions implicitly usesAND.A restriction has the form of
{field} {operator} {value}.Supported fields/values for inspect triggers:
status- HEALTHY|PAUSED|CANCELLEDinspected_storage- DATASTORE|CLOUD_STORAGE|BIGQUERY‘last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored.
‘error_count’ - Number of errors that have occurred while running.
The operator must be
=or!=for status and inspected_storage.
Examples:
inspected_storage = cloud_storage AND status = HEALTHY
inspected_storage = cloud_storage OR inspected_storage = bigquery
inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
last_run_time > “2017-12-12T00:00:00+00:00”
The length of this field should be no more than 500 characters.
- Type
- type_¶
The type of jobs. Will use
DlpJobType.INSPECTif not set.
- class google.cloud.dlp_v2.types.ListJobTriggersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListJobTriggers.
- job_triggers¶
List of triggeredJobs, up to page_size in ListJobTriggersRequest.
- Type
MutableSequence[google.cloud.dlp_v2.types.JobTrigger]
- class google.cloud.dlp_v2.types.ListStoredInfoTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListStoredInfoTypes.
- parent¶
Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- page_token¶
Page token to continue retrieval. Comes from previous call to
ListStoredInfoTypes.- Type
- page_size¶
Size of the page, can be limited by the server. If zero server returns a page of max size 100.
- Type
- order_by¶
Comma separated list of fields to order by, followed by
ascordescpostfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.Example:
name asc, display_name, create_time descSupported fields are:
create_time: corresponds to the time the most recent version of the resource was created.state: corresponds to the state of the resource.name: corresponds to resource name.display_name: corresponds to info type’s display name.
- Type
- class google.cloud.dlp_v2.types.ListStoredInfoTypesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListStoredInfoTypes.
- stored_info_types¶
List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest.
- Type
MutableSequence[google.cloud.dlp_v2.types.StoredInfoType]
- class google.cloud.dlp_v2.types.Location(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies the location of the finding.
- byte_range¶
Zero-based byte offsets delimiting the finding. These are relative to the finding’s containing element. Note that when the content is not textual, this references the UTF-8 encoded textual representation of the content. Omitted if content is an image.
- codepoint_range¶
Unicode character offsets delimiting the finding. These are relative to the finding’s containing element. Provided when the content is text.
- content_locations¶
List of nested objects pointing to the precise location of the finding within the file or record.
- Type
MutableSequence[google.cloud.dlp_v2.types.ContentLocation]
- container¶
Information about the container where this finding occurred, if available.
- class google.cloud.dlp_v2.types.Manual(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageJob trigger option for hybrid jobs. Jobs must be manually created and finished.
- class google.cloud.dlp_v2.types.MatchingType(value)[source]¶
Bases:
proto.enums.EnumType of the match which can be applied to different ways of matching, like Dictionary, regular expression and intersecting with findings of another info type.
- Values:
- MATCHING_TYPE_UNSPECIFIED (0):
Invalid.
- MATCHING_TYPE_FULL_MATCH (1):
Full match.
Dictionary: join of Dictionary results matched complete finding quote
Regex: all regex matches fill a finding quote start to end
Exclude info type: completely inside affecting info types findings
- MATCHING_TYPE_PARTIAL_MATCH (2):
Partial match.
Dictionary: at least one of the tokens in the finding matches
Regex: substring of the finding matches
Exclude info type: intersects with affecting info types findings
- MATCHING_TYPE_INVERSE_MATCH (3):
Inverse match.
Dictionary: no tokens in the finding match the dictionary
Regex: finding doesn’t match the regex
Exclude info type: no intersection with affecting info types findings
- class google.cloud.dlp_v2.types.MetadataLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata Location
- type_¶
Type of metadata containing the finding.
- class google.cloud.dlp_v2.types.MetadataType(value)[source]¶
Bases:
proto.enums.EnumType of metadata containing the finding.
- Values:
- METADATATYPE_UNSPECIFIED (0):
Unused
- STORAGE_METADATA (2):
General file metadata provided by Cloud Storage.
- class google.cloud.dlp_v2.types.OtherInfoTypeSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInfotype details for other infoTypes found within a column.
- info_type¶
The other infoType.
- class google.cloud.dlp_v2.types.OutputStorageConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud repository for storing output.
- table¶
Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details.
For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the
Findingobject.For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
This field is a member of oneof
type.
- output_schema¶
Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the
Findingobject. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted.If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
- class OutputSchema(value)[source]¶
Bases:
proto.enums.EnumPredefined schemas for storing findings. Only for use with external storage.
- Values:
- OUTPUT_SCHEMA_UNSPECIFIED (0):
Unused.
- BASIC_COLUMNS (1):
Basic schema including only
info_type,quote,certainty, andtimestamp.- GCS_COLUMNS (2):
Schema tailored to findings from scanning Cloud Storage.
- DATASTORE_COLUMNS (3):
Schema tailored to findings from scanning Google Datastore.
- BIG_QUERY_COLUMNS (4):
Schema tailored to findings from scanning Google BigQuery.
- ALL_COLUMNS (5):
Schema containing all columns.
- class google.cloud.dlp_v2.types.PartitionId(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDatastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.
A partition ID contains several dimensions:
project ID and namespace ID.
- class google.cloud.dlp_v2.types.PrimitiveTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA rule for transforming a value.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- replace_with_info_type_config¶
Replace with infotype
This field is a member of oneof
transformation.
- class google.cloud.dlp_v2.types.PrivacyMetric(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePrivacy metric to compute for reidentification risk analysis.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class CategoricalStatsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCompute numerical stats over an individual column, including number of distinct values and value count distribution.
- field¶
Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data.
- class DeltaPresenceEstimationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Messageδ-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute δ-presence exactly without knowing the attack dataset, so we use a statistical model instead.
- quasi_ids¶
Required. Fields considered to be quasi-identifiers. No two fields can have the same tag.
- Type
MutableSequence[google.cloud.dlp_v2.types.QuasiId]
- region_code¶
ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.
- Type
- auxiliary_tables¶
Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table.
- Type
MutableSequence[google.cloud.dlp_v2.types.StatisticalTable]
- class KAnonymityConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Messagek-anonymity metric, used for analysis of reidentification risk.
- quasi_ids¶
Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- entity_id¶
Message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account.
Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored.
- class KMapEstimationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReidentifiability metric. This corresponds to a risk model similar to what is called “journalist risk” in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset.
- quasi_ids¶
Required. Fields considered to be quasi-identifiers. No two columns can have the same tag.
- Type
MutableSequence[google.cloud.dlp_v2.types.PrivacyMetric.KMapEstimationConfig.TaggedField]
- region_code¶
ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.
- Type
- auxiliary_tables¶
Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.
- Type
MutableSequence[google.cloud.dlp_v2.types.PrivacyMetric.KMapEstimationConfig.AuxiliaryTable]
- class AuxiliaryTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).
- table¶
Required. Auxiliary table location.
- quasi_ids¶
Required. Quasi-identifier columns.
- Type
MutableSequence[google.cloud.dlp_v2.types.PrivacyMetric.KMapEstimationConfig.AuxiliaryTable.QuasiIdField]
- relative_frequency¶
Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero.
- class QuasiIdField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.
- field¶
Identifies the column.
- class TaggedField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA column with a semantic tag attached.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- field¶
Required. Identifies the column.
- info_type¶
A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.
This field is a member of oneof
tag.
- custom_tag¶
A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).
This field is a member of oneof
tag.- Type
- class LDiversityConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Messagel-diversity metric, used for analysis of reidentification risk.
- quasi_ids¶
Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- sensitive_attribute¶
Sensitive field for computing the l-value.
- class NumericalStatsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCompute numerical stats over an individual column, including min, max, and quantiles.
- field¶
Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time.
- class google.cloud.dlp_v2.types.ProfileStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- status¶
Profiling status code and optional message
- Type
google.rpc.status_pb2.Status
- timestamp¶
Time when the profile generation status was updated
- class google.cloud.dlp_v2.types.QuasiId(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA column with a semantic tag attached.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- field¶
Required. Identifies the column.
- info_type¶
A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.
This field is a member of oneof
tag.
- custom_tag¶
A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).
This field is a member of oneof
tag.- Type
- class google.cloud.dlp_v2.types.QuoteInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage for infoType-dependent details parsed from quote.
- class google.cloud.dlp_v2.types.Range(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGeneric half-open interval [start, end)
- class google.cloud.dlp_v2.types.RecordCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA condition for determining whether a transformation should be applied to a field.
- expressions¶
An expression.
- class Condition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe field type of
valueandfielddo not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. Avalueof type:stringcan be compared against all other typesbooleancan only be compared against other booleansintegercan be compared against doubles or a string if the string value can be parsed as an integer.doublecan be compared against integers or a string if the string can be parsed as a double.Timestampcan be compared against strings in RFC 3339 date string format.TimeOfDaycan be compared against timestamps and strings in the format of ‘HH:mm:ss’.
If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false.
- field¶
Required. Field within the record this condition is evaluated against.
- operator¶
Required. Operator used to compare the field or infoType to the value.
- value¶
Value to compare against. [Mandatory, except for
EXISTStests.]
- class Conditions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA collection of conditions.
- conditions¶
A collection of conditions.
- Type
MutableSequence[google.cloud.dlp_v2.types.RecordCondition.Condition]
- class Expressions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn expression, consisting of an operator and conditions.
- logical_operator¶
The operator to apply to the result of conditions. Default and currently only supported value is
AND.
- class LogicalOperator(value)[source]¶
Bases:
proto.enums.EnumLogical operators for conditional checks.
- Values:
- LOGICAL_OPERATOR_UNSPECIFIED (0):
Unused
- AND (1):
Conditional AND
- class google.cloud.dlp_v2.types.RecordKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage for a unique key indicating a record that contains a finding.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.dlp_v2.types.RecordLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLocation of a finding within a row or record.
- record_key¶
Key of the finding.
- field_id¶
Field id of the field containing the finding.
- table_location¶
Location within a
ContentItem.Table.
- class google.cloud.dlp_v2.types.RecordSuppression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration to suppress records whose suppression conditions evaluate to true.
- condition¶
A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content.
- class google.cloud.dlp_v2.types.RecordTransformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- field_id¶
For record transformations, provide a field.
- container_timestamp¶
Findings container modification timestamp, if applicable.
- class google.cloud.dlp_v2.types.RecordTransformations(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA type of transformation that is applied over structured data such as a table.
- field_transformations¶
Transform the record by applying various field transformations.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldTransformation]
- record_suppressions¶
Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output.
- Type
MutableSequence[google.cloud.dlp_v2.types.RecordSuppression]
- class google.cloud.dlp_v2.types.RedactConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRedact a given value. For example, if used with an
InfoTypeTransformationtransforming PHONE_NUMBER, and input ‘My phone number is 206-555-0123’, the output would be ‘My phone number is ‘.
- class google.cloud.dlp_v2.types.RedactImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle.
- parent¶
Parent resource name.
The format of this value varies depending on whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- inspect_config¶
Configuration for the inspector.
- image_redaction_configs¶
The configuration for specifying what content to redact from images.
- Type
MutableSequence[google.cloud.dlp_v2.types.RedactImageRequest.ImageRedactionConfig]
- include_findings¶
Whether the response should include findings along with the redacted image.
- Type
- byte_item¶
The content must be PNG, JPEG, SVG or BMP.
- class ImageRedactionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for determining how redaction of images should occur.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- info_type¶
Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig.
This field is a member of oneof
target.
- redact_all_text¶
If true, all text found in the image, regardless whether it matches an info_type, is redacted. Only one should be provided.
This field is a member of oneof
target.- Type
- redaction_color¶
The color to use when redacting content from an image. If not specified, the default is black.
- class google.cloud.dlp_v2.types.RedactImageResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResults of redacting an image.
- extracted_text¶
If an image was being inspected and the InspectConfig’s include_quote was set to true, then this field will include all text, if any, that was found in the image.
- Type
- inspect_result¶
The findings. Populated when include_findings in the request is true.
- class google.cloud.dlp_v2.types.ReidentifyContentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to re-identify an item.
- parent¶
Required. Parent resource name.
The format of this value varies depending on whether you have specified a processing location:
Projects scope, location specified:
projects/PROJECT_ID/locations/LOCATION_IDProjects scope, no location specified (defaults to global):
projects/PROJECT_ID
The following example
parentstring specifies a parent project with the identifierexample-project, and specifies theeurope-west3location for processing data:parent=projects/example-project/locations/europe-west3
- Type
- reidentify_config¶
Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are:
CryptoDeterministicConfigCryptoReplaceFfxFpeConfig
- inspect_config¶
Configuration for the inspector.
- item¶
The item to re-identify. Will be treated as text.
- inspect_template_name¶
Template to use. Any configuration directly specified in
inspect_configwill override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.- Type
- reidentify_template_name¶
Template to use. References an instance of
DeidentifyTemplate. Any configuration directly specified inreidentify_configorinspect_configwill override those set in the template. TheDeidentifyTemplateused must include only reversible transformations. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.- Type
- class google.cloud.dlp_v2.types.ReidentifyContentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResults of re-identifying an item.
- item¶
The re-identified item.
- overview¶
An overview of the changes that were made to the
item.
- class google.cloud.dlp_v2.types.RelationalOperator(value)[source]¶
Bases:
proto.enums.EnumOperators available for comparing the value of fields.
- Values:
- RELATIONAL_OPERATOR_UNSPECIFIED (0):
Unused
- EQUAL_TO (1):
Equal. Attempts to match even with incompatible types.
- NOT_EQUAL_TO (2):
Not equal to. Attempts to match even with incompatible types.
- GREATER_THAN (3):
Greater than.
- LESS_THAN (4):
Less than.
- GREATER_THAN_OR_EQUALS (5):
Greater than or equals.
- LESS_THAN_OR_EQUALS (6):
Less than or equals.
- EXISTS (7):
Exists
- class google.cloud.dlp_v2.types.ReplaceDictionaryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReplace each input value with a value randomly selected from the dictionary.
- class google.cloud.dlp_v2.types.ReplaceValueConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReplace each input value with a given
Value.- new_value¶
Value to replace it with.
- class google.cloud.dlp_v2.types.ReplaceWithInfoTypeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReplace each matching finding with the name of the info_type.
- class google.cloud.dlp_v2.types.ResourceVisibility(value)[source]¶
Bases:
proto.enums.EnumHow broadly a resource has been shared. New items may be added over time. A higher number means more restricted.
- Values:
- RESOURCE_VISIBILITY_UNSPECIFIED (0):
Unused.
- RESOURCE_VISIBILITY_PUBLIC (10):
Visible to any user.
- RESOURCE_VISIBILITY_RESTRICTED (20):
Visible only to specific users.
- class google.cloud.dlp_v2.types.RiskAnalysisJobConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for a risk analysis job. See https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more.
- privacy_metric¶
Privacy metric to compute.
- source_table¶
Input dataset to compute metrics over.
- actions¶
Actions to execute at the completion of the job. Are executed in the order provided.
- Type
MutableSequence[google.cloud.dlp_v2.types.Action]
- class google.cloud.dlp_v2.types.Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSchedule for inspect job triggers.
- recurrence_period_duration¶
With this option a job is started on a regular periodic basis. For example: every day (86400 seconds).
A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs.
This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.
This field is a member of oneof
option.
- class google.cloud.dlp_v2.types.SensitivityScore(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageScore is a summary of all elements in the data profile. A higher number means more sensitive.
- score¶
The score applied to the resource.
- class SensitivityScoreLevel(value)[source]¶
Bases:
proto.enums.EnumVarious score levels for resources.
- Values:
- SENSITIVITY_SCORE_UNSPECIFIED (0):
Unused.
- SENSITIVITY_LOW (10):
No sensitive information detected. Limited access.
- SENSITIVITY_MODERATE (20):
Medium risk - PII, potentially sensitive data, or fields with free-text data that are at higher risk of having intermittent sensitive data. Consider limiting access.
- SENSITIVITY_HIGH (30):
High risk – SPII may be present. Exfiltration of data may lead to user data loss. Re-identification of users may be possible. Consider limiting usage and or removing SPII.
- class google.cloud.dlp_v2.types.StatisticalTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn auxiliary table containing statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).
- table¶
Required. Auxiliary table location.
- quasi_ids¶
Required. Quasi-identifier columns.
- Type
MutableSequence[google.cloud.dlp_v2.types.StatisticalTable.QuasiIdentifierField]
- relative_frequency¶
Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero.
- class QuasiIdentifierField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.
- field¶
Identifies the column.
- class google.cloud.dlp_v2.types.StorageConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageShared message indicating Cloud storage type.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- timespan_config¶
- class TimespanConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery.
- start_time¶
Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.
- end_time¶
Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.
- timestamp_field¶
Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.
For BigQuery
If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a
NULLvalue in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are:INTEGER,DATE,TIMESTAMP, andDATETIME.If your BigQuery table is partitioned at ingestion time, you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive.
_PARTITIONTIME_PARTITIONDATE_PARTITION_LOAD_TIME
For Datastore
If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are:
TIMESTAMP.See the known issue related to this operation.
- enable_auto_population_of_timespan_config¶
When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger.
- Type
- class google.cloud.dlp_v2.types.StorageMetadataLabel(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStorage metadata label to indicate which metadata entry contains findings.
- class google.cloud.dlp_v2.types.StoredInfoType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStoredInfoType resource message that contains information about the current version and any pending updates.
- current_version¶
Current version of the stored info type.
- pending_versions¶
Pending versions of the stored info type. Empty if no versions are pending.
- Type
MutableSequence[google.cloud.dlp_v2.types.StoredInfoTypeVersion]
- class google.cloud.dlp_v2.types.StoredInfoTypeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- large_custom_dictionary¶
StoredInfoType where findings are defined by a dictionary of phrases.
This field is a member of oneof
type.
- class google.cloud.dlp_v2.types.StoredInfoTypeState(value)[source]¶
Bases:
proto.enums.EnumState of a StoredInfoType version.
- Values:
- STORED_INFO_TYPE_STATE_UNSPECIFIED (0):
Unused
- PENDING (1):
StoredInfoType version is being created.
- READY (2):
StoredInfoType version is ready for use.
- FAILED (3):
StoredInfoType creation failed. All relevant error messages are returned in the
StoredInfoTypeVersionmessage.- INVALID (4):
StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the
UpdateStoredInfoTypemethod to create a new version.
- class google.cloud.dlp_v2.types.StoredInfoTypeStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatistics for a StoredInfoType.
- class google.cloud.dlp_v2.types.StoredInfoTypeVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVersion of a StoredInfoType, including the configuration used to build it, create timestamp, and current state.
- config¶
StoredInfoType configuration.
- create_time¶
Create timestamp of the version. Read-only, determined by the system when the version is created.
- state¶
Stored info type version state. Read-only, updated by the system during dictionary creation.
- errors¶
Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first.
For example, some of the data for stored custom dictionaries is put in the user’s Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid.
If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same
configif it was not the source of the error.- Type
MutableSequence[google.cloud.dlp_v2.types.Error]
- stats¶
Statistics about this storedInfoType version.
- class google.cloud.dlp_v2.types.StoredType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA reference to a StoredInfoType to use with scanning.
- name¶
Resource name of the requested
StoredInfoType, for exampleorganizations/433245324/storedInfoTypes/432452342orprojects/project-id/storedInfoTypes/432452342.- Type
- create_time¶
Timestamp indicating when the version of the
StoredInfoTypeused for inspection was created. Output-only field, populated by the system.
- class google.cloud.dlp_v2.types.Table(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStructured content to inspect. Up to 50,000
Values per request allowed. See https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table to learn more.- headers¶
Headers of the table.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- rows¶
Rows of the table.
- Type
MutableSequence[google.cloud.dlp_v2.types.Table.Row]
- class Row(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageValues of the row.
- values¶
Individual cells.
- Type
MutableSequence[google.cloud.dlp_v2.types.Value]
- class google.cloud.dlp_v2.types.TableDataProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe profile for a scanned table.
- dataset_location¶
The BigQuery location where the dataset’s data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Type
- full_resource¶
The resource name of the table. https://cloud.google.com/apis/design/resource_names#full_resource_name
- Type
- profile_status¶
Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.
- state¶
State of a profile.
- sensitivity_score¶
The sensitivity score of this table.
- data_risk_level¶
The data risk level of this table.
- predicted_info_types¶
The infoTypes predicted from this table’s data.
- Type
MutableSequence[google.cloud.dlp_v2.types.InfoTypeSummary]
- other_info_types¶
Other infoTypes found in this table’s data.
- Type
MutableSequence[google.cloud.dlp_v2.types.OtherInfoTypeSummary]
- config_snapshot¶
The snapshot of the configurations used to generate the profile.
- last_modified_time¶
The time when this table was last modified
- expiration_time¶
Optional. The time when this table expires.
- row_count¶
Number of rows in the table when the profile was generated. This will not be populated for BigLake tables.
- Type
- encryption_status¶
How the table is encrypted.
- resource_visibility¶
How broadly a resource has been shared.
- profile_last_generated¶
The last time the profile was generated.
- resource_labels¶
The labels applied to the resource at the time the profile was generated.
- create_time¶
The time at which the table was created.
- class ResourceLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumPossible states of a profile. New items may be added.
- Values:
- STATE_UNSPECIFIED (0):
Unused.
- RUNNING (1):
The profile is currently running. Once a profile has finished it will transition to DONE.
- DONE (2):
The profile is no longer generating. If profile_status.status.code is 0, the profile succeeded, otherwise, it failed.
- class google.cloud.dlp_v2.types.TableLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLocation of a finding within a table.
- row_index¶
The zero-based index of the row where the finding is located. Only populated for resources that have a natural ordering, not BigQuery. In BigQuery, to identify the row a finding came from, populate BigQueryOptions.identifying_fields with your primary key column names and when you store the findings the value of those columns will be stored inside of Finding.
- Type
- class google.cloud.dlp_v2.types.TableOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInstructions regarding the table content being inspected.
- identifying_fields¶
The columns that are the primary keys for table objects included in ContentItem. A copy of this cell’s value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- class google.cloud.dlp_v2.types.TimePartConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFor use with
Date,Timestamp, andTimeOfDay, extract or preserve a portion of the value.- part_to_extract¶
The part of the time to keep.
- class TimePart(value)[source]¶
Bases:
proto.enums.EnumComponents that make up time.
- Values:
- TIME_PART_UNSPECIFIED (0):
Unused
- YEAR (1):
[0-9999]
- MONTH (2):
[1-12]
- DAY_OF_MONTH (3):
[1-31]
- DAY_OF_WEEK (4):
[1-7]
- WEEK_OF_YEAR (5):
[1-53]
- HOUR_OF_DAY (6):
[0-23]
- class google.cloud.dlp_v2.types.TransformationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUser specified templates and configs for how to deidentify structured, unstructures, and image files. User must provide either a unstructured deidentify template or at least one redact image config.
- deidentify_template¶
De-identify template. If this template is specified, it will serve as the default de-identify template. This template cannot contain
record_transformationssince it can be used for unstructured content such as free-form text files. If this template is not set, a defaultReplaceWithInfoTypeConfigwill be used to de-identify unstructured content.- Type
- structured_deidentify_template¶
Structured de-identify template. If this template is specified, it will serve as the de-identify template for structured content such as delimited files and tables. If this template is not set but the
deidentify_templateis set, thendeidentify_templatewill also apply to the structured content. If neither template is set, a defaultReplaceWithInfoTypeConfigwill be used to de-identify structured content.- Type
- class google.cloud.dlp_v2.types.TransformationContainerType(value)[source]¶
Bases:
proto.enums.EnumDescribes functionality of a given container in its original format.
- Values:
- TRANSFORM_UNKNOWN_CONTAINER (0):
No description available.
- TRANSFORM_BODY (1):
No description available.
- TRANSFORM_METADATA (2):
No description available.
- TRANSFORM_TABLE (3):
No description available.
- class google.cloud.dlp_v2.types.TransformationDescription(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA flattened description of a
PrimitiveTransformationorRecordSuppression.- type_¶
The transformation type.
- description¶
A description of the transformation. This is empty for a RECORD_SUPPRESSION, or is the output of calling toString() on the
PrimitiveTransformationprotocol buffer message for any other type of transformation.- Type
- condition¶
A human-readable string representation of the
RecordConditioncorresponding to this transformation. Set if aRecordConditionwas used to determine whether or not to apply this transformation.Examples: * (age_field > 85) * (age_field <= 18) * (zip_field exists) * (zip_field == 01234) && (city_field != “Springville”) * (zip_field == 01234) && (age_field <= 18) && (city_field exists)
- Type
- info_type¶
Set if the transformation was limited to a specific
InfoType.
- class google.cloud.dlp_v2.types.TransformationDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails about a single transformation. This object contains a description of the transformation, information about whether the transformation was successfully applied, and the precise location where the transformation occurred. These details are stored in a user-specified BigQuery table.
- container_name¶
The top level name of the container where the transformation is located (this will be the source file name or table name).
- Type
- transformation¶
Description of transformation. This would only contain more than one element if there were multiple matching transformations and which one to apply was ambiguous. Not set for states that contain no transformation, currently only state that contains no transformation is TransformationResultStateType.METADATA_UNRETRIEVABLE.
- Type
MutableSequence[google.cloud.dlp_v2.types.TransformationDescription]
- status_details¶
Status of the transformation, if transformation was not successful, this will specify what caused it to fail, otherwise it will show that the transformation was successful.
- transformed_bytes¶
The number of bytes that were transformed. If transformation was unsuccessful or did not take place because there was no content to transform, this will be zero.
- Type
- transformation_location¶
The precise location of the transformed content in the original container.
- class google.cloud.dlp_v2.types.TransformationDetailsStorageConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfig for storing transformation details.
- table¶
The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details.
This field is a member of oneof
type.
- class google.cloud.dlp_v2.types.TransformationErrorHandling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHow to handle transformation errors during de-identification. A transformation error occurs when the requested transformation is incompatible with the data. For example, trying to de-identify an IP address using a
DateShifttransformation would result in a transformation error, since date info cannot be extracted from an IP address. Information about any incompatible transformations, and how they were handled, is returned in the response as part of theTransformationOverviews.This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class LeaveUntransformed(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSkips the data without modifying it if the requested transformation would cause an error. For example, if a
DateShifttransformation were applied an an IP address, this mode would leave the IP address unchanged in the response.
- class ThrowError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThrow an error and fail the request when a transformation error occurs.
- class google.cloud.dlp_v2.types.TransformationLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies the location of a transformation.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- finding_id¶
For infotype transformations, link to the corresponding findings ID so that location information does not need to be duplicated. Each findings ID correlates to an entry in the findings output table, this table only gets created when users specify to save findings (add the save findings action to the request).
This field is a member of oneof
location_type.- Type
- record_transformation¶
For record transformations, provide a field and container information.
This field is a member of oneof
location_type.
- container_type¶
Information about the functionality of the container where this finding occurred, if available.
- class google.cloud.dlp_v2.types.TransformationOverview(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOverview of the modifications that occurred.
- transformation_summaries¶
Transformations applied to the dataset.
- Type
MutableSequence[google.cloud.dlp_v2.types.TransformationSummary]
- class google.cloud.dlp_v2.types.TransformationResultStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- result_status_type¶
Transformation result status type, this will be either SUCCESS, or it will be the reason for why the transformation was not completely successful.
- details¶
Detailed error codes and messages
- Type
google.rpc.status_pb2.Status
- class google.cloud.dlp_v2.types.TransformationResultStatusType(value)[source]¶
Bases:
proto.enums.EnumEnum of possible outcomes of transformations. SUCCESS if transformation and storing of transformation was successful, otherwise, reason for not transforming.
- Values:
- STATE_TYPE_UNSPECIFIED (0):
No description available.
- INVALID_TRANSFORM (1):
This will be set when a finding could not be transformed (i.e. outside user set bucket range).
- BIGQUERY_MAX_ROW_SIZE_EXCEEDED (2):
This will be set when a BigQuery transformation was successful but could not be stored back in BigQuery because the transformed row exceeds BigQuery’s max row size.
- METADATA_UNRETRIEVABLE (3):
This will be set when there is a finding in the custom metadata of a file, but at the write time of the transformed file, this key / value pair is unretrievable.
- SUCCESS (4):
This will be set when the transformation and storing of it is successful.
- class google.cloud.dlp_v2.types.TransformationSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSummary of a single transformation. Only one of ‘transformation’, ‘field_transformation’, or ‘record_suppress’ will be set.
- info_type¶
Set if the transformation was limited to a specific InfoType.
- field¶
Set if the transformation was limited to a specific FieldId.
- transformation¶
The specific transformation these stats apply to.
- field_transformations¶
The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldTransformation]
- record_suppress¶
The specific suppression option these stats apply to.
- results¶
Collection of all transformations that took place or had an error.
- Type
MutableSequence[google.cloud.dlp_v2.types.TransformationSummary.SummaryResult]
- class SummaryResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA collection that informs the user the number of times a particular
TransformationResultCodeand error details occurred.- code¶
Outcome of the transformation.
- class TransformationResultCode(value)[source]¶
Bases:
proto.enums.EnumPossible outcomes of transformations.
- Values:
- TRANSFORMATION_RESULT_CODE_UNSPECIFIED (0):
Unused
- SUCCESS (1):
Transformation completed without an error.
- ERROR (2):
Transformation had an error.
- class google.cloud.dlp_v2.types.TransformationType(value)[source]¶
Bases:
proto.enums.EnumAn enum of rules that can be used to transform a value. Can be a record suppression, or one of the transformation rules specified under
PrimitiveTransformation.- Values:
- TRANSFORMATION_TYPE_UNSPECIFIED (0):
Unused
- RECORD_SUPPRESSION (1):
Record suppression
- REPLACE_VALUE (2):
Replace value
- REPLACE_DICTIONARY (15):
Replace value using a dictionary.
- REDACT (3):
Redact
- CHARACTER_MASK (4):
Character mask
- CRYPTO_REPLACE_FFX_FPE (5):
FFX-FPE
- FIXED_SIZE_BUCKETING (6):
Fixed size bucketing
- BUCKETING (7):
Bucketing
- REPLACE_WITH_INFO_TYPE (8):
Replace with info type
- TIME_PART (9):
Time part
- CRYPTO_HASH (10):
Crypto hash
- DATE_SHIFT (12):
Date shift
- CRYPTO_DETERMINISTIC_CONFIG (13):
Deterministic crypto
- REDACT_IMAGE (14):
Redact image
- class google.cloud.dlp_v2.types.TransientCryptoKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUse this to have a random data crypto key generated. It will be discarded after the request finishes.
- name¶
Required. Name of the key. This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate
TransientCryptoKeyprotos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated).- Type
- class google.cloud.dlp_v2.types.UnwrappedCryptoKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUsing raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.
- class google.cloud.dlp_v2.types.UpdateDeidentifyTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateDeidentifyTemplate.
- name¶
Required. Resource name of organization and deidentify template to be updated, for example
organizations/433245324/deidentifyTemplates/432452342or projects/project-id/deidentifyTemplates/432452342.- Type
- deidentify_template¶
New DeidentifyTemplate value.
- update_mask¶
Mask to control which fields get updated.
- class google.cloud.dlp_v2.types.UpdateInspectTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateInspectTemplate.
- name¶
Required. Resource name of organization and inspectTemplate to be updated, for example
organizations/433245324/inspectTemplates/432452342or projects/project-id/inspectTemplates/432452342.- Type
- inspect_template¶
New InspectTemplate value.
- update_mask¶
Mask to control which fields get updated.
- class google.cloud.dlp_v2.types.UpdateJobTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateJobTrigger.
- name¶
Required. Resource name of the project and the triggeredJob, for example
projects/dlp-test-project/jobTriggers/53234423.- Type
- job_trigger¶
New JobTrigger value.
- update_mask¶
Mask to control which fields get updated.
- class google.cloud.dlp_v2.types.UpdateStoredInfoTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateStoredInfoType.
- name¶
Required. Resource name of organization and storedInfoType to be updated, for example
organizations/433245324/storedInfoTypes/432452342or projects/project-id/storedInfoTypes/432452342.- Type
- config¶
Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration.
- update_mask¶
Mask to control which fields get updated.
- class google.cloud.dlp_v2.types.Value(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSet of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a ‘Value’ is based on its representation as a UTF-8 encoded string. For example, if ‘integer_value’ is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.dlp_v2.types.ValueFrequency(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA value of a field, including its frequency.
- value¶
A value contained in the field in question.
