Package Classes (3.31.0)

Sensitive Data Protection provides access to a powerful sensitive data inspection, classification, and de-identification platform that works on text, images, and Google Cloud storage repositories. To learn more about concepts and find how-to guides see https://cloud.google.com/sensitive-data-protection/docs/.

Sensitive Data Protection provides access to a powerful sensitive data inspection, classification, and de-identification platform that works on text, images, and Google Cloud storage repositories. To learn more about concepts and find how-to guides see https://cloud.google.com/sensitive-data-protection/docs/.

A pager for iterating through list_column_data_profiles requests.

This class thinly wraps an initial ListColumnDataProfilesResponse object, and provides an __aiter__ method to iterate through its column_data_profiles field.

If there are more pages, the __aiter__ method will make additional ListColumnDataProfiles requests and continue to iterate through the column_data_profiles field on the corresponding responses.

All the usual ListColumnDataProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_column_data_profiles requests.

This class thinly wraps an initial ListColumnDataProfilesResponse object, and provides an __iter__ method to iterate through its column_data_profiles field.

If there are more pages, the __iter__ method will make additional ListColumnDataProfiles requests and continue to iterate through the column_data_profiles field on the corresponding responses.

All the usual ListColumnDataProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_connections requests.

This class thinly wraps an initial ListConnectionsResponse object, and provides an __aiter__ method to iterate through its connections field.

If there are more pages, the __aiter__ method will make additional ListConnections requests and continue to iterate through the connections field on the corresponding responses.

All the usual ListConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_connections requests.

This class thinly wraps an initial ListConnectionsResponse object, and provides an __iter__ method to iterate through its connections field.

If there are more pages, the __iter__ method will make additional ListConnections requests and continue to iterate through the connections field on the corresponding responses.

All the usual ListConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_deidentify_templates requests.

This class thinly wraps an initial ListDeidentifyTemplatesResponse object, and provides an __aiter__ method to iterate through its deidentify_templates field.

If there are more pages, the __aiter__ method will make additional ListDeidentifyTemplates requests and continue to iterate through the deidentify_templates field on the corresponding responses.

All the usual ListDeidentifyTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_deidentify_templates requests.

This class thinly wraps an initial ListDeidentifyTemplatesResponse object, and provides an __iter__ method to iterate through its deidentify_templates field.

If there are more pages, the __iter__ method will make additional ListDeidentifyTemplates requests and continue to iterate through the deidentify_templates field on the corresponding responses.

All the usual ListDeidentifyTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_discovery_configs requests.

This class thinly wraps an initial ListDiscoveryConfigsResponse object, and provides an __aiter__ method to iterate through its discovery_configs field.

If there are more pages, the __aiter__ method will make additional ListDiscoveryConfigs requests and continue to iterate through the discovery_configs field on the corresponding responses.

All the usual ListDiscoveryConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_discovery_configs requests.

This class thinly wraps an initial ListDiscoveryConfigsResponse object, and provides an __iter__ method to iterate through its discovery_configs field.

If there are more pages, the __iter__ method will make additional ListDiscoveryConfigs requests and continue to iterate through the discovery_configs field on the corresponding responses.

All the usual ListDiscoveryConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_dlp_jobs requests.

This class thinly wraps an initial ListDlpJobsResponse object, and provides an __aiter__ method to iterate through its jobs field.

If there are more pages, the __aiter__ method will make additional ListDlpJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual ListDlpJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_dlp_jobs requests.

This class thinly wraps an initial ListDlpJobsResponse object, and provides an __iter__ method to iterate through its jobs field.

If there are more pages, the __iter__ method will make additional ListDlpJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual ListDlpJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_file_store_data_profiles requests.

This class thinly wraps an initial ListFileStoreDataProfilesResponse object, and provides an __aiter__ method to iterate through its file_store_data_profiles field.

If there are more pages, the __aiter__ method will make additional ListFileStoreDataProfiles requests and continue to iterate through the file_store_data_profiles field on the corresponding responses.

All the usual ListFileStoreDataProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_file_store_data_profiles requests.

This class thinly wraps an initial ListFileStoreDataProfilesResponse object, and provides an __iter__ method to iterate through its file_store_data_profiles field.

If there are more pages, the __iter__ method will make additional ListFileStoreDataProfiles requests and continue to iterate through the file_store_data_profiles field on the corresponding responses.

