Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify inspect_job.storage_config.big_query_options.identif ying_fields in CreateDlpJobRequest.

BigQueryOptions

Options defining BigQuery table and row identifiers.

Table fields that may uniquely identify a row within the table. When actions.saveFindings.outputConfig.table is specified, the values of columns specified here are available in the output table under location.content_locations.record_ location.record_key.id_values. Nested fields such as person.birthdate.year are allowed.

Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to

Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

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

Dataset ID of the table.

BoundingBox

Bounding box encompassing detected text within an image.

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

Height of the bounding box in pixels.

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.

Content data to inspect or redact.

CancelDlpJobRequest

The request message for canceling a DLP job.

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.

Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.

When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is 555-555-5555 and you instruct Cloud DLP to skip - and mask 5 characters with *, Cloud DLP returns ***-**5-5555.

CharsToIgnore

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

Common characters to not transform when masking. Useful to avoid removing punctuation.

CloudStorageFileSet

Message representing a set of files in Cloud Storage.

CloudStorageOptions

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

Max number of bytes to scan from a file. If a scanned file’s size is bigger than this value then the rest of the bytes are omitted. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to ‘global’, ‘us’, ‘asia’, and ‘europe’.

CloudStoragePath

Message representing a single file or path in Cloud Storage.

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 /

A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in exclude_regex. Leaving this field empty will match all files by default (this is equivalent to including .* in the list). Regular expressions use RE2 syntax <https://github.com/google/re2/wiki/Syntax>__; a guide can be found under the google/re2 repository on GitHub.

Color

Represents a color in the RGB color space.

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

Container

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

Project where the finding was found. Can be different from the project that owns the finding.

The root of the container. Examples: - For BigQuery table project_id:dataset_id.table_id, the root is dataset_id

For Google Cloud Storage file gs://bucket/folder/filename.txt, the root is gs://bucket

Findings container modification timestamp, if applicable. For Google Cloud Storage contains last file modification timestamp. For BigQuery table contains last_modified_time property. For Datastore - not populated.

ContentItem

Container structure for the content to inspect.

String data to inspect or redact.

Content data to inspect or redact. Replaces type and data.

ContentLocation

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

Type of the container within the file with location of the finding.

Location within an image’s pixels.

Location within the metadata for inspected content.

Findings container version, if available (“generation” for Google Cloud Storage).

CreateDeidentifyTemplateRequest

Request message for CreateDeidentifyTemplate.

Required. The DeidentifyTemplate to create.

Deprecated. This field has no effect.

CreateDlpJobRequest

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

The configuration details for the specific type of job to run.

Set to choose what metric to calculate.

Deprecated. This field has no effect.

CreateInspectTemplateRequest

Request message for CreateInspectTemplate.

Required. The InspectTemplate to create.

Deprecated. This field has no effect.

CreateJobTriggerRequest

Request message for CreateJobTrigger.

Required. The JobTrigger to create.

Deprecated. This field has no effect.

CreateStoredInfoTypeRequest

Request message for CreateStoredInfoType.

Required. Configuration of the storedInfoType to create.

Deprecated. This field has no effect.

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.

The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is ‘MY_TOKEN_INFO_TYPE’ and the surrogate is ‘abc’, the full replacement value will be: ‘MY_TOKEN_INFO_TYPE(3):abc’ This annotation identifies the surrogate when inspecting content using the custom info type ‘Surrogate’. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE.

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.

Transient crypto key

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

The ‘tweak’, a context may be used for higher security since the same identifier in two different contexts won’t be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and non-structured ContentItem\ s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2

Common alphabets.

The native way to select the alphabet. Must be in the range [2, 95].

CustomInfoType

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

Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to VERY_LIKELY if not specified.

Regular expression based CustomInfoType.

Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

DatastoreKey

Record key for a finding in Cloud Datastore.

DatastoreOptions

Options defining a data set within Google Cloud Datastore.

The kind to process.

Date

API documentation for dlp_v2.types.Date class.

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.

Required. For example, -5 means shift date to at most 5 days back in the past.

Method for calculating shift that takes context into consideration. If set, must also set context. Can only be applied to table items.

DateTime

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

Day of week

Time zone

DeidentifyConfig

