Package types (3.1.1)

API documentation for dlp_v2.types package.

Classes

Action

A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more.

ActivateJobTriggerRequest

Request message for ActivateJobTrigger. .. attribute:: name

Required. Resource name of the trigger to activate, for example projects/dlp-test-project/jobTriggers/53234423.

:type: str

AnalyzeDataSourceRiskDetails

Result of a risk analysis operation request. .. attribute:: requested_privacy_metric

Privacy metric to compute.

:type: google.cloud.dlp_v2.types.PrivacyMetric

BigQueryField

Message defining a field of a BigQuery table. .. attribute:: table

Source table of the field.

:type: google.cloud.dlp_v2.types.BigQueryTable

BigQueryKey

Row key for identifying a record in BigQuery table. .. attribute:: table_reference

Complete BigQuery table reference.

:type: google.cloud.dlp_v2.types.BigQueryTable

BigQueryOptions

Options defining BigQuery table and row identifiers. .. attribute:: table_reference

Complete BigQuery table reference.

:type: google.cloud.dlp_v2.types.BigQueryTable

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

BoundingBox

Bounding box encompassing detected text within an image. .. attribute:: top

Top coordinate of the bounding box. (0,0) is upper left.

:type: int

BucketingConfig

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/dlp/docs/concepts-bucketing to learn more.

ByteContentItem

Container for bytes to inspect or redact. .. attribute:: type_

The type of data stored in the bytes string. Default will be TEXT_UTF8.

:type: google.cloud.dlp_v2.types.ByteContentItem.BytesType

CancelDlpJobRequest

The request message for canceling a DLP job. .. attribute:: name

Required. The name of the DlpJob resource to be cancelled.

:type: str

CharacterMaskConfig

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.

CharsToIgnore

Characters to skip when doing deidentification of a value. These will be left alone and skipped.

CloudStorageFileSet

Message representing a set of files in Cloud Storage. .. attribute:: url

The url, in the format gs://<bucket>/<path>. Trailing wildcard in the path is allowed.

:type: str

CloudStorageOptions

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

CloudStoragePath

Message representing a single file or path in Cloud Storage. .. attribute:: path

A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt

:type: str

CloudStorageRegexFileSet

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 /

Color

Represents a color in the RGB color space. .. attribute:: red

The amount of red in the color as a value in the interval [0, 1].

:type: float

Container

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

ContentItem

Container structure for the content to inspect. .. attribute:: value

String data to inspect or redact.

:type: str

ContentLocation

Precise location of the finding within a document, record, image, or metadata container.

ContentOption

Options describing which parts of the provided content should be scanned.

CreateDeidentifyTemplateRequest

Request message for CreateDeidentifyTemplate. .. attribute:: 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 <https://cloud.google.com/dlp/docs/specifying-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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

CreateDlpJobRequest

Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.

CreateInspectTemplateRequest

Request message for CreateInspectTemplate. .. attribute:: parent

Required. Parent resource name.

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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

CreateJobTriggerRequest

Request message for CreateJobTrigger. .. attribute:: parent

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location <https://cloud.google.com/dlp/docs/specifying-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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

CreateStoredInfoTypeRequest

Request message for CreateStoredInfoType. .. attribute:: parent

Required. Parent resource name.

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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

CryptoDeterministicConfig

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.

CryptoHashConfig

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/dlp/docs/pseudonymization to learn more.

CryptoKey

This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by KMS). When using KMS to wrap/unwrap DEKs, be sure to set an appropriate IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot unwrap the data crypto key.

CryptoReplaceFfxFpeConfig

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/dlp/docs/pseudonymization to learn more.

Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity.

CustomInfoType

Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

DatastoreKey

Record key for a finding in Cloud Datastore. .. attribute:: entity_key

Datastore entity key.

:type: google.cloud.dlp_v2.types.Key

DatastoreOptions

Options defining a data set within Google Cloud Datastore. .. attribute:: 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.

:type: google.cloud.dlp_v2.types.PartitionId

DateShiftConfig

Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting to learn more.

DateTime

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

DeidentifyConfig

The configuration that controls how the data will change. .. attribute:: info_type_transformations

Treat the dataset as free-form text and apply the same free text transformation everywhere.

:type: google.cloud.dlp_v2.types.InfoTypeTransformations

DeidentifyContentRequest

Request to de-identify a list of items. .. attribute:: parent

Parent resource name.

The format of this value varies depending on whether you have specified a processing location <https://cloud.google.com/dlp/docs/specifying-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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

DeidentifyContentResponse

Results of de-identifying a ContentItem. .. attribute:: item

The de-identified item.

:type: google.cloud.dlp_v2.types.ContentItem