All the usual ListFileStoreDataProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_inspect_templates requests.

This class thinly wraps an initial ListInspectTemplatesResponse object, and provides an __aiter__ method to iterate through its inspect_templates field.

If there are more pages, the __aiter__ method will make additional ListInspectTemplates requests and continue to iterate through the inspect_templates field on the corresponding responses.

All the usual ListInspectTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_inspect_templates requests.

This class thinly wraps an initial ListInspectTemplatesResponse object, and provides an __iter__ method to iterate through its inspect_templates field.

If there are more pages, the __iter__ method will make additional ListInspectTemplates requests and continue to iterate through the inspect_templates field on the corresponding responses.

All the usual ListInspectTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_job_triggers requests.

This class thinly wraps an initial ListJobTriggersResponse object, and provides an __aiter__ method to iterate through its job_triggers field.

If there are more pages, the __aiter__ method will make additional ListJobTriggers requests and continue to iterate through the job_triggers field on the corresponding responses.

All the usual ListJobTriggersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_job_triggers requests.

This class thinly wraps an initial ListJobTriggersResponse object, and provides an __iter__ method to iterate through its job_triggers field.

If there are more pages, the __iter__ method will make additional ListJobTriggers requests and continue to iterate through the job_triggers field on the corresponding responses.

All the usual ListJobTriggersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_project_data_profiles requests.

This class thinly wraps an initial ListProjectDataProfilesResponse object, and provides an __aiter__ method to iterate through its project_data_profiles field.

If there are more pages, the __aiter__ method will make additional ListProjectDataProfiles requests and continue to iterate through the project_data_profiles field on the corresponding responses.

All the usual ListProjectDataProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_project_data_profiles requests.

This class thinly wraps an initial ListProjectDataProfilesResponse object, and provides an __iter__ method to iterate through its project_data_profiles field.

If there are more pages, the __iter__ method will make additional ListProjectDataProfiles requests and continue to iterate through the project_data_profiles field on the corresponding responses.

All the usual ListProjectDataProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_stored_info_types requests.

This class thinly wraps an initial ListStoredInfoTypesResponse object, and provides an __aiter__ method to iterate through its stored_info_types field.

If there are more pages, the __aiter__ method will make additional ListStoredInfoTypes requests and continue to iterate through the stored_info_types field on the corresponding responses.

All the usual ListStoredInfoTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_stored_info_types requests.

This class thinly wraps an initial ListStoredInfoTypesResponse object, and provides an __iter__ method to iterate through its stored_info_types field.

If there are more pages, the __iter__ method will make additional ListStoredInfoTypes requests and continue to iterate through the stored_info_types field on the corresponding responses.

All the usual ListStoredInfoTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_table_data_profiles requests.

This class thinly wraps an initial ListTableDataProfilesResponse object, and provides an __aiter__ method to iterate through its table_data_profiles field.

If there are more pages, the __aiter__ method will make additional ListTableDataProfiles requests and continue to iterate through the table_data_profiles field on the corresponding responses.

All the usual ListTableDataProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_table_data_profiles requests.

This class thinly wraps an initial ListTableDataProfilesResponse object, and provides an __iter__ method to iterate through its table_data_profiles field.

If there are more pages, the __iter__ method will make additional ListTableDataProfiles requests and continue to iterate through the table_data_profiles field on the corresponding responses.

All the usual ListTableDataProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_connections requests.

This class thinly wraps an initial SearchConnectionsResponse object, and provides an __aiter__ method to iterate through its connections field.

If there are more pages, the __aiter__ method will make additional SearchConnections requests and continue to iterate through the connections field on the corresponding responses.

All the usual SearchConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_connections requests.

This class thinly wraps an initial SearchConnectionsResponse object, and provides an __iter__ method to iterate through its connections field.

If there are more pages, the __iter__ method will make additional SearchConnections requests and continue to iterate through the connections field on the corresponding responses.

All the usual SearchConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets.

A TransformationDetail will be created for each transformation.

Compatible with: Inspection of Cloud Storage

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts <https://cloud.google.com/resource-manager/docs/managing-notification-contacts>__.

Publish 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.tagTemplateOwner permission 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 <https://cloud.google.com/terms/service-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

Publish the result summary of a DlpJob to Security Command Center <https://cloud.google.com/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 <https://cloud.google.com/terms/service-terms>. Only a single instance of this action can be specified. Compatible with: Inspect