The configuration that controls how the data will change.

Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table.

DeidentifyContentRequest

Request to de-identify a list of items.

Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument.

The item to de-identify. Will be treated as text.

Template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

DeidentifyContentResponse

Results of de-identifying a ContentItem.

An overview of the changes that were made on the item.

DeidentifyTemplate

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

Display name (max 256 chars).

Output only. The creation timestamp of an inspectTemplate.

///////////// // The core content of the template // ///////////////

DeleteDeidentifyTemplateRequest

Request message for DeleteDeidentifyTemplate.

DeleteDlpJobRequest

The request message for deleting a DLP job.

DeleteInspectTemplateRequest

Request message for DeleteInspectTemplate.

DeleteJobTriggerRequest

Request message for DeleteJobTrigger.

DeleteStoredInfoTypeRequest

Request message for DeleteStoredInfoType.

DlpJob

Combines all of the information about a DLP job.

The type of job.

Results from analyzing risk of a data source.

Time when the job was created.

Time when the job finished.

A stream of errors encountered running the job.

DocumentLocation

Location of a finding within a document.

Duration

API documentation for dlp_v2.types.Duration class.

Empty

API documentation for dlp_v2.types.Empty class.

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.

The times the error occurred.

ExcludeInfoTypes

List of exclude infoTypes.

ExclusionRule

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

Dictionary which defines the rule.

Set of infoTypes for which findings would affect this rule.

FieldId

General identifier of a data field in a storage service.

FieldMask

API documentation for dlp_v2.types.FieldMask class.

FieldTransformation

The transformation to apply to the field.

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation. Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85.

Apply the transformation to the entire field.

Finding

Represents a piece of potentially sensitive content.

The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if include_quote is true and the finding is less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes in length, the quote may be omitted.

Confidence of how likely it is that the info_type is correct.

Timestamp when finding was detected.

The job that stored the finding.

The labels associated with this Finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 10 labels can be associated with a given finding. Examples: * "environment" : "production" * "pipeline" : "etl"

The job that stored the finding.

FinishDlpJobRequest

The request message for finishing a DLP hybrid job.

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.

Required. Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if upper_bound = 89, then all values greater than 89 are replaced with the value “89+”.

GetDeidentifyTemplateRequest

Request message for GetDeidentifyTemplate.

GetDlpJobRequest

The request message for [DlpJobs.GetDlpJob][].

GetInspectTemplateRequest

Request message for GetInspectTemplate.

GetJobTriggerRequest

Request message for GetJobTrigger.

GetStoredInfoTypeRequest

Request message for GetStoredInfoType.

HybridContentItem

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

Supplementary information that will be added to each finding.

HybridFindingDetails

Populate to associate additional data with each finding.

Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. If not known ahead of time, can also be set within each inspect hybrid call and the two will be merged. Note that identifying_fields will only be stored to BigQuery, and only if the BigQuery action has been included.

HybridInspectDlpJobRequest

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

The item to inspect.

HybridInspectJobTriggerRequest

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

The item to inspect.

HybridInspectResponse

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

HybridInspectStatistics

Statistics related to processing hybrid inspect requests.s

The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed.

HybridOptions

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

These are labels that each inspection request must include within their ‘finding_labels’ map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. No more than 10 keys can be required.

If the container is a table, additional information to make findings meaningful such as the columns that are primary keys.

ImageLocation

Location of the finding within an image.

InfoType

Type of information detected by the API.

InfoTypeDescription

InfoType description.

Human readable form of the infoType name.

Description of the infotype. Translated when language is provided in the request.

InfoTypeStats

Statistics regarding a specific InfoType.

Number of findings for this infoType.

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.

Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

InspectContentRequest

Request to search for potentially sensitive info in a ContentItem.

Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument.

Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

InspectContentResponse

Results of inspecting an item.

InspectDataSourceDetails

The results of an inspect DataSource job.

A summary of the outcome of this inspect job.

InspectJobConfig

Controls what and how to inspect for findings.

How and what to scan for.

InspectResult

All the findings for a single scanned item.

If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call. For best results, divide the input into smaller batches.

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.

Display name (max 256 chars).

Output only. The creation timestamp of an inspectTemplate.

