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/sensitive-data-protection/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 file types will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn’t supported by the Deidentify action then the job will fail and will not be successfully created/started. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.
- 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 Security Command Center. This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by service-specific policies for Security Command Center. 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/sensitive-data-protection/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.ActionDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe results of an [Action][google.privacy.dlp.v2.Action].
- 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.AllOtherDatabaseResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMatch database resources not covered by any other filter.
- class google.cloud.dlp_v2.types.AllOtherResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMatch discovery resources not covered by any other filter.
- class google.cloud.dlp_v2.types.AmazonS3Bucket(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAmazon S3 bucket.
- aws_account¶
The AWS account.
- class google.cloud.dlp_v2.types.AmazonS3BucketConditions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAmazon S3 bucket conditions.
- bucket_types¶
Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified.
- Type
MutableSequence[google.cloud.dlp_v2.types.AmazonS3BucketConditions.BucketType]
- object_storage_classes¶
Optional. Object classes that should be profiled. Optional. Defaults to ALL_SUPPORTED_CLASSES if unspecified.
- Type
MutableSequence[google.cloud.dlp_v2.types.AmazonS3BucketConditions.ObjectStorageClass]
- class BucketType(value)[source]¶
Bases:
proto.enums.EnumSupported Amazon S3 bucket types. Defaults to TYPE_ALL_SUPPORTED.
- Values:
- TYPE_UNSPECIFIED (0):
Unused.
- TYPE_ALL_SUPPORTED (1):
All supported classes.
- TYPE_GENERAL_PURPOSE (2):
A general purpose Amazon S3 bucket.
- class ObjectStorageClass(value)[source]¶
Bases:
proto.enums.EnumSupported Amazon S3 object storage classes. Defaults to ALL_SUPPORTED_CLASSES.
- Values:
- UNSPECIFIED (0):
Unused.
- ALL_SUPPORTED_CLASSES (1):
All supported classes.
- STANDARD (2):
Standard object class.
- STANDARD_INFREQUENT_ACCESS (4):
Standard - infrequent access object class.
- GLACIER_INSTANT_RETRIEVAL (6):
Glacier - instant retrieval object class.
- INTELLIGENT_TIERING (7):
Objects in the S3 Intelligent-Tiering access tiers.
- class google.cloud.dlp_v2.types.AmazonS3BucketRegex(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAmazon S3 bucket regex.
- aws_account_regex¶
The AWS account regex.
- 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.AwsAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAWS account.
- class google.cloud.dlp_v2.types.AwsAccountRegex(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAWS account regex.
- class google.cloud.dlp_v2.types.BigQueryDiscoveryTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTarget used to match against for discovery with BigQuery tables
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.
- filter¶
Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
- conditions¶
In addition to matching the filter, these conditions must be true before a profile is generated.
- cadence¶
How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
This field is a member of oneof
frequency.
- 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.
Caution: A known issue is causing the
rowsLimitPercentfield to behave unexpectedly. We recommend usingrowsLimitinstead.- Type
- sample_method¶
How to sample the data.
- excluded_fields¶
References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.
- Type
MutableSequence[google.cloud.dlp_v2.types.FieldId]
- included_fields¶
Limit scanning only to these fields. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.
- 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 sampling.
- 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.BigQueryRegex(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA pattern to match against one or more tables, datasets, or projects that contain BigQuery tables. At least one pattern must be specified. Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub.
- project_id_regex¶
For organizations, if unset, will match all projects. Has no effect for data profile configurations created within a project.
- Type
- class google.cloud.dlp_v2.types.BigQueryRegexes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA collection of regular expressions to determine what tables to match against.
- patterns¶
A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.
- Type
MutableSequence[google.cloud.dlp_v2.types.BigQueryRegex]
- class google.cloud.dlp_v2.types.BigQuerySchemaModification(value)[source]¶
Bases:
proto.enums.EnumAttributes evaluated to determine if a schema has been modified. New values may be added at a later time.
- Values:
- SCHEMA_MODIFICATION_UNSPECIFIED (0):
Unused
- SCHEMA_NEW_COLUMNS (1):
Profiles should be regenerated when new columns are added to the table. Default.
- SCHEMA_REMOVED_COLUMNS (2):
Profiles should be regenerated when columns are removed from the table.
- 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.BigQueryTableCollection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies a collection of BigQuery tables. Used for Discovery.
- class google.cloud.dlp_v2.types.BigQueryTableModification(value)[source]¶
Bases:
proto.enums.EnumAttributes evaluated to determine if a table has been modified. New values may be added at a later time.
- Values:
- TABLE_MODIFICATION_UNSPECIFIED (0):
Unused.
- TABLE_MODIFIED_TIMESTAMP (1):
A table will be considered modified when the last_modified_time from BigQuery has been updated.
- class google.cloud.dlp_v2.types.BigQueryTableType(value)[source]¶
Bases:
proto.enums.EnumOver time new types may be added. Currently VIEW, MATERIALIZED_VIEW, and non-BigLake external tables are not supported.
- Values:
- BIG_QUERY_TABLE_TYPE_UNSPECIFIED (0):
Unused.
- BIG_QUERY_TABLE_TYPE_TABLE (1):
A normal BigQuery table.
- BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE (2):
A table that references data stored in Cloud Storage.
- BIG_QUERY_TABLE_TYPE_SNAPSHOT (3):
A snapshot of a BigQuery table.
- class google.cloud.dlp_v2.types.BigQueryTableTypeCollection(value)[source]¶
Bases:
proto.enums.EnumOver time new types may be added. Currently VIEW, MATERIALIZED_VIEW, and non-BigLake external tables are not supported.
- Values:
- BIG_QUERY_COLLECTION_UNSPECIFIED (0):
Unused.
- BIG_QUERY_COLLECTION_ALL_TYPES (1):
Automatically generate profiles for all tables, even if the table type is not yet fully supported for analysis. Profiles for unsupported tables will be generated with errors to indicate their partial support. When full support is added, the tables will automatically be profiled during the next scheduled run.
- BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES (2):
Only those types fully supported will be profiled. Will expand automatically as Cloud DLP adds support for new table types. Unsupported table types will not have partial profiles generated.
- class google.cloud.dlp_v2.types.BigQueryTableTypes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe types of BigQuery tables supported by Cloud DLP.
- types¶
A set of BigQuery table types.
- Type
MutableSequence[google.cloud.dlp_v2.types.BigQueryTableType]
- 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/sensitive-data-protection/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
- AUDIO (15):
Audio file types. Only used for profiling.
- VIDEO (16):
Video file types. Only used for profiling.
- EXECUTABLE (17):
Executable file types. Only used for profiling.
- 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.CloudSqlDiscoveryTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTarget used to match against for discovery with Cloud SQL tables.
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.
- filter¶
Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table.
- conditions¶
In addition to matching the filter, these conditions must be true before a profile is generated.
- generation_cadence¶
How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
This field is a member of oneof
cadence.
- class google.cloud.dlp_v2.types.CloudSqlIamCredential(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUse IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication.
- class google.cloud.dlp_v2.types.CloudSqlProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud SQL connection properties.
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.
- connection_name¶
Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated.
It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name
project-id:us-central1:sql-instancemust be created under the parentprojects/project-id/locations/us-central1- Type
- username_password¶
A username and password stored in Secret Manager.
This field is a member of oneof
credential.
- cloud_sql_iam¶
Built-in IAM authentication (must be configured in Cloud SQL).
This field is a member of oneof
credential.
- max_connections¶
Required. DLP will limit its connections to max_connections. Must be 2 or greater.
- Type
- database_engine¶
Required. The database engine used by the Cloud SQL instance that this connection configures.
- class DatabaseEngine(value)[source]¶
Bases:
proto.enums.EnumDatabase engine of a Cloud SQL instance. New values may be added over time.
- Values:
- DATABASE_ENGINE_UNKNOWN (0):
An engine that is not currently supported by Sensitive Data Protection.
- DATABASE_ENGINE_MYSQL (1):
Cloud SQL for MySQL instance.
- DATABASE_ENGINE_POSTGRES (2):
Cloud SQL for PostgreSQL instance.
- class google.cloud.dlp_v2.types.CloudStorageDiscoveryTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTarget used to match against for discovery with Cloud Storage buckets.
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.
- filter¶
Required. The buckets the generation_cadence applies to. The first target with a matching filter will be the one to apply to a bucket.
- conditions¶
Optional. In addition to matching the filter, these conditions must be true before a profile is generated.
- generation_cadence¶
Optional. How often and when to update profiles. New buckets that match both the filter and conditions are scanned as quickly as possible depending on system capacity.
This field is a member of oneof
cadence.
- 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_fileandbytes_limit_per_file_percentcan be specified. This field can’t be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see Limits on bytes scanned per file.- 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. This field can’t be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see Limits on bytes scanned per file.
- 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¶
How to sample the data.
- 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 sampling.
- 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.CloudStorageRegex(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA pattern to match against one or more file stores. At least one pattern must be specified. Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub.
- 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.CloudStorageResourceReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIdentifies a single Cloud Storage bucket.
- 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.ColumnDataProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe profile for a scanned column within a table.
- 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.
- profile_last_generated¶
The last time the profile was generated.
- dataset_location¶
If supported, the location where the dataset’s data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.
- Type
- sensitivity_score¶
The sensitivity of this column.
- data_risk_level¶
The data risk level for this column.
- column_info_type¶
If it’s been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.
- other_matches¶
Other types found within this column. List will be unordered.
- Type
MutableSequence[google.cloud.dlp_v2.types.OtherInfoTypeSummary]
- estimated_null_percentage¶
Approximate percentage of entries being null in the column.
- estimated_uniqueness_score¶
Approximate uniqueness of the column.
- free_text_score¶
The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.
- Type
- column_type¶
The data type of a given column.
- policy_state¶
Indicates if a policy tag has been applied to the column.
- class ColumnDataType(value)[source]¶
Bases:
proto.enums.EnumData types of the data in a column. Types may be added over time.
- Values:
- COLUMN_DATA_TYPE_UNSPECIFIED (0):
Invalid type.
- TYPE_INT64 (1):
Encoded as a string in decimal format.
- TYPE_BOOL (2):
Encoded as a boolean “false” or “true”.
- TYPE_FLOAT64 (3):
Encoded as a number, or string “NaN”, “Infinity” or “-Infinity”.
- TYPE_STRING (4):
Encoded as a string value.
- TYPE_BYTES (5):
Encoded as a base64 string per RFC 4648, section 4.
- TYPE_TIMESTAMP (6):
Encoded as an RFC 3339 timestamp with mandatory “Z” time zone string: 1985-04-12T23:20:50.52Z
- TYPE_DATE (7):
Encoded as RFC 3339 full-date format string: 1985-04-12
- TYPE_TIME (8):
Encoded as RFC 3339 partial-time format string: 23:20:50.52
- TYPE_DATETIME (9):
Encoded as RFC 3339 full-date “T” partial-time: 1985-04-12T23:20:50.52
- TYPE_GEOGRAPHY (10):
Encoded as WKT
- TYPE_NUMERIC (11):
Encoded as a decimal string.
- TYPE_RECORD (12):
Container of ordered fields, each with a type and field name.
- TYPE_BIGNUMERIC (13):
Decimal type.
- TYPE_JSON (14):
Json type.
- TYPE_INTERVAL (15):
Interval type.
- TYPE_RANGE_DATE (16):
Range<Date>type.- TYPE_RANGE_DATETIME (17):
Range<Datetime>type.- TYPE_RANGE_TIMESTAMP (18):
Range<Timestamp>type.
- class ColumnPolicyState(value)[source]¶
Bases:
proto.enums.EnumThe possible policy states for a column.
- Values:
- COLUMN_POLICY_STATE_UNSPECIFIED (0):
No policy tags.
- COLUMN_POLICY_TAGGED (1):
Column has policy tag applied.
- 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.Connection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA data connection to allow DLP to profile data in locations that require additional configuration.
- name¶
Output only. Name of the connection:
projects/{project}/locations/{location}/connections/{name}.- Type
- state¶
Required. The connection’s state in its lifecycle.
- errors¶
Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
- Type
MutableSequence[google.cloud.dlp_v2.types.Error]
- class google.cloud.dlp_v2.types.ConnectionState(value)[source]¶
Bases:
proto.enums.EnumState of the connection. New values may be added over time.
- Values:
- CONNECTION_STATE_UNSPECIFIED (0):
Unused
- MISSING_CREDENTIALS (1):
DLP automatically created this connection during an initial scan, and it is awaiting full configuration by a user.
- AVAILABLE (2):
A configured connection that has not encountered any errors.
- ERROR (3):
A configured connection that encountered errors during its last use. It will not be used again until it is set to AVAILABLE.
If the resolution requires external action, then the client must send a request to set the status to AVAILABLE when the connection is ready for use. If the resolution doesn’t require external action, then any changes to the connection properties will automatically mark it as AVAILABLE.
- 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.MessageType of content to inspect.
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.
- table¶
Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/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.CreateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateConnection.
- parent¶
Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization):
Projects scope:
projects/{project_id}/locations/{location_id}Organizations scope:
organizations/{org_id}/locations/{location_id}
- Type
- connection¶
Required. The connection resource.
- 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_id}Projects scope, no location specified (defaults to global):
projects/{project_id}Organizations scope, location specified:
organizations/{org_id}/locations/{location_id}Organizations 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.CreateDiscoveryConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateDiscoveryConfig.
- parent¶
Required. Parent resource name.
The format of this value varies depending on the scope of the request (project or organization):
Projects scope:
projects/{project_id}/locations/{location_id}Organizations scope:
organizations/{org_id}/locations/{location_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
- discovery_config¶
Required. The DiscoveryConfig to create.
- 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_id}Projects 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_id}Projects scope, no location specified (defaults to global):
projects/{project_id}Organizations scope, location specified:
organizations/{org_id}/locations/{location_id}Organizations 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_id}Projects 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_id}Projects scope, no location specified (defaults to global):
projects/{project_id}Organizations scope, location specified:
organizations/{org_id}/locations/{location_id}Organizations 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/sensitive-data-protection/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/sensitive-data-protection/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/sensitive-data-protection/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.
- sensitivity_score¶
Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling.
- 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/sensitive-data-protection/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/sensitive-data-protection/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.EnumType of exclusion rule.
- 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/sensitive-data-protection/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.
- publish_to_chronicle¶
Publishes generated data profiles to Google Security Operations. For more information, see Use Sensitive Data Protection data in context-aware analytics.
This field is a member of oneof
action.
- publish_to_scc¶
Publishes findings to SCC for each data profile.
This field is a member of oneof
action.
- tag_resources¶
Tags the profiled resources with the specified tag values.
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):
One of the following profile metrics changed: Data risk score, Sensitivity score, Resource visibility, Encryption type, Predicted infoTypes, 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 new rows in BigQuery. Data is inserted using streaming insert and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification.
- 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 name of the profiled resource.
- FILE_STORE_PROFILE (3):
The full file store data profile.
- class PublishToChronicle(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage expressing intention to publish to Google Security Operations.
- class PublishToSecurityCommandCenter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIf set, a summary finding will be created/updated in SCC for each profile.
- class TagResources(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIf set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support access control. You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.
- tag_conditions¶
The tags to associate with different conditions.
- Type
MutableSequence[google.cloud.dlp_v2.types.DataProfileAction.TagResources.TagCondition]
- profile_generations_to_tag¶
The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn’t change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both
PROFILE_GENERATION_NEWandPROFILE_GENERATION_UPDATE.- Type
MutableSequence[google.cloud.dlp_v2.types.ProfileGeneration]
- lower_data_risk_to_low¶
Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an IAM deny policy, you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.
- Type
- class TagCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe tag to attach to profiles matching the condition. At most one
TagConditioncan be specified per sensitivity level.- tag¶
The tag value to attach to resources.
- class TagValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA value of a tag.
- class google.cloud.dlp_v2.types.DataProfileBigQueryRowSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe schema of data to be saved to the BigQuery table when the
DataProfileActionis enabled.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.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. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will.
- discovery_config¶
A copy of the configuration used to generate this profile.
- inspect_template_modified_time¶
Timestamp when the template was modified
- 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/sensitive-data-protection/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
- other_cloud_starting_location¶
Must be set only when scanning other clouds.
- 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/sensitive-data-protection/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.
- file_store_profile¶
If
DetailLevelisFILE_STORE_PROFILEthis will be fully populated. Otherwise, ifDetailLevelisRESOURCE_NAME, then onlynameandfile_store_pathwill be populated.
- event¶
The event that caused the Pub/Sub message to be sent.
- class google.cloud.dlp_v2.types.DataProfileUpdateFrequency(value)[source]¶
Bases:
proto.enums.EnumHow frequently data profiles can be updated. New options can be added at a later time.
- Values:
- UPDATE_FREQUENCY_UNSPECIFIED (0):
Unspecified.
- UPDATE_FREQUENCY_NEVER (1):
After the data profile is created, it will never be updated.
- UPDATE_FREQUENCY_DAILY (2):
The data profile can be updated up to once every 24 hours.
- UPDATE_FREQUENCY_MONTHLY (4):
The data profile can be updated up to once every 30 days. Default.
- 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_UNKNOWN (12):
Unable to determine risk.
- 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.DataSourceType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage used to identify the type of resource being profiled.
- class google.cloud.dlp_v2.types.DatabaseResourceCollection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMatch database resources using regex filters. Examples of database resources are tables, views, and stored procedures.
- class google.cloud.dlp_v2.types.DatabaseResourceReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIdentifies a single database resource, like a table within a database.
- project_id¶
Required. If within a project-level config, then this must match the config’s project ID.
- Type
- instance¶
Required. The instance where this resource is located. For example: Cloud SQL instance ID.
- Type
- class google.cloud.dlp_v2.types.DatabaseResourceRegex(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub.
- project_id_regex¶
For organizations, if unset, will match all projects. Has no effect for configurations created within a project.
- Type
- class google.cloud.dlp_v2.types.DatabaseResourceRegexes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA collection of regular expressions to determine what database resources to match against.
- patterns¶
A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression’s length can’t exceed 10 KiB.
- Type
MutableSequence[google.cloud.dlp_v2.types.DatabaseResourceRegex]
- 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/sensitive-data-protection/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_id}Projects 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.DeidentifyDataSourceDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe results of a [Deidentify][google.privacy.dlp.v2.Action.Deidentify] action from an inspect job.
- requested_options¶
De-identification config used for the request.
- deidentify_stats¶
Stats about the de-identification operation.
- class RequestedDeidentifyOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDe-identification options.
- snapshot_deidentify_template¶
Snapshot of the state of the
DeidentifyTemplatefrom the [Deidentify][google.privacy.dlp.v2.Action.Deidentify] action at the time this job was run.
- snapshot_structured_deidentify_template¶
Snapshot of the state of the structured
DeidentifyTemplatefrom theDeidentifyaction at the time this job was run.
- snapshot_image_redact_template¶
Snapshot of the state of the image transformation
DeidentifyTemplatefrom theDeidentifyaction at the time this job was run.
- class google.cloud.dlp_v2.types.DeidentifyDataSourceStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSummary of what was modified during a transformation.
- 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/sensitive-data-protection/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.DeleteConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteConnection.
- 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.DeleteDiscoveryConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteDiscoveryConfig.
- 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.DeleteFileStoreDataProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteFileStoreProfile.
- 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.DeleteTableDataProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteTableProfile.
- class google.cloud.dlp_v2.types.Disabled(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDo not profile the tables.
- class google.cloud.dlp_v2.types.DiscoveryBigQueryConditions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequirements that must be true before a table is scanned in discovery for the first time. There is an AND relationship between the top-level attributes. Additionally, minimum conditions with an OR relationship that must be met before Cloud DLP scans a table can be set (like a minimum row count or a minimum table age).
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.
- created_after¶
BigQuery table must have been created after this date. Used to avoid backfilling.
- type_collection¶
Restrict discovery to categories of table types.
This field is a member of oneof
included_types.
- or_conditions¶
At least one of the conditions must be true for a table to be scanned.
- class OrConditions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThere is an OR relationship between these attributes. They are used to determine if a table should be scanned or not in Discovery.
- min_row_count¶
Minimum number of rows that should be present before Cloud DLP profiles a table
- Type
- min_age¶
Minimum age a table must have before Cloud DLP can profile it. Value must be 1 hour or greater.
- class google.cloud.dlp_v2.types.DiscoveryBigQueryFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetermines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID.
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.
- tables¶
A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID.
This field is a member of oneof
filter.
- other_tables¶
Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
This field is a member of oneof
filter.
- table_reference¶
The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference).
This field is a member of oneof
filter.
- class AllOtherBigQueryTables(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCatch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target.
- class google.cloud.dlp_v2.types.DiscoveryCloudSqlConditions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequirements that must be true before a table is profiled for the first time.
- database_engines¶
Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified.
- Type
MutableSequence[google.cloud.dlp_v2.types.DiscoveryCloudSqlConditions.DatabaseEngine]
- types¶
Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES].
- Type
MutableSequence[google.cloud.dlp_v2.types.DiscoveryCloudSqlConditions.DatabaseResourceType]
- class DatabaseEngine(value)[source]¶
Bases:
proto.enums.EnumThe database engines that should be profiled.
- Values:
- DATABASE_ENGINE_UNSPECIFIED (0):
Unused.
- ALL_SUPPORTED_DATABASE_ENGINES (1):
Include all supported database engines.
- MYSQL (2):
MySQL database.
- POSTGRES (3):
PostgreSQL database.
- class DatabaseResourceType(value)[source]¶
Bases:
proto.enums.EnumCloud SQL database resource types. New values can be added at a later time.
- Values:
- DATABASE_RESOURCE_TYPE_UNSPECIFIED (0):
Unused.
- DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES (1):
Includes database resource types that become supported at a later time.
- DATABASE_RESOURCE_TYPE_TABLE (2):
Tables.
- class google.cloud.dlp_v2.types.DiscoveryCloudSqlFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetermines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name.
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.
- collection¶
A specific set of database resources for this filter to apply to.
This field is a member of oneof
filter.
- others¶
Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
This field is a member of oneof
filter.
- class google.cloud.dlp_v2.types.DiscoveryCloudSqlGenerationCadence(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHow often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity.
- schema_modified_cadence¶
When to reprofile if the schema has changed.
- refresh_frequency¶
Data changes (non-schema changes) in Cloud SQL tables can’t trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changed. Defaults to never.
- inspect_template_modified_cadence¶
Governs when to update data profiles when the inspection rules defined by the
InspectTemplatechange. If not set, changing the template will not cause a data profile to update.
- class SchemaModifiedCadence(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHow frequently to modify the profile when the table’s schema is modified.
- types¶
The types of schema modifications to consider. Defaults to NEW_COLUMNS.
- frequency¶
Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.
- class CloudSqlSchemaModification(value)[source]¶
Bases:
proto.enums.EnumThe type of modification that causes a profile update.
- Values:
- SQL_SCHEMA_MODIFICATION_UNSPECIFIED (0):
Unused.
- NEW_COLUMNS (1):
New columns have appeared.
- REMOVED_COLUMNS (2):
Columns have been removed from the table.
- class google.cloud.dlp_v2.types.DiscoveryCloudStorageConditions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequirements that must be true before a Cloud Storage bucket or object is scanned in discovery for the first time. There is an AND relationship between the top-level attributes.
- included_object_attributes¶
Required. Only objects with the specified attributes will be scanned. If an object has one of the specified attributes but is inside an excluded bucket, it will not be scanned. Defaults to [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no objects match the included_object_attributes.
- Type
MutableSequence[google.cloud.dlp_v2.types.DiscoveryCloudStorageConditions.CloudStorageObjectAttribute]
- included_bucket_attributes¶
Required. Only objects with the specified attributes will be scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset.
- Type
MutableSequence[google.cloud.dlp_v2.types.DiscoveryCloudStorageConditions.CloudStorageBucketAttribute]
- class CloudStorageBucketAttribute(value)[source]¶
Bases:
proto.enums.EnumThe attribute of a bucket.
- Values:
- CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED (0):
Unused.
- ALL_SUPPORTED_BUCKETS (1):
Scan buckets regardless of the attribute.
- AUTOCLASS_DISABLED (2):
Buckets with autoclass disabled (https://cloud.google.com/storage/docs/autoclass). Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set.
- AUTOCLASS_ENABLED (3):
Buckets with autoclass enabled (https://cloud.google.com/storage/docs/autoclass). Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning Autoclass-enabled buckets can affect object storage classes.
- class CloudStorageObjectAttribute(value)[source]¶
Bases:
proto.enums.EnumThe attribute of an object. See https://cloud.google.com/storage/docs/storage-classes for more information on storage classes.
- Values:
- CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED (0):
Unused.
- ALL_SUPPORTED_OBJECTS (1):
Scan objects regardless of the attribute.
- STANDARD (2):
Scan objects with the standard storage class.
- NEARLINE (3):
Scan objects with the nearline storage class. This will incur retrieval fees.
- COLDLINE (4):
Scan objects with the coldline storage class. This will incur retrieval fees.
- ARCHIVE (5):
Scan objects with the archive storage class. This will incur retrieval fees.
- REGIONAL (6):
Scan objects with the regional storage class.
- MULTI_REGIONAL (7):
Scan objects with the multi-regional storage class.
- DURABLE_REDUCED_AVAILABILITY (8):
Scan objects with the dual-regional storage class. This will incur retrieval fees.
- class google.cloud.dlp_v2.types.DiscoveryCloudStorageFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetermines which buckets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID and bucket name.
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.
- collection¶
Optional. A specific set of buckets for this filter to apply to.
This field is a member of oneof
filter.
- cloud_storage_resource_reference¶
Optional. The bucket to scan. Targets including this can only include one target (the target with this bucket). This enables profiling the contents of a single bucket, while the other options allow for easy profiling of many bucets within a project or an organization.
This field is a member of oneof
filter.
- class google.cloud.dlp_v2.types.DiscoveryCloudStorageGenerationCadence(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHow often existing buckets should have their profiles refreshed. New buckets are scanned as quickly as possible depending on system capacity.
- refresh_frequency¶
Optional. Data changes in Cloud Storage can’t trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never.
- inspect_template_modified_cadence¶
Optional. Governs when to update data profiles when the inspection rules defined by the
InspectTemplatechange. If not set, changing the template will not cause a data profile to update.
- class google.cloud.dlp_v2.types.DiscoveryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project.
The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).
- name¶
Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example
projects/dlp-test-project/locations/global/discoveryConfigs/53234423.- Type
- org_config¶
Only set when the parent is an org.
- other_cloud_starting_location¶
Must be set only when scanning other clouds.
- inspect_templates¶
Detection logic for profile generation.
Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery.
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/sensitive-data-protection/docs/data-profiles#data-residency.
- Type
MutableSequence[str]
- actions¶
Actions to execute at the completion of scanning.
- Type
MutableSequence[google.cloud.dlp_v2.types.DataProfileAction]
- targets¶
Target to match against for determining what to scan and how frequently.
- Type
MutableSequence[google.cloud.dlp_v2.types.DiscoveryTarget]
- errors¶
Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.
- Type
MutableSequence[google.cloud.dlp_v2.types.Error]
- create_time¶
Output only. The creation timestamp of a DiscoveryConfig.
- update_time¶
Output only. The last update timestamp of a DiscoveryConfig.
- last_run_time¶
Output only. The timestamp of the last time this config was executed.
- status¶
Required. A status for this configuration.
- class OrgConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageProject and scan location information. Only set when the parent is an org.
- location¶
The data to scan: folder, org, or project
- class Status(value)[source]¶
Bases:
proto.enums.EnumWhether the discovery config is currently active. New options may be added at a later time.
- Values:
- STATUS_UNSPECIFIED (0):
Unused
- RUNNING (1):
The discovery config is currently active.
- PAUSED (2):
The discovery config is paused temporarily.
- class google.cloud.dlp_v2.types.DiscoveryFileStoreConditions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequirements that must be true before a file store is scanned in discovery for the first time. There is an AND relationship between the top-level attributes.
- created_after¶
Optional. File store must have been created after this date. Used to avoid backfilling.
- min_age¶
Optional. Minimum age a file store must have. If set, the value must be 1 hour or greater.
- class google.cloud.dlp_v2.types.DiscoveryGenerationCadence(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWhat must take place for a profile to be updated and how frequently it should occur. New tables are scanned as quickly as possible depending on system capacity.
- schema_modified_cadence¶
Governs when to update data profiles when a schema is modified.
- table_modified_cadence¶
Governs when to update data profiles when a table is modified.
- inspect_template_modified_cadence¶
Governs when to update data profiles when the inspection rules defined by the
InspectTemplatechange. If not set, changing the template will not cause a data profile to update.
- refresh_frequency¶
Frequency at which profiles should be updated, regardless of whether the underlying resource has changed. Defaults to never.
- class google.cloud.dlp_v2.types.DiscoveryInspectTemplateModifiedCadence(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe cadence at which to update data profiles when the inspection rules defined by the
InspectTemplatechange.- frequency¶
How frequently data profiles can be updated when the template is modified. Defaults to never.
- class google.cloud.dlp_v2.types.DiscoveryOtherCloudConditions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequirements that must be true before a resource is profiled for the first time.
- min_age¶
Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater.
- class google.cloud.dlp_v2.types.DiscoveryOtherCloudFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetermines which resources from the other cloud will have profiles generated. Includes the ability to filter by resource names.
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.
- collection¶
A collection of resources for this filter to apply to.
This field is a member of oneof
filter.
- single_resource¶
The resource to scan. Configs using this filter can only have one target (the target with this single resource reference).
This field is a member of oneof
filter.
- class google.cloud.dlp_v2.types.DiscoveryOtherCloudGenerationCadence(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHow often existing resources should have their profiles refreshed. New resources are scanned as quickly as possible depending on system capacity.
- refresh_frequency¶
Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never.
- inspect_template_modified_cadence¶
Optional. Governs when to update data profiles when the inspection rules defined by the
InspectTemplatechange. If not set, changing the template will not cause a data profile to update.
- class google.cloud.dlp_v2.types.DiscoverySchemaModifiedCadence(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe cadence at which to update data profiles when a schema is modified.
- types¶
The type of events to consider when deciding if the table’s schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS.
- Type
MutableSequence[google.cloud.dlp_v2.types.BigQuerySchemaModification]
- frequency¶
How frequently profiles may be updated when schemas are modified. Defaults to monthly.
- class google.cloud.dlp_v2.types.DiscoveryStartingLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe location to begin a discovery scan. Denotes an organization ID or folder ID within an organization.
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.DiscoveryTableModifiedCadence(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe cadence at which to update data profiles when a table is modified.
- types¶
The type of events to consider when deciding if the table has been modified and should have the profile updated. Defaults to MODIFIED_TIMESTAMP.
- Type
MutableSequence[google.cloud.dlp_v2.types.BigQueryTableModification]
- frequency¶
How frequently data profiles can be updated when tables are modified. Defaults to never.
- class google.cloud.dlp_v2.types.DiscoveryTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTarget used to match against for Discovery.
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.
- big_query_target¶
BigQuery target for Discovery. The first target to match a table will be the one applied.
This field is a member of oneof
target.
- cloud_sql_target¶
Cloud SQL target for Discovery. The first target to match a table will be the one applied.
This field is a member of oneof
target.
- secrets_target¶
Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed.
This field is a member of oneof
target.
- cloud_storage_target¶
Cloud Storage target for Discovery. The first target to match a table will be the one applied.
This field is a member of oneof
target.
- 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.
- last_modified¶
Time when the job was last modified by the system.
- 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]
- action_details¶
Events that should occur after the job has completed.
- Type
MutableSequence[google.cloud.dlp_v2.types.ActionDetails]
- 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. List includes the oldest timestamp and the last 9 timestamps.
- Type
MutableSequence[google.protobuf.timestamp_pb2.Timestamp]
- extra_info¶
Additional information about the error.
- class ErrorExtraInfo(value)[source]¶
Bases:
proto.enums.EnumAdditional information about the error.
- Values:
- ERROR_INFO_UNSPECIFIED (0):
Unused.
- IMAGE_SCAN_UNAVAILABLE_IN_REGION (1):
Image scan is not available in the region.
- FILE_STORE_CLUSTER_UNSUPPORTED (2):
File store cluster is not supported for profile generation.
- 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 it belongs to a BigQuery column that 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.FileClusterSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe file cluster summary.
- file_cluster_type¶
The file cluster type.
- file_store_info_type_summaries¶
InfoTypes detected in this cluster.
- Type
MutableSequence[google.cloud.dlp_v2.types.FileStoreInfoTypeSummary]
- sensitivity_score¶
The sensitivity score of this cluster. The score will be SENSITIVITY_LOW if nothing has been scanned.
- data_risk_level¶
The data risk level of this cluster. RISK_LOW if nothing has been scanned.
- errors¶
A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster.
- Type
MutableSequence[google.cloud.dlp_v2.types.Error]
- file_extensions_scanned¶
A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content.
- Type
MutableSequence[google.cloud.dlp_v2.types.FileExtensionInfo]
- file_extensions_seen¶
A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content.
- Type
MutableSequence[google.cloud.dlp_v2.types.FileExtensionInfo]
- class google.cloud.dlp_v2.types.FileClusterType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage used to identify file cluster type being profiled.
- class Cluster(value)[source]¶
Bases:
proto.enums.EnumCluster type. Each cluster corresponds to a set of file types. Over time, new types may be added and files may move between clusters.
- Values:
- CLUSTER_UNSPECIFIED (0):
Unused.
- CLUSTER_UNKNOWN (1):
Unsupported files.
- CLUSTER_TEXT (2):
Plain text.
- CLUSTER_STRUCTURED_DATA (3):
Structured data like CSV, TSV etc.
- CLUSTER_SOURCE_CODE (4):
Source code.
- CLUSTER_RICH_DOCUMENT (5):
Rich document like docx, xlsx etc.
- CLUSTER_IMAGE (6):
Images like jpeg, bmp.
- CLUSTER_ARCHIVE (7):
Archives and containers like .zip, .tar etc.
- CLUSTER_MULTIMEDIA (8):
Multimedia like .mp4, .avi etc.
- CLUSTER_EXECUTABLE (9):
Executable files like .exe, .class, .apk etc.
- class google.cloud.dlp_v2.types.FileExtensionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation regarding the discovered file extension.
- class google.cloud.dlp_v2.types.FileStoreCollection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMatch file stores (e.g. buckets) using regex filters.
- class google.cloud.dlp_v2.types.FileStoreDataProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe profile for a file store.
Cloud Storage: maps 1:1 with a bucket.
Amazon S3: maps 1:1 with a bucket.
- data_source_type¶
The resource type that was profiled.
- project_id¶
The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.
- Type
- file_store_location¶
The location of the file store.
Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations
Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints
- Type
- data_storage_locations¶
For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage.
file_store_locationwill normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile.- Type
MutableSequence[str]
- location_type¶
The location type of the bucket (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.
- Type
- file_store_path¶
The file store path.
Cloud Storage:
gs://{bucket}Amazon S3:
s3://{bucket}
- Type
- full_resource¶
The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name
Example format of an S3 bucket full resource name:
//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}- Type
- config_snapshot¶
The snapshot of the configurations used to generate the profile.
- 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.
- profile_last_generated¶
The last time the profile was generated.
- resource_visibility¶
How broadly a resource has been shared.
- sensitivity_score¶
The sensitivity score of this resource.
- data_risk_level¶
The data risk level of this resource.
- create_time¶
The time the file store was first created.
- last_modified_time¶
The time the file store was last modified.
- file_cluster_summaries¶
FileClusterSummary per each cluster.
- Type
MutableSequence[google.cloud.dlp_v2.types.FileClusterSummary]
- resource_attributes¶
Attributes of the resource being profiled. Currently used attributes:
customer_managed_encryption: boolean
true: the resource is encrypted with a customer-managed key.
false: the resource is encrypted with a provider-managed key.
- Type
MutableMapping[str, google.cloud.dlp_v2.types.Value]
- resource_labels¶
The labels applied to the resource at the time the profile was generated.
- file_store_info_type_summaries¶
InfoTypes detected in this file store.
- Type
MutableSequence[google.cloud.dlp_v2.types.FileStoreInfoTypeSummary]
- class ResourceAttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- 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.FileStoreInfoTypeSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInformation regarding the discovered InfoType.
- info_type¶
The InfoType seen.
- class google.cloud.dlp_v2.types.FileStoreRegex(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA pattern to match against one or more file stores.
- class google.cloud.dlp_v2.types.FileStoreRegexes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA collection of regular expressions to determine what file store to match against.
- patterns¶
Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression’s length can’t exceed 10 KiB.
- Type
MutableSequence[google.cloud.dlp_v2.types.FileStoreRegex]
- 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 file types 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, jsonl, 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. Setting [bytes_limit_per_file][google.privacy.dlp.v2.CloudStorageOptions.bytes_limit_per_file] or [bytes_limit_per_file_percent][google.privacy.dlp.v2.CloudStorageOptions.bytes_limit_per_file] has no effect on image files. Image inspection is restricted to the
global,us,asia, andeuroperegions.- WORD (5):
Microsoft Word files larger than 30 MB will be scanned as binary files. Included file extensions: docx, dotx, docm, dotm. Setting
bytes_limit_per_fileorbytes_limit_per_file_percenthas no effect on Word files.- PDF (6):
PDF files larger than 30 MB will be scanned as binary files. Included file extensions: pdf. Setting
bytes_limit_per_fileorbytes_limit_per_file_percenthas no effect on PDF files.- AVRO (7):
Included file extensions:
avro
- CSV (8):
Included file extensions:
csv
- TSV (9):
Included file extensions:
tsv
- POWERPOINT (11):
Microsoft PowerPoint files larger than 30 MB will be scanned as binary files. Included file extensions: pptx, pptm, potx, potm, pot. Setting
bytes_limit_per_fileorbytes_limit_per_file_percenthas no effect on PowerPoint files.- EXCEL (12):
Microsoft Excel files larger than 30 MB will be scanned as binary files. Included file extensions: xlsx, xlsm, xltx, xltm. Setting
bytes_limit_per_fileorbytes_limit_per_file_percenthas no effect on Excel files.
- 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/sensitive-data-protection/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.GetColumnDataProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to get a column data profile.
- class google.cloud.dlp_v2.types.GetConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetConnection.
- 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.GetDiscoveryConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetDiscoveryConfig.
- 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.GetFileStoreDataProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to get a file store data profile.
- 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.GetProjectDataProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to get a project data profile.
- 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.GetTableDataProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to get a table data profile.
- 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¶
List of transforms to make.
- 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/sensitive-data-protection/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
- sensitivity_score¶
Optional custom sensitivity for this InfoType. This only applies to data profiling.
- 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.
- ARMENIA (51):
The infoType is typically used in Armenia.
- AUSTRALIA (3):
The infoType is typically used in Australia.
- AZERBAIJAN (48):
The infoType is typically used in Azerbaijan.
- BELARUS (50):
The infoType is typically used in Belarus.
- 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.
- CROATIA (42):
The infoType is typically used in Croatia.
- 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.
- KAZAKHSTAN (47):
The infoType is typically used in Kazakhstan.
- 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.
- NEW_ZEALAND (41):
The infoType is typically used in New Zealand.
- 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.
- RUSSIA (44):
The infoType is typically used in Russia.
- 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.
- SWITZERLAND (43):
The infoType is typically used in Switzerland.
- 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.
- UKRAINE (45):
The infoType is typically used in Ukraine.
- 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.
- UZBEKISTAN (46):
The infoType is typically used in Uzbekistan.
- VENEZUELA (39):
The infoType is typically used in Venezuela.
- INTERNAL (40):
The infoType is typically used in Google internally.
- 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]
- sensitivity_score¶
The default sensitivity of the infoType.
- 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/sensitive-data-protection/docs/infotypes-reference.
When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time.
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 to or above this threshold. The default is POSSIBLE.
In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see Match likelihood.
- min_likelihood_per_info_type¶
Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood.
- Type
MutableSequence[google.cloud.dlp_v2.types.InspectConfig.InfoTypeLikelihood]
- 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.
When set within an [InspectJobConfig][google.privacy.dlp.v2.InspectJobConfig], the specified maximum values aren’t hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values.
- 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/sensitive-data-protection/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 are returned for each item scanned.
When set within an [InspectContentRequest][google.privacy.dlp.v2.InspectContentRequest], this field is ignored.
This value isn’t a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value.
- Type
- max_findings_per_request¶
Max number of findings that are returned per request or job.
If you set this field in an [InspectContentRequest][google.privacy.dlp.v2.InspectContentRequest], the resulting maximum value is the value that you set or 3,000, whichever is lower.
This value isn’t a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value.
- 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 InfoTypeLikelihood(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for setting a minimum likelihood per infotype. Used to customize the minimum likelihood level for specific infotypes in the request. For example, use this if you want to lower the precision for PERSON_NAME without lowering the precision for the other infotypes in the request.
- info_type¶
Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails.
- min_likelihood¶
Only returns findings equal to or above this threshold. This field is required or else the configuration fails.
- 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_id}Projects 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]
- num_rows_processed¶
Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).
- Type
- 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/sensitive-data-protection/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 API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/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.
- Type