Publish 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

Enable 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'.

If 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

The results of an Action][google.privacy.dlp.v2.Action].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for ActivateJobTrigger.

Match database resources not covered by any other filter.

Match discovery resources not covered by any other filter.

Amazon S3 bucket.

Amazon S3 bucket conditions.

Supported Amazon S3 bucket types. Defaults to TYPE_ALL_SUPPORTED.

Supported Amazon S3 object storage classes. Defaults to ALL_SUPPORTED_CLASSES.

Amazon S3 bucket regex.

Result 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Result of the categorical stats computation.

Histogram of value frequencies in the column.

Result of the δ-presence computation. Note that these results are an estimation, not exact values.

A 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.

A tuple of values for the quasi-identifier columns.

Result of the k-anonymity computation.

The set of columns' values that share the same ldiversity value

Histogram of k-anonymity equivalence classes.

Result of the reidentifiability analysis. Note that these results are an estimation, not exact values.

A 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.

A tuple of values for the quasi-identifier columns.

Result of the l-diversity computation.

The set of columns' values that share the same ldiversity value.

Histogram of l-diversity equivalence class sensitive value frequencies.

Result of the numerical stats computation.

Risk analysis options.

AWS account.

AWS account regex.

Target 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message defining a field of a BigQuery table.

Row key for identifying a record in BigQuery table.

Options defining BigQuery table and row identifiers.

How 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.

A 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 <https://github.com/google/re2/wiki/Syntax>__; a guide can be found under the google/re2 repository on GitHub.

A collection of regular expressions to determine what tables to match against.

Attributes evaluated to determine if a schema has been modified. New values may be added at a later time.

Message 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>.

Specifies a collection of BigQuery tables. Used for Discovery.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes evaluated to determine if a table has been modified. New values may be added at a later time.

Over time new types may be added. Currently VIEW, MATERIALIZED_VIEW, and non-BigLake external tables are not supported.

Over time new types may be added. Currently VIEW, MATERIALIZED_VIEW, and non-BigLake external tables are not supported.

The types of BigQuery tables supported by Cloud DLP.

Bounding box encompassing detected text within an image.

Generalization 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 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.

Bucket is represented as a range, along with replacement values.

Container for bytes to inspect or redact.

The type of data being sent for inspection. To learn more, see Supported file types <https://cloud.google.com/sensitive-data-protection/docs/supported-file-types>__.

Only the first frame of each multiframe image is inspected. Metadata and other frames aren't inspected.

The request message for canceling a DLP job.

Partially 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.

Characters 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Convenience enum for indicating common characters to not transform.

Target 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Use 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.

Cloud 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Database engine of a Cloud SQL instance. New values may be added over time.

Target 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message representing a set of files in Cloud Storage.

Options defining a file or a set of files within a Cloud Storage bucket.

Set of files to scan.

How 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.

Message representing a single file or path in Cloud Storage.

A pattern to match against one or more file stores. At least one pattern must be specified. Regular expressions use RE2 syntax <https://github.com/google/re2/wiki/Syntax>__; a guide can be found under the google/re2 repository on GitHub.

Message 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_regex and do not match any items in exclude_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/myfile will be included
• gs://mybucket/directory1/directory2/myfile will be included (.* matches across /)
• gs://mybucket/directory0/directory1/myfile will not be included (the full path doesn't match any items in include_regex)
• gs://mybucket/directory1/excludedfile will not be included (the path matches an item in exclude_regex)

If include_regex is left empty, it will match all files by default (this is equivalent to setting include_regex: [".*"]).

Some other common use cases:

• {bucket_name: "mybucket", exclude_regex: [".*\.pdf"]} will include all files in mybucket except for .pdf files
• {bucket_name: "mybucket", include_regex: ["directory/[^/]+"]} will include all files directly under gs://mybucket/directory/, without matching across /

Identifies a single Cloud Storage bucket.

Represents a color in the RGB color space.

The profile for a scanned column within a table.

Data types of the data in a column. Types may be added over time.

The possible policy states for a column.

Possible states of a profile. New items may be added.

A data connection to allow the DLP API to profile data in locations that require additional configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State of the connection. New values may be added over time.

 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. 

Represents a container that may contain DLP findings. Examples of a container include a file, table, or database record.

Type 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Precise 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Deprecated and unused.

Request message for CreateConnection.

Request message for CreateDeidentifyTemplate.

Request message for CreateDiscoveryConfig.