DeidentifyTemplate

DeidentifyTemplates contains instructions on how to de- dentify content. See https://cloud.google.com/dlp/docs/concepts- templates to learn more.

DeleteDeidentifyTemplateRequest

Request message for DeleteDeidentifyTemplate. .. attribute:: name

Required. Resource name of the organization and deidentify template to be deleted, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

:type: str

DeleteDlpJobRequest

The request message for deleting a DLP job. .. attribute:: name

Required. The name of the DlpJob resource to be deleted.

:type: str

DeleteInspectTemplateRequest

Request message for DeleteInspectTemplate. .. attribute:: name

Required. Resource name of the organization and inspectTemplate to be deleted, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

:type: str

DeleteJobTriggerRequest

Request message for DeleteJobTrigger. .. attribute:: name

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

:type: str

DeleteStoredInfoTypeRequest

Request message for DeleteStoredInfoType. .. attribute:: name

Required. Resource name of the organization and storedInfoType to be deleted, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

:type: str

DlpJob

Combines all of the information about a DLP job. .. attribute:: name

The server-assigned name.

:type: str

DlpJobType

An enum to represent the various types of DLP jobs.

DocumentLocation

Location of a finding within a document. .. attribute:: file_offset

Offset of the line, from the beginning of the file, where the finding is located.

:type: int

EntityId

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.

Error

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

ExcludeInfoTypes

List of exclude infoTypes. .. attribute:: 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_types containing "PHONE_NUMBER"and\ exclusion_rule\ containing\ exclude_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: Sequence[google.cloud.dlp_v2.types.InfoType]

ExclusionRule

The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results.

FieldId

General identifier of a data field in a storage service. .. attribute:: name

Name describing the field.

:type: str

FieldTransformation

The transformation to apply to the field. .. attribute:: fields

Required. Input field(s) to apply the transformation to.

:type: Sequence[google.cloud.dlp_v2.types.FieldId]

FileType

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

Finding

Represents a piece of potentially sensitive content. .. attribute:: name

Resource name in format projects/{project}/locations/{location}/findings/{finding} Populated only when viewing persisted findings.

:type: str

FinishDlpJobRequest

The request message for finishing a DLP hybrid job. .. attribute:: name

Required. The name of the DlpJob resource to be cancelled.

:type: str

FixedSizeBucketingConfig

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}, i.e if lower_bound = 10 and upper_bound = 20 all values that are within this bucket will be replaced with "10-20".

This can be used on data of type: double, long.

If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing.

See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.

GetDeidentifyTemplateRequest

Request message for GetDeidentifyTemplate. .. attribute:: name

Required. Resource name of the organization and deidentify template to be read, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

:type: str

GetDlpJobRequest

The request message for [DlpJobs.GetDlpJob][]. .. attribute:: name

Required. The name of the DlpJob resource.

:type: str

GetInspectTemplateRequest

Request message for GetInspectTemplate. .. attribute:: name

Required. Resource name of the organization and inspectTemplate to be read, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

:type: str

GetJobTriggerRequest

Request message for GetJobTrigger. .. attribute:: name

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

:type: str

GetStoredInfoTypeRequest

Request message for GetStoredInfoType. .. attribute:: name

Required. Resource name of the organization and storedInfoType to be read, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

:type: str

HybridContentItem

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

HybridFindingDetails

Populate to associate additional data with each finding. .. attribute:: container_details

Details about the container where the content being inspected is from.

:type: google.cloud.dlp_v2.types.Container

HybridInspectDlpJobRequest

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

HybridInspectJobTriggerRequest

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

HybridInspectResponse

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

HybridInspectStatistics

Statistics related to processing hybrid inspect requests. .. attribute:: processed_count

The number of hybrid inspection requests processed within this job.

:type: int

HybridOptions

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

ImageLocation

Location of the finding within an image. .. attribute:: bounding_boxes

Bounding boxes locating the pixels within the image containing the finding.

:type: Sequence[google.cloud.dlp_v2.types.BoundingBox]

InfoType

Type of information detected by the API. .. attribute:: name

Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern [A-Za-z0-9$-_]{1,64}.

:type: str

InfoTypeDescription

InfoType description. .. attribute:: name

Internal name of the infoType.

:type: str

InfoTypeStats

Statistics regarding a specific InfoType. .. attribute:: info_type

The type of finding this stat is for.

:type: google.cloud.dlp_v2.types.InfoType

InfoTypeSupportedBy

Parts of the APIs which use certain infoTypes.

InfoTypeTransformations

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.

InspectConfig

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

InspectContentRequest

Request to search for potentially sensitive info in a ContentItem.

InspectContentResponse