The core content of the template. Configuration of the scanning process.

InspectionRule

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

Hotword-based detection rule.

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.

Set of rules to be applied to infoTypes. The rules are applied in order.

JobTrigger

What event needs to occur for a new job to be started.

For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Display name (max 100 chars)

The configuration details for the specific type of job to run.

A list of triggers which will be OR’ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.

Output only. The creation timestamp of a triggeredJob.

Output only. The timestamp of the last time this trigger executed.

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.

The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element’s ancestors. A path can never be empty, and a path can have at most 100 elements.

KindExpression

A representation of a Datastore kind.

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

Required. The resource name of the KMS CryptoKey to use for unwrapping.

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.

Set of files containing newline-delimited lists of dictionary phrases.

LargeCustomDictionaryStats

Summary statistics of a custom dictionary.

ListDeidentifyTemplatesRequest

Request message for ListDeidentifyTemplates.

Page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: name asc,update_time, create_time desc Supported fields are: - create_time: corresponds to time the template was created. - update_time: corresponds to time the template was last updated. - name: corresponds to template’s name. - display_name: corresponds to template’s display name.

ListDeidentifyTemplatesResponse

Response message for ListDeidentifyTemplates.

If the next page is available then the next page token to be used in following ListDeidentifyTemplates request.

ListDlpJobsRequest

The request message for listing DLP jobs.

Allows filtering. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. - A restriction has the form of {field} {operator} {value}. - Supported fields/values for inspect jobs: - state - PENDING|RUNNING|CANCELED|FINISHED|FAILED - inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY - trigger_name - The resource name of the trigger that created job. - ’end_time` - Corresponds to time the job finished. - ’start_time` - Corresponds to time the job finished. - Supported fields for risk analysis jobs:

state - RUNNING|CANCELED|FINISHED|FAILED - ’end_time` - Corresponds to time the job finished. - ’start_time` - Corresponds to time the job finished. - The operator must be = or !=. Examples: - inspected_storage = cloud_storage AND state = done - inspected_storage = cloud_storage OR inspected_storage = bigquery - inspected_storage = cloud_storage AND (state = done OR state = canceled) - end_time > "2017-12-12T00:00:00+00:00" The length of this field should be no more than 500 characters.

The standard list page token.

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: name asc, end_time asc, create_time desc Supported fields are: - create_time: corresponds to time the job was created. - end_time: corresponds to time the job ended. - name: corresponds to job’s name. - state: corresponds to state

ListDlpJobsResponse

The response message for listing DLP jobs.

The standard List next-page token.

ListInfoTypesRequest

Request for the list of infoTypes.

BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.

Deprecated. This field has no effect.

ListInfoTypesResponse

Response to the ListInfoTypes request.

ListInspectTemplatesRequest

Request message for ListInspectTemplates.

Page token to continue retrieval. Comes from previous call to ListInspectTemplates.

ListInspectTemplatesResponse

Response message for ListInspectTemplates.

If the next page is available then the next page token to be used in following ListInspectTemplates request.

ListJobTriggersRequest

Request message for ListJobTriggers.

Page token to continue retrieval. Comes from previous call to ListJobTriggers. order_by field must not change for subsequent calls.

Comma separated list of triggeredJob fields to order by, followed by asc or desc postfix. This list is case- insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: name asc,update_time, create_time desc Supported fields are: - create_time: corresponds to time the JobTrigger was created. - update_time: corresponds to time the JobTrigger was last updated. - last_run_time: corresponds to the last time the JobTrigger ran. - name: corresponds to JobTrigger’s name. - display_name: corresponds to JobTrigger’s display name. - status: corresponds to JobTrigger’s status.

Deprecated. This field has no effect.

ListJobTriggersResponse

Response message for ListJobTriggers.

If the next page is available then the next page token to be used in following ListJobTriggers request.

ListStoredInfoTypesRequest

Request message for ListStoredInfoTypes.

Page token to continue retrieval. Comes from previous call to ListStoredInfoTypes.

Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: name asc, display_name, create_time desc Supported fields are: - create_time: corresponds to time the most recent version of the resource was created. - state: corresponds to the state of the resource. - name: corresponds to resource name. - display_name: corresponds to info type’s display name.