Request 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for CreateInspectTemplate.

Request message for CreateJobTrigger.

Request message for CreateStoredInfoType.

Pseudonymization 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.

Pseudonymization 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.

This 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the ReidentifyContent API 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. FPE incurs significant latency costs.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

These 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.

Custom 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Deprecated; use InspectionRuleSet instead. Rule for modifying a CustomInfoType to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the surrogate_type custom infoType.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The rule that adjusts the likelihood of findings within a certain proximity of hotwords.

Message 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message for specifying a window around a finding to apply a detection rule.

Custom 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 <https://en.wikipedia.org/wiki/Plane_%28Unicode%29#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 <https://cloud.google.com/sensitive-data-protection/limits>__ page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using LargeCustomDictionaryConfig in the StoredInfoType API.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message defining a list of words or phrases to search for in the data.

Type of exclusion rule.

Message defining a custom regular expression.

Message 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`.

A 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Types of event that can trigger an action.

If set, the detailed data profiles will be persisted to the location of your choice whenever updated.

Send 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.

The levels of detail that can be included in the Pub/Sub message.

Message expressing intention to publish to Google Security Operations.

Create Dataplex Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects.

If set, a summary finding will be created or updated in Security Command Center for each profile.

If set, attaches the tags provided to profiled resources. Tags support access control <https://cloud.google.com/iam/docs/tags-access-control>__. You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.

The tag to attach to profiles matching the condition. At most one TagCondition can be specified per sensitivity level.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A value of a tag.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The schema of data to be saved to the BigQuery table when the DataProfileAction is 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Snapshot of the configurations used to generate the profile.

Details about a piece of potentially sensitive information that was detected when the data resource was profiled.

Location of a data profile finding within a resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Location of a finding within a resource that produces a table data profile.

Configuration 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.

The 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A condition for determining whether a Pub/Sub should be triggered.

Various score levels for resources.

A 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

An expression, consisting of an operator and conditions.

Logical operators for conditional checks.

Pub/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.

How frequently data profiles can be updated. New options can be added at a later time.

Score is a summary of all elements in the data profile. A higher number means more risk.

Various score levels for resources.

Message used to identify the type of resource being profiled.

Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Identifies a single database resource, like a table within a database.

A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 syntax <https://github.com/google/re2/wiki/Syntax>__; a guide can be found under the google/re2 repository on GitHub.

A collection of regular expressions to determine what database resources to match against.

Record key for a finding in Cloud Datastore.

Options defining a data set within Google Cloud Datastore.

Shifts 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message for a date time object. e.g. 2018-01-01, 5th August.

Time zone of the date time object.

The 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request to de-identify a ContentItem.

Results of de-identifying a ContentItem.

The results of a Deidentify][google.privacy.dlp.v2.Action.Deidentify] action from an inspect job.

De-identification options.

Summary of what was modified during a transformation.

DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.

Request message for DeleteConnection.

Request message for DeleteDeidentifyTemplate.

Request message for DeleteDiscoveryConfig.

The request message for deleting a DLP job.

Request message for DeleteFileStoreProfile.

Request message for DeleteInspectTemplate.

Request message for DeleteJobTrigger.

Request message for DeleteStoredInfoType.

Request message for DeleteTableProfile.

Do not profile the tables.

Requirements 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

There is an OR relationship between these attributes. They are used to determine if a table should be scanned or not in Discovery.

Determines 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Catch-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.

Requirements that must be true before a table is profiled for the first time.

The database engines that should be profiled.

Cloud SQL database resource types. New values can be added at a later time.

Determines 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity.

How frequently to modify the profile when the table's schema is modified.

The type of modification that causes a profile update.

Requirements 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.

The attribute of a bucket.

The attribute of an object. See https://cloud.google.com/storage/docs/storage-classes for more information on storage classes.

Determines 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

How often existing buckets should have their profiles refreshed. New buckets are scanned as quickly as possible depending on system capacity.

Configuration 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.

Project and scan location information. Only set when the parent is an org.

Whether the discovery config is currently active. New options may be added at a later time.

Requirements 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

What 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.

The cadence at which to update data profiles when the inspection rules defined by the InspectTemplate change.

Requirements that must be true before a resource is profiled for the first time.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Determines 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

How often existing resources should have their profiles refreshed. New resources are scanned as quickly as possible depending on system capacity.

The cadence at which to update data profiles when a schema is modified.

The 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The cadence at which to update data profiles when a table is modified.

Target 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Requirements that must be true before a dataset is profiled for the first time.

Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity.

Combines 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Possible states of a job. New items may be added.

An enum to represent the various types of DLP jobs.

Location of a finding within a document.

How a resource is encrypted.

An entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the EntityId might 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.

Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.

Additional information about the error.

The 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.

List of excluded infoTypes.

The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

General identifier of a data field in a storage service.

The 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The file cluster summary.

Message used to identify file cluster type being profiled.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Cluster type. Each cluster corresponds to a set of file types. Over time, new types may be added and files may move between clusters.

Information regarding the discovered file extension.

Match file stores (e.g. buckets) using filters.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The profile for a file store.

• Cloud Storage: maps 1:1 with a bucket.
• Amazon S3: maps 1:1 with a bucket.

The abstract base class for a message.

The abstract base class for a message.

Possible states of a profile. New items may be added.

Information regarding the discovered InfoType.

A pattern to match against one or more file stores.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A collection of regular expressions to determine what file store to match against.

Definitions of file type groups to scan. New types will be added to this list.

 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`, and `europe` regions. 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_file` or `bytes_limit_per_file_percent` has 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_file` or `bytes_limit_per_file_percent` has 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_file` or `bytes_limit_per_file_percent` has 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_file` or `bytes_limit_per_file_percent` has no effect on Excel files. 