Results of inspecting an item. .. attribute:: result

The findings.

:type: google.cloud.dlp_v2.types.InspectResult

InspectDataSourceDetails

The results of an inspect DataSource job. .. attribute:: requested_options

The configuration used for this job.

:type: google.cloud.dlp_v2.types.InspectDataSourceDetails.RequestedOptions

InspectJobConfig

Controls what and how to inspect for findings. .. attribute:: storage_config

The data to scan.

:type: google.cloud.dlp_v2.types.StorageConfig

InspectResult

All the findings for a single scanned item. .. attribute:: findings

List of findings for an item.

:type: Sequence[google.cloud.dlp_v2.types.Finding]

InspectTemplate

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/dlp/docs/concepts-templates to learn more.

InspectionRule

A single inspection rule to be applied to infoTypes, specified in InspectionRuleSet.

InspectionRuleSet

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.

JobTrigger

Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job- triggers to learn more.

Key

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.

KindExpression

A representation of a Datastore kind. .. attribute:: name

The name of the kind.

:type: str

KmsWrappedCryptoKey

Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128/192/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

LargeCustomDictionaryConfig

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/dlp/limits>__ page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using CustomInfoType.Dictionary for smaller dictionaries that satisfy the size requirements.

LargeCustomDictionaryStats

Summary statistics of a custom dictionary. .. attribute:: approx_num_phrases

Approximate number of distinct phrases in the dictionary.

:type: int

Likelihood

Categorization of results based on how likely they are to represent a match, based on the number of elements they contain which imply a match.

ListDeidentifyTemplatesRequest

Request message for ListDeidentifyTemplates. .. attribute:: parent

Required. Parent resource name.

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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

ListDeidentifyTemplatesResponse

Response message for ListDeidentifyTemplates. .. attribute:: deidentify_templates

List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest.

:type: Sequence[google.cloud.dlp_v2.types.DeidentifyTemplate]

ListDlpJobsRequest

The request message for listing DLP jobs. .. attribute:: parent

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location <https://cloud.google.com/dlp/docs/specifying-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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

ListDlpJobsResponse

The response message for listing DLP jobs. .. attribute:: jobs

A list of DlpJobs that matches the specified filter in the request.

:type: Sequence[google.cloud.dlp_v2.types.DlpJob]

ListInfoTypesRequest

Request for the list of infoTypes. .. attribute:: parent

The parent resource name.

The format of this value is as follows:

   locations/<var>LOCATION_ID</var>

:type: str

ListInfoTypesResponse

Response to the ListInfoTypes request. .. attribute:: info_types

Set of sensitive infoTypes.

:type: Sequence[google.cloud.dlp_v2.types.InfoTypeDescription]

ListInspectTemplatesRequest

Request message for ListInspectTemplates. .. attribute:: parent

Required. Parent resource name.

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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

ListInspectTemplatesResponse

Response message for ListInspectTemplates. .. attribute:: inspect_templates

List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.

:type: Sequence[google.cloud.dlp_v2.types.InspectTemplate]

ListJobTriggersRequest

Request message for ListJobTriggers. .. attribute:: parent

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location <https://cloud.google.com/dlp/docs/specifying-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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

ListJobTriggersResponse

Response message for ListJobTriggers. .. attribute:: job_triggers

List of triggeredJobs, up to page_size in ListJobTriggersRequest.

:type: Sequence[google.cloud.dlp_v2.types.JobTrigger]

ListStoredInfoTypesRequest

Request message for ListStoredInfoTypes. .. attribute:: parent

Required. Parent resource name.

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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

ListStoredInfoTypesResponse

Response message for ListStoredInfoTypes. .. attribute:: stored_info_types

List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest.

:type: Sequence[google.cloud.dlp_v2.types.StoredInfoType]

Location

Specifies the location of the finding. .. attribute:: byte_range

Zero-based byte offsets delimiting the finding. These are relative to the finding's containing element. Note that when the content is not textual, this references the UTF-8 encoded textual representation of the content. Omitted if content is an image.

:type: google.cloud.dlp_v2.types.Range

Manual

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

MatchingType

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.

MetadataLocation

Metadata Location .. attribute:: type_

Type of metadata containing the finding.

:type: google.cloud.dlp_v2.types.MetadataType

MetadataType

Type of metadata containing the finding.

OutputStorageConfig

Cloud repository for storing output. .. attribute:: table

Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details.

For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the Finding object.

For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.

:type: google.cloud.dlp_v2.types.BigQueryTable

PartitionId

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.

PrimitiveTransformation

A rule for transforming a value. .. attribute:: replace_config

Replace

:type: google.cloud.dlp_v2.types.ReplaceValueConfig