ListStoredInfoTypesResponse

Response message for ListStoredInfoTypes.

If the next page is available then the next page token to be used in following ListStoredInfoTypes request.

Location

Specifies the location of the finding.

Unicode character offsets delimiting the finding. These are relative to the finding’s containing element. Provided when the content is text.

Information about the container where this finding occurred, if available.

Manual

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

MetadataLocation

Metadata Location

Label of the piece of metadata containing the finding, for example - latitude, author, caption.

OutputStorageConfig

Cloud repository for storing output.

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.

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.

If not empty, the ID of the namespace to which the entities belong.

PrimitiveTransformation

A rule for transforming a value.

Redact

Ffx-Fpe

Bucketing

Time extraction

Date Shift

PrivacyMetric

Privacy metric to compute for reidentification risk analysis.

Numerical stats

K-anonymity

k-map

QuasiId

A column with a semantic tag attached.

Semantic tag that identifies what a column contains, to determine which statistical model to use to estimate the reidentifiability of each value. [required]

A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).

QuoteInfo

Message for infoType-dependent details parsed from quote.

The date time indicated by the quote.

Range

Generic half-open interval [start, end)

Index of the last character of the range (exclusive).

RecordCondition

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.

Required. Operator used to compare the field or infoType to the value.

An expression.

RecordKey

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

RecordLocation

Location of a finding within a row or record.

Field id of the field containing the finding.

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.

Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output.

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.

Deprecated. This field has no effect.

The configuration for specifying what content to redact from images.

The content must be PNG, JPEG, SVG or BMP.

RedactImageResponse

Results of redacting an image.

If an image was being inspected and the InspectConfig’s include_quote was set to true, then this field will include all text, if any, that was found in the image.

ReidentifyContentRequest

Request to re-identify an item.

Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - CryptoDeterministicConfig - CryptoReplaceFfxFpeConfig

The item to re-identify. Will be treated as text.

Template to use. References an instance of DeidentifyTemplate. Any configuration directly specified in reidentify_config or inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

ReidentifyContentResponse

Results of re-identifying a item.

An overview of the changes that were made to the item.

ReplaceValueConfig

Replace each input value with a given 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.

Input dataset to compute metrics over.

Schedule

Schedule for triggeredJobs.

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

Required. Quasi-identifier columns.

Status

API documentation for dlp_v2.types.Status class.

StorageConfig

Shared message indicating Cloud storage type.

Google Cloud Storage options.

Hybrid inspection options. Early access feature is in a pre- release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

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.

Current version of the stored info type.

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.

Description of the StoredInfoType (max 256 characters).

StoredInfoType where findings are defined by a dictionary of phrases.

Store regular expression-based StoredInfoType.

StoredInfoTypeStats

Statistics for a StoredInfoType.

StoredInfoType where findings are defined by a dictionary of phrases.

StoredInfoTypeVersion

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

Create timestamp of the version. Read-only, determined by the system when the version is created.

Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user’s Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same config if it was not the source of the error.

StoredType

A reference to a StoredInfoType to use with scanning.

Timestamp indicating when the version of the StoredInfoType used for inspection was created. Output- only field, populated by the system.

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.

Rows of the table.

TableLocation

Location of a finding within a table.

TableOptions

Instructions regarding the table content being inspected.

TimeOfDay

API documentation for dlp_v2.types.TimeOfDay class.

TimePartConfig

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

Timestamp

API documentation for dlp_v2.types.Timestamp class.

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.

Throw an error

TransformationOverview

Overview of the modifications that occurred.

Transformations applied to the dataset.

TransformationSummary

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

Set if the transformation was limited to a specific FieldId.

The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.

Collection of all transformations that took place or had an error.

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.

New DeidentifyTemplate value.

UpdateInspectTemplateRequest

Request message for UpdateInspectTemplate.

New InspectTemplate value.

UpdateJobTriggerRequest

Request message for UpdateJobTrigger.

New JobTrigger value.

UpdateStoredInfoTypeRequest

Request message for UpdateStoredInfoType.

Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration.

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.

integer

string

timestamp

date

ValueFrequency

A value of a field, including its frequency.

How many times the value is contained in the field.