Represents a piece of potentially sensitive content.

The abstract base class for a message.

The request message for finishing a DLP hybrid job.

Buckets 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.

Request to get a column data profile.

Request message for GetConnection.

Request message for GetDeidentifyTemplate.

Request message for GetDiscoveryConfig.

The request message for GetDlpJob][google.privacy.dlp.v2.DlpService.GetDlpJob].

Request to get a file store data profile.

Request message for GetInspectTemplate.

Request message for GetJobTrigger.

Request to get a project data profile.

Request message for GetStoredInfoType.

Request to get a table data profile.

An individual hybrid item to inspect. Will be stored temporarily during processing.

Populate to associate additional data with each finding.

The abstract base class for a message.

Request to search for potentially sensitive info in a custom location.

Request to search for potentially sensitive info in a custom location.

Quota exceeded errors will be thrown once quota has been met.

Statistics related to processing hybrid inspect requests.

Configuration to control jobs where the content being inspected is outside of Google Cloud Platform.

The abstract base class for a message.

Location of the finding within an image.

A type of transformation that is applied over images.

Configuration 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Apply transformation to all findings.

Apply to all text.

Apply transformation to the selected info_types.

Type of information detected by the API.

Classification 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Enum of the current industries in the category. We might add more industries in the future.

Enum of the current locations. We might add more locations in the future.

Enum of the current types in the category. We might add more types in the future.

InfoType description.

Statistics regarding a specific InfoType.

The infoType details for this column.

Parts of the APIs which use certain infoTypes.

A type of transformation that will scan unstructured text and apply various PrimitiveTransformation\ s to each finding, where the transformation is applied to only values that were identified as a specific info_type.

A transformation to apply to text that is identified as a specific info_type.

Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.

Configuration 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 configuration per infoType, per content item or long running DlpJob.

Configuration 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.

Request to search for potentially sensitive info in a ContentItem.

Results of inspecting an item.

The results of an inspect DataSource job.

Snapshot of the inspection configuration.

All result fields mentioned below are updated while the job is processing.

Controls what and how to inspect for findings.

All the findings for a single scanned item.

The 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.

A 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.

Contains 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Whether 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.

What 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A 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.

A (kind, ID/name) pair used to construct a key path.

If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A representation of a Datastore kind.

Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt

For more information, see Creating a wrapped key.

Note: When you use Cloud KMS for cryptographic operations, charges apply <https://cloud.google.com/kms/pricing>__.

Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the limits <https://cloud.google.com/sensitive-data-protection/limits>__ page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using CustomInfoType.Dictionary for smaller dictionaries that satisfy the size requirements.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Summary statistics of a custom dictionary.

Coarse-grained confidence level of how well a particular finding satisfies the criteria to match a particular infoType.

Likelihood is calculated based on the number of signals a finding has that implies that the finding matches the infoType. For example, a string that has an '@' and a '.com' is more likely to be a match for an email address than a string that only has an '@'.

In general, the highest likelihood level has the strongest signals that indicate a match. That is, a finding with a high likelihood has a low chance of being a false positive.