PrivacyMetric

Privacy metric to compute for reidentification risk analysis. .. attribute:: numerical_stats_config

Numerical stats

:type: google.cloud.dlp_v2.types.PrivacyMetric.NumericalStatsConfig

QuasiId

A column with a semantic tag attached. .. attribute:: field

Required. Identifies the column.

:type: google.cloud.dlp_v2.types.FieldId

QuoteInfo

Message for infoType-dependent details parsed from quote. .. attribute:: date_time

The date time indicated by the quote.

:type: google.cloud.dlp_v2.types.DateTime

Range

Generic half-open interval [start, end) .. attribute:: start

Index of the first character of the range (inclusive).

:type: int

RecordCondition

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

RecordKey

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

RecordLocation

Location of a finding within a row or record. .. attribute:: record_key

Key of the finding.

:type: google.cloud.dlp_v2.types.RecordKey

RecordSuppression

Configuration to suppress records whose suppression conditions evaluate to true.

RecordTransformations

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

RedactConfig

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

RedactImageRequest

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

RedactImageResponse

Results of redacting an image. .. attribute:: redacted_image

The redacted image. The type will be the same as the original image.

:type: bytes

ReidentifyContentRequest

Request to re-identify an item. .. attribute:: parent

Required. Parent resource name.

The format of this value varies depending on whether you have specified a processing location <https://cloud.google.com/dlp/docs/specifying-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 parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

::

parent=projects/example-project/locations/europe-west3

:type: str

ReidentifyContentResponse

Results of re-identifying a item. .. attribute:: item

The re-identified item.

:type: google.cloud.dlp_v2.types.ContentItem

RelationalOperator

Operators available for comparing the value of fields.

ReplaceValueConfig

Replace each input value with a given Value. .. attribute:: new_value

Value to replace it with.

:type: google.cloud.dlp_v2.types.Value

ReplaceWithInfoTypeConfig

Replace each matching finding with the name of the info_type.

RiskAnalysisJobConfig

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

Schedule

Schedule for triggeredJobs. .. attribute:: recurrence_period_duration

With this option a job is started a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.

:type: google.protobuf.duration_pb2.Duration

StatisticalTable

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

StorageConfig

Shared message indicating Cloud storage type. .. attribute:: datastore_options

Google Cloud Datastore options.

:type: google.cloud.dlp_v2.types.DatastoreOptions

StorageMetadataLabel

Storage metadata label to indicate which metadata entry contains findings.

StoredInfoType

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

StoredInfoTypeConfig

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

StoredInfoTypeState

State of a StoredInfoType version.

StoredInfoTypeStats

Statistics for a StoredInfoType. .. attribute:: large_custom_dictionary

StoredInfoType where findings are defined by a dictionary of phrases.

:type: google.cloud.dlp_v2.types.LargeCustomDictionaryStats

StoredInfoTypeVersion

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

StoredType

A reference to a StoredInfoType to use with scanning. .. attribute:: name

Resource name of the requested StoredInfoType, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

:type: str

Table

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

TableLocation

Location of a finding within a table. .. attribute:: row_index

The zero-based index of the row where the finding is located. Only populated for resources that have a natural ordering, not BigQuery. In BigQuery, to identify the row a finding came from, populate BigQueryOptions.identifying_fields with your primary key column names and when you store the findings the value of those columns will be stored inside of Finding.

:type: int

TableOptions

Instructions regarding the table content being inspected. .. attribute:: identifying_fields

The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.

:type: Sequence[google.cloud.dlp_v2.types.FieldId]

TimePartConfig

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

TransformationErrorHandling

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.

TransformationOverview

Overview of the modifications that occurred. .. attribute:: transformed_bytes

Total size in bytes that were transformed in some way.

:type: int

TransformationSummary

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

TransientCryptoKey

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

UnwrappedCryptoKey

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

UpdateDeidentifyTemplateRequest

Request message for UpdateDeidentifyTemplate. .. attribute:: name

Required. Resource name of organization and deidentify template to be updated, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

:type: str

UpdateInspectTemplateRequest

Request message for UpdateInspectTemplate. .. attribute:: name

Required. Resource name of organization and inspectTemplate to be updated, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

:type: str

UpdateJobTriggerRequest

Request message for UpdateJobTrigger. .. attribute:: name

Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

:type: str

UpdateStoredInfoTypeRequest

Request message for UpdateStoredInfoType. .. attribute:: name

Required. Resource name of organization and storedInfoType to be updated, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

:type: str

Value

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.

ValueFrequency

A value of a field, including its frequency. .. attribute:: value

A value contained in the field in question.

:type: google.cloud.dlp_v2.types.Value