For more information about each likelihood level and how likelihood works, see Match likelihood <https://cloud.google.com/sensitive-data-protection/docs/likelihood>__.

Request to list the profiles generated for a given organization or project.

List of profiles generated for a given organization or project.

Request message for ListConnections.

Response message for ListConnections.

Request message for ListDeidentifyTemplates.

Response message for ListDeidentifyTemplates.

Request message for ListDiscoveryConfigs.

Response message for ListDiscoveryConfigs.

The request message for listing DLP jobs.

The response message for listing DLP jobs.

Request to list the file store profiles generated for a given organization or project.

List of file store data profiles generated for a given organization or project.

Request for the list of infoTypes.

Response to the ListInfoTypes request.

Request message for ListInspectTemplates.

Response message for ListInspectTemplates.

Request message for ListJobTriggers.

Response message for ListJobTriggers.

Request to list the profiles generated for a given organization or project.

List of profiles generated for a given organization or project.

Request message for ListStoredInfoTypes.

Response message for ListStoredInfoTypes.

Request to list the profiles generated for a given organization or project.

List of profiles generated for a given organization or project.

Specifies the location of the finding.

Job trigger option for hybrid jobs. Jobs must be manually created and finished.

Type of the match which can be applied to different ways of matching, like Dictionary, regular expression and intersecting with findings of another info type.

 - Dictionary: join of Dictionary results matched complete finding quote - Regex: all regex matches fill a finding quote start to end - Exclude info type: completely inside affecting info types findings MATCHING_TYPE_PARTIAL_MATCH (2): Partial match. - Dictionary: at least one of the tokens in the finding matches - Regex: substring of the finding matches - Exclude info type: intersects with affecting info types findings MATCHING_TYPE_INVERSE_MATCH (3): Inverse match. - Dictionary: no tokens in the finding match the dictionary - Regex: finding doesn't match the regex - Exclude info type: no intersection with affecting info types findings 

Metadata Location

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Type of metadata containing the finding.

Bucketized nullness percentage levels. A higher level means a higher percentage of the column is null.

The other cloud starting location for discovery.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The AWS starting location 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Target used to match against for discovery of resources from other clouds. An AWS connector in Security Command Center (Enterprise <https://cloud.google.com/security-command-center/docs/connect-scc-to-aws>__ is required to use this feature.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Match resources using regex filters.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A pattern to match against one or more resources. At least one pattern must be specified. Regular expressions use RE2 syntax <https://github.com/google/re2/wiki/Syntax>__; a guide can be found under the google/re2 repository on GitHub.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A collection of regular expressions to determine what resources to match against.

Identifies a single resource, like a single Amazon S3 bucket.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Infotype details for other infoTypes found within a column.

Cloud repository for storing output.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Predefined schemas for storing findings. Only for use with external storage.

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.

A partition ID contains several dimensions:

project ID and namespace ID.

A rule for transforming a value.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Privacy metric to compute for reidentification risk analysis.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Compute numerical stats over an individual column, including number of distinct values and value count distribution.

δ-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute δ-presence exactly without knowing the attack dataset, so we use a statistical model instead.

k-anonymity metric, used for analysis of reidentification risk.

Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset.

An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).

A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.

A column with a semantic tag attached.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

l-diversity metric, used for analysis of reidentification risk.

Compute numerical stats over an individual column, including min, max, and quantiles.

Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided.

Processing will happen in the global region.

Configure image processing to fall back to the configured processing option below if unavailable in the request location.

Processing will happen in a multi-region that contains the current region if available.

Whether a profile being created is the first generation or an update.

Success or errors for the profile generation.

An aggregated profile for this project, based on the resources profiled within it.

A column with a semantic tag attached.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message for infoType-dependent details parsed from quote.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Generic half-open interval [start, end)

A condition for determining whether a transformation should be applied to a field.

The field type of value and field do not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. A value of type:

• string can be compared against all other types
• boolean can only be compared against other booleans
• integer can be compared against doubles or a string if the string value can be parsed as an integer.
• double can be compared against integers or a string if the string can be parsed as a double.
• Timestamp can be compared against strings in RFC 3339 date string format.
• TimeOfDay can be compared against timestamps and strings in the format of 'HH:mm:ss'.

If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false.

A collection of conditions.

An expression, consisting of an operator and conditions.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Logical operators for conditional checks.

Message for a unique key indicating a record that contains a finding.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Location of a finding within a row or record.

Configuration to suppress records whose suppression conditions evaluate to true.

The field in a record to transform.

A type of transformation that is applied over structured data such as a table.

Redact a given value. For example, if used with an InfoTypeTransformation transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '.

Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle.

Configuration 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Results of redacting an image.

Request to re-identify an item.

Results of re-identifying an item.

A related resource. Examples:

• The source BigQuery table for a Vertex AI dataset.
• The source Cloud Storage bucket for a Vertex AI dataset.

Operators available for comparing the value of fields.

Replace each input value with a value randomly selected from the dictionary.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Replace each input value with a given Value.

Replace each matching finding with the name of the info_type.

How broadly the data in the resource has been shared. New items may be added over time. A higher number means more restricted.

Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more.

Collection of findings saved to a Cloud Storage bucket. This is used as the proto schema for textproto files created when specifying a cloud storage path to save inspection findings.

Schedule for inspect job triggers.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for SearchConnections.

Response message for SearchConnections.

A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager charges apply <https://cloud.google.com/secret-manager/pricing>__.

Discovery target for credentials and secrets in cloud resource metadata.

This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily.

No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets).

Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center.

Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.

Various sensitivity score levels for resources.

An auxiliary table containing statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).

A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.

Shared message indicating Cloud storage type.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery.

Storage metadata label to indicate which metadata entry contains findings.

StoredInfoType resource message that contains information about the current version and any pending updates.

Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State of a StoredInfoType version.

Statistics for a StoredInfoType.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state.

A reference to a StoredInfoType to use with scanning.

Structured content to inspect. Up to 50,000 Value\ s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more.

Values of the row.

The profile for a scanned table.

The abstract base class for a message.

Possible states of a profile. New items may be added.

Location of a finding within a table.

Instructions regarding the table content being inspected.

Message defining the location of a BigQuery table with the projectId inferred from the parent project.

A tag associated with a resource.

For use with Date, Timestamp, and TimeOfDay, extract or preserve a portion of the value.

Components that make up time.

User specified templates and configs for how to deidentify structured, unstructures, and image files. User must provide either a unstructured deidentify template or at least one redact image config.

Describes functionality of a given container in its original format.

A flattened description of a PrimitiveTransformation or RecordSuppression.

Details about a single transformation. This object contains a description of the transformation, information about whether the transformation was successfully applied, and the precise location where the transformation occurred. These details are stored in a user-specified BigQuery table.

Config for storing transformation details.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

How to handle transformation errors during de-identification. A transformation error occurs when the requested transformation is incompatible with the data. For example, trying to de-identify an IP address using a DateShift transformation would result in a transformation error, since date info cannot be extracted from an IP address. Information about any incompatible transformations, and how they were handled, is returned in the response as part of the TransformationOverviews.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Skips the data without modifying it if the requested transformation would cause an error. For example, if a DateShift transformation were applied an an IP address, this mode would leave the IP address unchanged in the response.

Throw an error and fail the request when a transformation error occurs.

Specifies the location of a transformation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Overview of the modifications that occurred.

The outcome of a transformation.

Enum of possible outcomes of transformations. SUCCESS if transformation and storing of transformation was successful, otherwise, reason for not transforming.

Summary of a single transformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.

A collection that informs the user the number of times a particular TransformationResultCode and error details occurred.

Possible outcomes of transformations.

An enum of rules that can be used to transform a value. Can be a record suppression, or one of the transformation rules specified under PrimitiveTransformation.

Use this to have a random data crypto key generated. It will be discarded after the request finishes.

Bucketized uniqueness score levels. A higher uniqueness score is a strong signal that the column may contain a unique identifier like user id. A low value indicates that the column contains few unique values like booleans or other classifiers.

Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.

Request message for UpdateConnection.

Request message for UpdateDeidentifyTemplate.

Request message for UpdateDiscoveryConfig.

Request message for UpdateInspectTemplate.

Request message for UpdateJobTrigger.

Request message for UpdateStoredInfoType.

Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A value of a field, including its frequency.

Details about each available version for an infotype.

Match dataset resources using regex filters.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Target used to match against for discovery with Vertex AI datasets.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A pattern to match against one or more dataset resources.

A collection of regular expressions to determine what datasets to match against.

Identifies a single Vertex AI dataset.

API documentation for dlp_v2.services.dlp_service.pagers module.