Enumerations

BytesType

static

number

Value

BYTES_TYPE_UNSPECIFIED

IMAGE

IMAGE_JPEG

IMAGE_BMP

IMAGE_PNG

IMAGE_SVG

TEXT_UTF8

CommonCharsToIgnore

static

number

Value

COMMON_CHARS_TO_IGNORE_UNSPECIFIED

NUMERIC

0-9

ALPHA_UPPER_CASE

A-Z

ALPHA_LOWER_CASE

a-z

PUNCTUATION

US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[]^_`{|}~

WHITESPACE

Whitespace character, one of [ \t\n\x0B\f\r]

ContentOption

constant   static

number

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

Value

CONTENT_UNSPECIFIED

Includes entire content of a file or a data stream.

CONTENT_TEXT

Text content within the data, excluding any metadata.

CONTENT_IMAGE

Images found in the data.

DlpJobType

constant   static

number

An enum to represent the various type of DLP jobs.

Value

DLP_JOB_TYPE_UNSPECIFIED

INSPECT_JOB

The job inspected Google Cloud for sensitive data.

RISK_ANALYSIS_JOB

The job executed a Risk Analysis computation.

ExclusionType

static

number

Value

EXCLUSION_TYPE_UNSPECIFIED

A finding of this custom info type will not be excluded from results.

EXCLUSION_TYPE_EXCLUDE

A finding of this custom info type will be excluded from final results, but can still affect rule execution.

FfxCommonNativeAlphabet

static

number

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

Value

FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED

NUMERIC

[0-9] (radix of 10)

HEXADECIMAL

[0-9A-F] (radix of 16)

UPPER_CASE_ALPHA_NUMERIC

[0-9A-Z] (radix of 36)

ALPHA_NUMERIC

[0-9A-Za-z] (radix of 62)

FileType

constant   static

number

Definitions of file type groups to scan.

Value

FILE_TYPE_UNSPECIFIED

Includes all files.

BINARY_FILE

Includes all file extensions not covered by text file types.

TEXT_FILE

Included file extensions: asc, brf, c, cc, cpp, csv, cxx, c++, cs, css, dart, eml, go, h, hh, hpp, hxx, h++, hs, html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json, ocaml, md, mkd, markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw, rb, rbw, rs, rc, scala, sh, sql, tex, txt, text, tsv, vcard, vcs, wml, xml, xsl, xsd, yml, yaml.

IMAGE

Included file extensions: bmp, gif, jpg, jpeg, jpe, png. bytes_limit_per_file has no effect on image files.

InfoTypeSupportedBy

constant   static

number

Parts of the APIs which use certain infoTypes.

Value

ENUM_TYPE_UNSPECIFIED

INSPECT

Supported by the inspect operations.

RISK_ANALYSIS

Supported by the risk analysis operations.

JobState

static

number

Value

JOB_STATE_UNSPECIFIED

PENDING

The job has not yet started.

RUNNING

The job is currently running.

DONE

The job is no longer running.

CANCELED

The job was canceled before it could complete.

FAILED

The job had an error and did not complete.

Likelihood

constant   static

number

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.

Value

LIKELIHOOD_UNSPECIFIED

Default value; same as POSSIBLE.

VERY_UNLIKELY

Few matching elements.

UNLIKELY

POSSIBLE

Some matching elements.

LIKELY

VERY_LIKELY

Many matching elements.

LogicalOperator

static

number

Value

LOGICAL_OPERATOR_UNSPECIFIED

AND

MatchingType

constant   static

number

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.

Value

MATCHING_TYPE_UNSPECIFIED

Invalid.

MATCHING_TYPE_FULL_MATCH

Full match.

  • Dictionary: join of Dictionary results matched complete finding quote
  • Regex: all regex matches fill a finding quote start to end
  • Exclude info type: completely inside affecting info types findings

MATCHING_TYPE_PARTIAL_MATCH

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

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

OutputSchema

static

number

Predefined schemas for storing findings.

Value

OUTPUT_SCHEMA_UNSPECIFIED

BASIC_COLUMNS

Basic schema including only info_type, quote, certainty, and timestamp.

GCS_COLUMNS

Schema tailored to findings from scanning Google Cloud Storage.

DATASTORE_COLUMNS

Schema tailored to findings from scanning Google Datastore.

BIG_QUERY_COLUMNS

Schema tailored to findings from scanning Google BigQuery.

ALL_COLUMNS

Schema containing all columns.

RelationalOperator

constant   static

number

Operators available for comparing the value of fields.

Value

RELATIONAL_OPERATOR_UNSPECIFIED

EQUAL_TO

Equal. Attempts to match even with incompatible types.

NOT_EQUAL_TO

Not equal to. Attempts to match even with incompatible types.

GREATER_THAN

Greater than.

LESS_THAN

Less than.

GREATER_THAN_OR_EQUALS

Greater than or equals.

LESS_THAN_OR_EQUALS

Less than or equals.

EXISTS

Exists

SampleMethod

static

number

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.

Value

SAMPLE_METHOD_UNSPECIFIED

TOP

Scan from the top (default).

RANDOM_START

For each file larger than bytes_limit_per_file, randomly pick the offset to start scanning. The scanned bytes are contiguous.

SampleMethod

static

number

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, scanning would start from the top.

Value

SAMPLE_METHOD_UNSPECIFIED

TOP

Scan from the top (default).

RANDOM_START

Randomly pick the row to start scanning. The scanned rows are contiguous.

Status

static

number

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.

Value

STATUS_UNSPECIFIED

HEALTHY

Trigger is healthy.

PAUSED

Trigger is temporarily paused.

CANCELLED

Trigger is cancelled and can not be resumed.

StoredInfoTypeState

constant   static

number

State of a StoredInfoType version.

Value

STORED_INFO_TYPE_STATE_UNSPECIFIED

PENDING

StoredInfoType version is being created.

READY

StoredInfoType version is ready for use.

FAILED

StoredInfoType creation failed. All relevant error messages are returned in the StoredInfoTypeVersion message.

INVALID

StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the UpdateStoredInfoType method to create a new version.

TimePart

static

number

Value

TIME_PART_UNSPECIFIED

YEAR

[0-9999]

MONTH

[1-12]

DAY_OF_MONTH

[1-31]

DAY_OF_WEEK

[1-7]

WEEK_OF_YEAR

[1-52]

HOUR_OF_DAY

[0-23]

TransformationResultCode

static

number

Possible outcomes of transformations.

Value

TRANSFORMATION_RESULT_CODE_UNSPECIFIED

SUCCESS

ERROR

Properties

BytesType

static

number

Value

BYTES_TYPE_UNSPECIFIED

IMAGE

IMAGE_JPEG

IMAGE_BMP

IMAGE_PNG

IMAGE_SVG

TEXT_UTF8

CommonCharsToIgnore

static

number

Value

COMMON_CHARS_TO_IGNORE_UNSPECIFIED

NUMERIC

0-9

ALPHA_UPPER_CASE

A-Z

ALPHA_LOWER_CASE

a-z

PUNCTUATION

US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[]^_`{|}~

WHITESPACE

Whitespace character, one of [ \t\n\x0B\f\r]

ContentOption

constant   static

number

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

Value

CONTENT_UNSPECIFIED

Includes entire content of a file or a data stream.

CONTENT_TEXT

Text content within the data, excluding any metadata.

CONTENT_IMAGE

Images found in the data.

DlpJobType

constant   static

number

An enum to represent the various type of DLP jobs.

Value

DLP_JOB_TYPE_UNSPECIFIED

INSPECT_JOB

The job inspected Google Cloud for sensitive data.

RISK_ANALYSIS_JOB

The job executed a Risk Analysis computation.

ExclusionType

static

number

Value

EXCLUSION_TYPE_UNSPECIFIED

A finding of this custom info type will not be excluded from results.

EXCLUSION_TYPE_EXCLUDE

A finding of this custom info type will be excluded from final results, but can still affect rule execution.

FfxCommonNativeAlphabet

static

number

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

Value

FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED

NUMERIC

[0-9] (radix of 10)

HEXADECIMAL

[0-9A-F] (radix of 16)

UPPER_CASE_ALPHA_NUMERIC

[0-9A-Z] (radix of 36)

ALPHA_NUMERIC

[0-9A-Za-z] (radix of 62)

FileType

constant   static

number

Definitions of file type groups to scan.

Value

FILE_TYPE_UNSPECIFIED

Includes all files.

BINARY_FILE

Includes all file extensions not covered by text file types.

TEXT_FILE

Included file extensions: asc, brf, c, cc, cpp, csv, cxx, c++, cs, css, dart, eml, go, h, hh, hpp, hxx, h++, hs, html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json, ocaml, md, mkd, markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw, rb, rbw, rs, rc, scala, sh, sql, tex, txt, text, tsv, vcard, vcs, wml, xml, xsl, xsd, yml, yaml.

IMAGE

Included file extensions: bmp, gif, jpg, jpeg, jpe, png. bytes_limit_per_file has no effect on image files.

InfoTypeSupportedBy

constant   static

number

Parts of the APIs which use certain infoTypes.

Value

ENUM_TYPE_UNSPECIFIED

INSPECT

Supported by the inspect operations.

RISK_ANALYSIS

Supported by the risk analysis operations.

JobState

static

number

Value

JOB_STATE_UNSPECIFIED

PENDING

The job has not yet started.

RUNNING

The job is currently running.

DONE

The job is no longer running.

CANCELED

The job was canceled before it could complete.

FAILED

The job had an error and did not complete.

Likelihood

constant   static

number

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.

Value

LIKELIHOOD_UNSPECIFIED

Default value; same as POSSIBLE.

VERY_UNLIKELY

Few matching elements.

UNLIKELY

POSSIBLE

Some matching elements.

LIKELY

VERY_LIKELY

Many matching elements.

LogicalOperator

static

number

Value

LOGICAL_OPERATOR_UNSPECIFIED

AND

MatchingType

constant   static

number

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.

Value

MATCHING_TYPE_UNSPECIFIED

Invalid.

MATCHING_TYPE_FULL_MATCH

Full match.

  • Dictionary: join of Dictionary results matched complete finding quote
  • Regex: all regex matches fill a finding quote start to end
  • Exclude info type: completely inside affecting info types findings

MATCHING_TYPE_PARTIAL_MATCH

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

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

OutputSchema

static

number

Predefined schemas for storing findings.

Value

OUTPUT_SCHEMA_UNSPECIFIED

BASIC_COLUMNS

Basic schema including only info_type, quote, certainty, and timestamp.

GCS_COLUMNS

Schema tailored to findings from scanning Google Cloud Storage.

DATASTORE_COLUMNS

Schema tailored to findings from scanning Google Datastore.

BIG_QUERY_COLUMNS

Schema tailored to findings from scanning Google BigQuery.

ALL_COLUMNS

Schema containing all columns.

RelationalOperator

constant   static

number

Operators available for comparing the value of fields.

Value

RELATIONAL_OPERATOR_UNSPECIFIED

EQUAL_TO

Equal. Attempts to match even with incompatible types.

NOT_EQUAL_TO

Not equal to. Attempts to match even with incompatible types.

GREATER_THAN

Greater than.

LESS_THAN

Less than.

GREATER_THAN_OR_EQUALS

Greater than or equals.

LESS_THAN_OR_EQUALS

Less than or equals.

EXISTS

Exists

SampleMethod

static

number

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.

Value

SAMPLE_METHOD_UNSPECIFIED

TOP

Scan from the top (default).

RANDOM_START

For each file larger than bytes_limit_per_file, randomly pick the offset to start scanning. The scanned bytes are contiguous.

SampleMethod

static

number

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, scanning would start from the top.

Value

SAMPLE_METHOD_UNSPECIFIED

TOP

Scan from the top (default).

RANDOM_START

Randomly pick the row to start scanning. The scanned rows are contiguous.

Status

static

number

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.

Value

STATUS_UNSPECIFIED

HEALTHY

Trigger is healthy.

PAUSED

Trigger is temporarily paused.

CANCELLED

Trigger is cancelled and can not be resumed.

StoredInfoTypeState

constant   static

number

State of a StoredInfoType version.

Value

STORED_INFO_TYPE_STATE_UNSPECIFIED

PENDING

StoredInfoType version is being created.

READY

StoredInfoType version is ready for use.

FAILED

StoredInfoType creation failed. All relevant error messages are returned in the StoredInfoTypeVersion message.

INVALID

StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the UpdateStoredInfoType method to create a new version.

TimePart

static

number

Value

TIME_PART_UNSPECIFIED

YEAR

[0-9999]

MONTH

[1-12]

DAY_OF_MONTH

[1-31]

DAY_OF_WEEK

[1-7]

WEEK_OF_YEAR

[1-52]

HOUR_OF_DAY

[0-23]

TransformationResultCode

static

number

Possible outcomes of transformations.

Value

TRANSFORMATION_RESULT_CODE_UNSPECIFIED

SUCCESS

ERROR

Abstract types

Action

static

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

Properties

Parameter

saveFindings

Object

Save resulting findings in a provided location.

This object should have the same structure as SaveFindings

pubSub

Object

Publish a notification to a pubsub topic.

This object should have the same structure as PublishToPubSub

publishSummaryToCscc

Object

Publish summary to Cloud Security Command Center (Alpha).

This object should have the same structure as PublishSummaryToCscc

jobNotificationEmails

Object

Enable email notification to project owners and editors on job's completion/failure.

This object should have the same structure as JobNotificationEmails

See also

google.privacy.dlp.v2.Action definition in proto format

ActivateJobTriggerRequest

static

Request message for ActivateJobTrigger.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.ActivateJobTriggerRequest definition in proto format

AnalyzeDataSourceRiskDetails

static

Result of a risk analysis operation request.

Properties

Parameter

requestedPrivacyMetric

Object

Privacy metric to compute.

This object should have the same structure as PrivacyMetric

requestedSourceTable

Object

Input dataset to compute metrics over.

This object should have the same structure as BigQueryTable

numericalStatsResult

Object

This object should have the same structure as NumericalStatsResult

categoricalStatsResult

Object

This object should have the same structure as CategoricalStatsResult

kAnonymityResult

Object

This object should have the same structure as KAnonymityResult

lDiversityResult

Object

This object should have the same structure as LDiversityResult

kMapEstimationResult

Object

This object should have the same structure as KMapEstimationResult

deltaPresenceEstimationResult

Object

This object should have the same structure as DeltaPresenceEstimationResult

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails definition in proto format

AuxiliaryTable

static

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

Properties

Parameter

table

Object

Auxiliary table location. [required]

This object should have the same structure as BigQueryTable

quasiIds

Array of Object

Quasi-identifier columns. [required]

This object should have the same structure as QuasiIdField

relativeFrequency

Object

The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required]

This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig.AuxiliaryTable definition in proto format

BigQueryField

static

Message defining a field of a BigQuery table.

Properties

Parameter

table

Object

Source table of the field.

This object should have the same structure as BigQueryTable

field

Object

Designated field in the BigQuery table.

This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.BigQueryField definition in proto format

BigQueryKey

static

Row key for identifying a record in BigQuery table.

Properties

Parameter

tableReference

Object

Complete BigQuery table reference.

This object should have the same structure as BigQueryTable

rowNumber

number

Absolute number of the row from the beginning of the table at the time of scanning.

See also

google.privacy.dlp.v2.BigQueryKey definition in proto format

BigQueryOptions

static

Options defining BigQuery table and row identifiers.

Properties

Parameter

tableReference

Object

Complete BigQuery table reference.

This object should have the same structure as BigQueryTable

identifyingFields

Array of Object

References to fields uniquely identifying rows within the table. Nested fields in the format, like person.birthdate.year, are allowed.

This object should have the same structure as FieldId

rowsLimit

number

Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

rowsLimitPercent

number

Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.

sampleMethod

number

The number should be among the values of SampleMethod

excludedFields

Array of Object

References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings.

This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.BigQueryOptions definition in proto format

BigQueryTable

static

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

Properties

Parameter

projectId

string

The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.

datasetId

string

Dataset ID of the table.

tableId

string

Name of the table.

See also

google.privacy.dlp.v2.BigQueryTable definition in proto format

BoundingBox

static

Bounding box encompassing detected text within an image.

Properties

Parameter

top

number

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

left

number

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

width

number

Width of the bounding box in pixels.

height

number

Height of the bounding box in pixels.

See also

google.privacy.dlp.v2.BoundingBox definition in proto format

Bucket

static

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

Properties

Parameter

min

Object

Lower bound of the range, inclusive. Type should be the same as max if used.

This object should have the same structure as Value

max

Object

Upper bound of the range, exclusive; type must match min.

This object should have the same structure as Value

replacementValue

Object

Replacement value for this bucket. If not provided the default behavior will be to hyphenate the min-max range.

This object should have the same structure as Value

See also

google.privacy.dlp.v2.BucketingConfig.Bucket definition in proto format

BucketingConfig

static

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.

Property

Parameter

buckets

Array of Object

Set of buckets. Ranges must be non-overlapping.

This object should have the same structure as Bucket

See also

google.privacy.dlp.v2.BucketingConfig definition in proto format

ByteContentItem

static

Container for bytes to inspect or redact.

Properties

Parameter

type

number

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

The number should be among the values of BytesType

data

string

Content data to inspect or redact.

See also

google.privacy.dlp.v2.ByteContentItem definition in proto format

CancelDlpJobRequest

static

The request message for canceling a DLP job.

Property

Parameter

name

string

The name of the DlpJob resource to be cancelled.

See also

google.privacy.dlp.v2.CancelDlpJobRequest definition in proto format

CategoricalStatsConfig

static

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

Property

Parameter

field

Object

Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data.

This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.PrivacyMetric.CategoricalStatsConfig definition in proto format

CategoricalStatsHistogramBucket

static

Properties

Parameter

valueFrequencyLowerBound

number

Lower bound on the value frequency of the values in this bucket.

valueFrequencyUpperBound

number

Upper bound on the value frequency of the values in this bucket.

bucketSize

number

Total number of values in this bucket.

bucketValues

Array of Object

Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20.

This object should have the same structure as ValueFrequency

bucketValueCount

number

Total number of distinct values in this bucket.

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.CategoricalStatsResult.CategoricalStatsHistogramBucket definition in proto format

CategoricalStatsResult

static

Result of the categorical stats computation.

Property

Parameter

valueFrequencyHistogramBuckets

Array of Object

Histogram of value frequencies in the column.

This object should have the same structure as CategoricalStatsHistogramBucket

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.CategoricalStatsResult definition in proto format

CharacterMaskConfig

static

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.

Properties

Parameter

maskingCharacter

string

Character to mask the sensitive values—for example, "" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number. String must have length 1. If not supplied, we will default to "" for strings, 0 for digits.

numberToMask

number

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

reverseOrder

boolean

Mask characters in reverse order. For example, if masking_character is '0', number_to_mask is 14, and reverse_order is false, then 1234-5678-9012-3456 -> 00000000000000-3456 If masking_character is '', number_to_mask is 3, and reverse_order is true, then 12345 -> 12**

charactersToIgnore

Array of Object

When masking a string, items in this list will be skipped when replacing. For example, if your string is 555-555-5555 and you ask us to skip - and mask 5 chars with we would produce *-55-5555.

This object should have the same structure as CharsToIgnore

See also

google.privacy.dlp.v2.CharacterMaskConfig definition in proto format

CharsToIgnore

static

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

Properties

Parameter

charactersToSkip

string

commonCharactersToIgnore

number

The number should be among the values of CommonCharsToIgnore

See also

google.privacy.dlp.v2.CharsToIgnore definition in proto format

CloudStorageFileSet

static

Message representing a set of files in Cloud Storage.

Property

Parameter

url

string

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

See also

google.privacy.dlp.v2.CloudStorageFileSet definition in proto format

CloudStorageOptions

static

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

Properties

Parameter

fileSet

Object

The set of one or more files to scan.

This object should have the same structure as FileSet

bytesLimitPerFile

number

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.

bytesLimitPerFilePercent

number

Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.

fileTypes

Array of number

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.

The number should be among the values of FileType

sampleMethod

number

The number should be among the values of SampleMethod

filesLimitPercent

number

Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.

See also

google.privacy.dlp.v2.CloudStorageOptions definition in proto format

CloudStoragePath

static

Message representing a single file or path in Cloud Storage.

Property

Parameter

path

string

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

See also

google.privacy.dlp.v2.CloudStoragePath definition in proto format

CloudStorageRegexFileSet

static

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 /

Properties

Parameter

bucketName

string

The name of a Cloud Storage bucket. Required.

includeRegex

Array of string

A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in exclude_regex. Leaving this field empty will match all files by default (this is equivalent to including .* in the list).

Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub.

excludeRegex

Array of string

A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan.

Regular expressions use RE2 syntax; a guide can be found under the google/re2 repository on GitHub.

See also

google.privacy.dlp.v2.CloudStorageRegexFileSet definition in proto format

Color

static

Represents a color in the RGB color space.

Properties

Parameter

red

number

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

green

number

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

blue

number

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

See also

google.privacy.dlp.v2.Color definition in proto format

Condition

static

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.

Properties

Parameter

field

Object

Field within the record this condition is evaluated against. [required]

This object should have the same structure as FieldId

operator

number

Operator used to compare the field or infoType to the value. [required]

The number should be among the values of RelationalOperator

value

Object

Value to compare against. [Required, except for EXISTS tests.]

This object should have the same structure as Value

See also

google.privacy.dlp.v2.RecordCondition.Condition definition in proto format

Conditions

static

A collection of conditions.

Property

Parameter

conditions

Array of Object

This object should have the same structure as Condition

See also

google.privacy.dlp.v2.RecordCondition.Conditions definition in proto format

ContentItem

static

Container structure for the content to inspect.

Properties

Parameter

value

string

String data to inspect or redact.

table

Object

Structured content for inspection. See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to learn more.

This object should have the same structure as Table

byteItem

Object

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

This object should have the same structure as ByteContentItem

See also

google.privacy.dlp.v2.ContentItem definition in proto format

ContentLocation

static

Findings container location data.

Properties

Parameter

containerName

string

Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows:

  • BigQuery tables: <project_id>:<dataset_id>.<table_id>
  • Cloud Storage files: gs://<bucket>/<path>
  • Datastore namespace:

    Nested names could be absent if the embedded object has no string identifier (for an example an image contained within a document).

recordLocation

Object

Location within a row or record of a database table.

This object should have the same structure as RecordLocation

imageLocation

Object

Location within an image's pixels.

This object should have the same structure as ImageLocation

documentLocation

Object

Location data for document files.

This object should have the same structure as DocumentLocation

containerTimestamp

Object

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.

This object should have the same structure as Timestamp

containerVersion

string

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

See also

google.privacy.dlp.v2.ContentLocation definition in proto format

CreateDeidentifyTemplateRequest

static

Request message for CreateDeidentifyTemplate.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id or organizations/my-org-id.

deidentifyTemplate

Object

The DeidentifyTemplate to create.

This object should have the same structure as DeidentifyTemplate

templateId

string

The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

See also

google.privacy.dlp.v2.CreateDeidentifyTemplateRequest definition in proto format

CreateDlpJobRequest

static

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

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id.

inspectJob

Object

This object should have the same structure as InspectJobConfig

riskJob

Object

This object should have the same structure as RiskAnalysisJobConfig

jobId

string

The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

See also

google.privacy.dlp.v2.CreateDlpJobRequest definition in proto format

CreateInspectTemplateRequest

static

Request message for CreateInspectTemplate.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id or organizations/my-org-id.

inspectTemplate

Object

The InspectTemplate to create.

This object should have the same structure as InspectTemplate

templateId

string

The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

See also

google.privacy.dlp.v2.CreateInspectTemplateRequest definition in proto format

CreateJobTriggerRequest

static

Request message for CreateJobTrigger.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id.

jobTrigger

Object

The JobTrigger to create.

This object should have the same structure as JobTrigger

triggerId

string

The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

See also

google.privacy.dlp.v2.CreateJobTriggerRequest definition in proto format

CreateStoredInfoTypeRequest

static

Request message for CreateStoredInfoType.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id or organizations/my-org-id.

config

Object

Configuration of the storedInfoType to create.

This object should have the same structure as StoredInfoTypeConfig

storedInfoTypeId

string

The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

See also

google.privacy.dlp.v2.CreateStoredInfoTypeRequest definition in proto format

CryptoDeterministicConfig

static

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.

Properties

Parameter

cryptoKey

Object

The key used by the encryption function.

This object should have the same structure as CryptoKey

surrogateInfoType

Object

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: ():

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.

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

    This object should have the same structure as InfoType

context

Object

Optional. A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well.

If the context is not set, plaintext would be used as is for encryption. If the context is set but:

  1. there is no record present when transforming a given value or
  2. the field is not present when transforming a given value,

    plaintext would be used as is for encryption.

    Note that case (1) is expected when an InfoTypeTransformation is applied to both structured and non-structured ContentItems.

    This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.CryptoDeterministicConfig definition in proto format

CryptoHashConfig

static

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.

Property

Parameter

cryptoKey

Object

The key used by the hash function.

This object should have the same structure as CryptoKey

See also

google.privacy.dlp.v2.CryptoHashConfig definition in proto format

CryptoKey

static

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.

Properties

Parameter

transient

Object

This object should have the same structure as TransientCryptoKey

unwrapped

Object

This object should have the same structure as UnwrappedCryptoKey

kmsWrapped

Object

This object should have the same structure as KmsWrappedCryptoKey

See also

google.privacy.dlp.v2.CryptoKey definition in proto format

CryptoReplaceFfxFpeConfig

static

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.

Properties

Parameter

cryptoKey

Object

The key used by the encryption algorithm. [required]

This object should have the same structure as CryptoKey

context

Object

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

  3. a 64 bit integer is encoded followed by a single byte of value 1

  4. a string is encoded in UTF-8 format followed by a single byte of value 2

    This object should have the same structure as FieldId

commonAlphabet

number

The number should be among the values of FfxCommonNativeAlphabet

customAlphabet

string

This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 62]. This must be encoded as ASCII. The order of characters does not matter.

radix

number

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

surrogateInfoType

Object

The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate

For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc'

This annotation identifies the surrogate when inspecting content using the custom infoType SurrogateType. This facilitates reversal of the surrogate when it occurs in free text.

In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE

This object should have the same structure as InfoType

See also

google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig definition in proto format

CustomInfoType

static

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

Properties

Parameter

infoType

Object

CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in InspectContent.info_types field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in InspectContent.info_types list then the name is treated as a custom info type.

This object should have the same structure as InfoType

likelihood

number

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.

The number should be among the values of Likelihood

dictionary

Object

A list of phrases to detect as a CustomInfoType.

This object should have the same structure as Dictionary

regex

Object

Regular expression based CustomInfoType.

This object should have the same structure as Regex

surrogateType

Object

Message for detecting output from deidentification transformations that support reversing.

This object should have the same structure as SurrogateType

storedType

Object

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

This object should have the same structure as StoredType

detectionRules

Array of Object

Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the surrogate_type CustomInfoType.

This object should have the same structure as DetectionRule

exclusionType

number

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

The number should be among the values of ExclusionType

See also

google.privacy.dlp.v2.CustomInfoType definition in proto format

DatastoreKey

static

Record key for a finding in Cloud Datastore.

Property

Parameter

entityKey

Object

Datastore entity key.

This object should have the same structure as Key

See also

google.privacy.dlp.v2.DatastoreKey definition in proto format

DatastoreOptions

static

Options defining a data set within Google Cloud Datastore.

Properties

Parameter

partitionId

Object

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.

This object should have the same structure as PartitionId

kind

Object

The kind to process.

This object should have the same structure as KindExpression

See also

google.privacy.dlp.v2.DatastoreOptions definition in proto format

DateShiftConfig

static

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.

Properties

Parameter

upperBoundDays

number

Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction.

For example, 3 means shift date to at most 3 days into the future. [Required]

lowerBoundDays

number

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

context

Object

Points to the field that contains the context, for example, an entity id. If set, must also set method. If set, shift will be consistent for the given context.

This object should have the same structure as FieldId

cryptoKey

Object

Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key.

This object should have the same structure as CryptoKey

See also

google.privacy.dlp.v2.DateShiftConfig definition in proto format

DateTime

static

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

Properties

Parameter

date

Object

One or more of the following must be set. All fields are optional, but when set must be valid date or time values.

This object should have the same structure as Date

dayOfWeek

number

The number should be among the values of DayOfWeek

time

Object

This object should have the same structure as TimeOfDay

timeZone

Object

This object should have the same structure as TimeZone

See also

google.privacy.dlp.v2.DateTime definition in proto format

DeidentifyConfig

static

The configuration that controls how the data will change.

Properties

Parameter

infoTypeTransformations

Object

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

This object should have the same structure as InfoTypeTransformations

recordTransformations

Object

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

This object should have the same structure as RecordTransformations

See also

google.privacy.dlp.v2.DeidentifyConfig definition in proto format

DeidentifyContentRequest

static

Request to de-identify a list of items.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id.

deidentifyConfig

Object

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

This object should have the same structure as DeidentifyConfig

inspectConfig

Object

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

This object should have the same structure as InspectConfig

item

Object

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

This object should have the same structure as ContentItem

inspectTemplateName

string

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

deidentifyTemplateName

string

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

See also

google.privacy.dlp.v2.DeidentifyContentRequest definition in proto format

DeidentifyContentResponse

static

Results of de-identifying a ContentItem.

Properties

Parameter

item

Object

The de-identified item.

This object should have the same structure as ContentItem

overview

Object

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

This object should have the same structure as TransformationOverview

See also

google.privacy.dlp.v2.DeidentifyContentResponse definition in proto format

DeidentifyTemplate

static

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

Properties

Parameter

name

string

The template name. Output only.

The template will have one of the following formats: projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID

displayName

string

Display name (max 256 chars).

description

string

Short description (max 256 chars).

createTime

Object

The creation timestamp of a inspectTemplate, output only field.

This object should have the same structure as Timestamp

updateTime

Object

The last update timestamp of a inspectTemplate, output only field.

This object should have the same structure as Timestamp

deidentifyConfig

Object

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

This object should have the same structure as DeidentifyConfig

See also

google.privacy.dlp.v2.DeidentifyTemplate definition in proto format

DeleteDeidentifyTemplateRequest

static

Request message for DeleteDeidentifyTemplate.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.DeleteDeidentifyTemplateRequest definition in proto format

DeleteDlpJobRequest

static

The request message for deleting a DLP job.

Property

Parameter

name

string

The name of the DlpJob resource to be deleted.

See also

google.privacy.dlp.v2.DeleteDlpJobRequest definition in proto format

DeleteInspectTemplateRequest

static

Request message for DeleteInspectTemplate.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.DeleteInspectTemplateRequest definition in proto format

DeleteJobTriggerRequest

static

Request message for DeleteJobTrigger.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.DeleteJobTriggerRequest definition in proto format

DeleteStoredInfoTypeRequest

static

Request message for DeleteStoredInfoType.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.DeleteStoredInfoTypeRequest definition in proto format

DeltaPresenceEstimationConfig

static

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

Properties

Parameter

quasiIds

Array of Object

Fields considered to be quasi-identifiers. No two fields can have the same tag. [required]

This object should have the same structure as QuasiId

regionCode

string

ISO 3166-1 alpha-2 region code to use in the statistical modeling. Required if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.

auxiliaryTables

Array of Object

Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table.

This object should have the same structure as StatisticalTable

See also

google.privacy.dlp.v2.PrivacyMetric.DeltaPresenceEstimationConfig definition in proto format

DeltaPresenceEstimationHistogramBucket

static

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.

Properties

Parameter

minProbability

number

Between 0 and 1.

maxProbability

number

Always greater than or equal to min_probability.

bucketSize

number

Number of records within these probability bounds.

bucketValues

Array of Object

Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.

This object should have the same structure as DeltaPresenceEstimationQuasiIdValues

bucketValueCount

number

Total number of distinct quasi-identifier tuple values in this bucket.

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.DeltaPresenceEstimationResult.DeltaPresenceEstimationHistogramBucket definition in proto format

DeltaPresenceEstimationQuasiIdValues

static

A tuple of values for the quasi-identifier columns.

Properties

Parameter

quasiIdsValues

Array of Object

The quasi-identifier values.

This object should have the same structure as Value

estimatedProbability

number

The estimated probability that a given individual sharing these quasi-identifier values is in the dataset. This value, typically called δ, is the ratio between the number of records in the dataset with these quasi-identifier values, and the total number of individuals (inside and outside the dataset) with these quasi-identifier values. For example, if there are 15 individuals in the dataset who share the same quasi-identifier values, and an estimated 100 people in the entire population with these values, then δ is 0.15.

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.DeltaPresenceEstimationResult.DeltaPresenceEstimationQuasiIdValues definition in proto format

DeltaPresenceEstimationResult

static

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

Property

Parameter

deltaPresenceEstimationHistogram

Array of Object

The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4.

This object should have the same structure as DeltaPresenceEstimationHistogramBucket

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.DeltaPresenceEstimationResult definition in proto format

DetectionRule

static

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

Property

Parameter

hotwordRule

Object

Hotword-based detection rule.

This object should have the same structure as HotwordRule

See also

google.privacy.dlp.v2.CustomInfoType.DetectionRule definition in proto format

Dictionary

static

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 will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer".

Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The limits page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using LargeCustomDictionaryConfig in the StoredInfoType API.

Properties

Parameter

wordList

Object

List of words or phrases to search for.

This object should have the same structure as WordList

cloudStoragePath

Object

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

This object should have the same structure as CloudStoragePath

See also

google.privacy.dlp.v2.CustomInfoType.Dictionary definition in proto format

DlpJob

static

Combines all of the information about a DLP job.

Properties

Parameter

name

string

The server-assigned name.

type

number

The type of job.

The number should be among the values of DlpJobType

state

number

State of a job.

The number should be among the values of JobState

riskDetails

Object

Results from analyzing risk of a data source.

This object should have the same structure as AnalyzeDataSourceRiskDetails

inspectDetails

Object

Results from inspecting a data source.

This object should have the same structure as InspectDataSourceDetails

createTime

Object

Time when the job was created.

This object should have the same structure as Timestamp

startTime

Object

Time when the job started.

This object should have the same structure as Timestamp

endTime

Object

Time when the job finished.

This object should have the same structure as Timestamp

jobTriggerName

string

If created by a job trigger, the resource name of the trigger that instantiated the job.

errors

Array of Object

A stream of errors encountered running the job.

This object should have the same structure as Error

See also

google.privacy.dlp.v2.DlpJob definition in proto format

DocumentLocation

static

Location of a finding within a document.

Property

Parameter

fileOffset

number

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

See also

google.privacy.dlp.v2.DocumentLocation definition in proto format

EntityId

static

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.

Property

Parameter

field

Object

Composite key indicating which field contains the entity identifier.

This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.EntityId definition in proto format

Error

static

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

Properties

Parameter

details

Object

This object should have the same structure as Status

timestamps

Array of Object

The times the error occurred.

This object should have the same structure as Timestamp

See also

google.privacy.dlp.v2.Error definition in proto format

ExcludeInfoTypes

static

List of exclude infoTypes.

Property

Parameter

infoTypes

Array of Object

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"andexclusion_rulecontainingexclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address.

This object should have the same structure as InfoType

See also

google.privacy.dlp.v2.ExcludeInfoTypes definition in proto format

ExclusionRule

static

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

Properties

Parameter

dictionary

Object

Dictionary which defines the rule.

This object should have the same structure as Dictionary

regex

Object

Regular expression which defines the rule.

This object should have the same structure as Regex

excludeInfoTypes

Object

Set of infoTypes for which findings would affect this rule.

This object should have the same structure as ExcludeInfoTypes

matchingType

number

How the rule is applied, see MatchingType documentation for details.

The number should be among the values of MatchingType

See also

google.privacy.dlp.v2.ExclusionRule definition in proto format

Expressions

static

An expression, consisting or an operator and conditions.

Properties

Parameter

logicalOperator

number

The operator to apply to the result of conditions. Default and currently only supported value is AND.

The number should be among the values of LogicalOperator

conditions

Object

This object should have the same structure as Conditions

See also

google.privacy.dlp.v2.RecordCondition.Expressions definition in proto format

FieldId

static

General identifier of a data field in a storage service.

Property

Parameter

name

string

Name describing the field.

See also

google.privacy.dlp.v2.FieldId definition in proto format

FieldTransformation

static

The transformation to apply to the field.

Properties

Parameter

fields

Array of Object

Input field(s) to apply the transformation to. [required]

This object should have the same structure as FieldId

condition

Object

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. [optional]

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.

    This object should have the same structure as RecordCondition

primitiveTransformation

Object

Apply the transformation to the entire field.

This object should have the same structure as PrimitiveTransformation

infoTypeTransformations

Object

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

This object should have the same structure as InfoTypeTransformations

See also

google.privacy.dlp.v2.FieldTransformation definition in proto format

FileSet

static

Set of files to scan.

Properties

Parameter

url

string

The Cloud Storage url of the file(s) to scan, in the format gs://<bucket>/<path>. Trailing wildcard in the path is allowed.

If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that gs://mybucket/ is equivalent to gs://mybucket/, and gs://mybucket/directory/ is equivalent to gs://mybucket/directory/.

Exactly one of url or regex_file_set must be set.

regexFileSet

Object

The regex-filtered set of files to scan. Exactly one of url or regex_file_set must be set.

This object should have the same structure as CloudStorageRegexFileSet

See also

google.privacy.dlp.v2.CloudStorageOptions.FileSet definition in proto format

Finding

static

Represents a piece of potentially sensitive content.

Properties

Parameter

quote

string

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.

infoType

Object

The type of content that might have been found. Provided if excluded_types is false.

This object should have the same structure as InfoType

likelihood

number

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

The number should be among the values of Likelihood

location

Object

Where the content was found.

This object should have the same structure as Location

createTime

Object

Timestamp when finding was detected.

This object should have the same structure as Timestamp

quoteInfo

Object

Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME.

This object should have the same structure as QuoteInfo

See also

google.privacy.dlp.v2.Finding definition in proto format

FindingLimits

static

Properties

Parameter

maxFindingsPerItem

number

Max number of findings that will be returned for each item scanned. When set within InspectDataSourceRequest, the maximum returned is 2000 regardless if this is set higher. When set within InspectContentRequest, this field is ignored.

maxFindingsPerRequest

number

Max number of findings that will be returned per request/job. When set within InspectContentRequest, the maximum returned is 2000 regardless if this is set higher.

maxFindingsPerInfoType

Array of Object

Configuration of findings limit given for specified infoTypes.

This object should have the same structure as InfoTypeLimit

See also

google.privacy.dlp.v2.InspectConfig.FindingLimits definition in proto format

FixedSizeBucketingConfig

static

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.

Properties

Parameter

lowerBound

Object

Lower bound value of buckets. All values less than lower_bound are grouped together into a single bucket; for example if lower_bound = 10, then all values less than 10 are replaced with the value “-10”. [Required].

This object should have the same structure as Value

upperBound

Object

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+”. [Required].

This object should have the same structure as Value

bucketSize

number

Size of each bucket (except for minimum and maximum buckets). So if lower_bound = 10, upper_bound = 89, and bucket_size = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required].

See also

google.privacy.dlp.v2.FixedSizeBucketingConfig definition in proto format

GetDeidentifyTemplateRequest

static

Request message for GetDeidentifyTemplate.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.GetDeidentifyTemplateRequest definition in proto format

GetDlpJobRequest

static

The request message for DlpJobs.GetDlpJob.

Property

Parameter

name

string

The name of the DlpJob resource.

See also

google.privacy.dlp.v2.GetDlpJobRequest definition in proto format

GetInspectTemplateRequest

static

Request message for GetInspectTemplate.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.GetInspectTemplateRequest definition in proto format

GetJobTriggerRequest

static

Request message for GetJobTrigger.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.GetJobTriggerRequest definition in proto format

GetStoredInfoTypeRequest

static

Request message for GetStoredInfoType.

Property

Parameter

name

string

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

See also

google.privacy.dlp.v2.GetStoredInfoTypeRequest definition in proto format

HotwordRule

static

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

Properties

Parameter

hotwordRegex

Object

Regular expression pattern defining what qualifies as a hotword.

This object should have the same structure as Regex

proximity

Object

Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "(\d{3}) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "(xxx)", where "xxx" is the area code in question.

This object should have the same structure as Proximity

likelihoodAdjustment

Object

Likelihood adjustment to apply to all matching findings.

This object should have the same structure as LikelihoodAdjustment

See also

google.privacy.dlp.v2.CustomInfoType.DetectionRule.HotwordRule definition in proto format

ImageLocation

static

Location of the finding within an image.

Property

Parameter

boundingBoxes

Array of Object

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

This object should have the same structure as BoundingBox

See also

google.privacy.dlp.v2.ImageLocation definition in proto format

ImageRedactionConfig

static

Configuration for determining how redaction of images should occur.

Properties

Parameter

infoType

Object

Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig.

This object should have the same structure as InfoType

redactAllText

boolean

If true, all text found in the image, regardless whether it matches an info_type, is redacted. Only one should be provided.

redactionColor

Object

The color to use when redacting content from an image. If not specified, the default is black.

This object should have the same structure as Color

See also

google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig definition in proto format

InfoType

static

Type of information detected by the API.

Property

Parameter

name

string

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. InfoType names should conform to the pattern [a-zA-Z0-9_]{1,64}.

See also

google.privacy.dlp.v2.InfoType definition in proto format

InfoTypeDescription

static

InfoType description.

Properties

Parameter

name

string

Internal name of the infoType.

displayName

string

Human readable form of the infoType name.

supportedBy

Array of number

Which parts of the API supports this InfoType.

The number should be among the values of InfoTypeSupportedBy

description

string

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

See also

google.privacy.dlp.v2.InfoTypeDescription definition in proto format

InfoTypeLimit

static

Max findings configuration per infoType, per content item or long running DlpJob.

Properties

Parameter

infoType

Object

Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.

This object should have the same structure as InfoType

maxFindings

number

Max findings limit for the given infoType.

See also

google.privacy.dlp.v2.InspectConfig.FindingLimits.InfoTypeLimit definition in proto format

InfoTypeStats

static

Statistics regarding a specific InfoType.

Properties

Parameter

infoType

Object

The type of finding this stat is for.

This object should have the same structure as InfoType

count

number

Number of findings for this infoType.

See also

google.privacy.dlp.v2.InfoTypeStats definition in proto format

InfoTypeTransformation

static

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

Properties

Parameter

infoTypes

Array of Object

InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in InspectConfig.

This object should have the same structure as InfoType

primitiveTransformation

Object

Primitive transformation to apply to the infoType. [required]

This object should have the same structure as PrimitiveTransformation

See also

google.privacy.dlp.v2.InfoTypeTransformations.InfoTypeTransformation definition in proto format

InfoTypeTransformations

static

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

Property

Parameter

transformations

Array of Object

Transformation for each infoType. Cannot specify more than one for a given infoType. [required]

This object should have the same structure as InfoTypeTransformation

See also

google.privacy.dlp.v2.InfoTypeTransformations definition in proto format

InspectConfig

static

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

Properties

Parameter

infoTypes

Array of Object

Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference.

When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

The special InfoType name "ALL_BASIC" can be used to trigger all detectors, but may change over time as new InfoTypes are added. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference.

This object should have the same structure as InfoType

minLikelihood

number

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

The number should be among the values of Likelihood

limits

Object

This object should have the same structure as FindingLimits

includeQuote

boolean

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

excludeInfoTypes

boolean

When true, excludes type information of the findings.

customInfoTypes

Array of Object

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

This object should have the same structure as CustomInfoType

contentOptions

Array of number

List of options defining data content to scan. If empty, text, images, and other content will be included.

The number should be among the values of ContentOption

ruleSet

Array of Object

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.

This object should have the same structure as InspectionRuleSet

See also

google.privacy.dlp.v2.InspectConfig definition in proto format

InspectContentRequest

static

Request to search for potentially sensitive info in a ContentItem.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id.

inspectConfig

Object

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

This object should have the same structure as InspectConfig

item

Object

The item to inspect.

This object should have the same structure as ContentItem

inspectTemplateName

string

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

See also

google.privacy.dlp.v2.InspectContentRequest definition in proto format

InspectContentResponse

static

Results of inspecting an item.

Property

Parameter

result

Object

The findings.

This object should have the same structure as InspectResult

See also

google.privacy.dlp.v2.InspectContentResponse definition in proto format

InspectDataSourceDetails

static

The results of an inspect DataSource job.

Properties

Parameter

requestedOptions

Object

The configuration used for this job.

This object should have the same structure as RequestedOptions

result

Object

A summary of the outcome of this inspect job.

This object should have the same structure as Result

See also

google.privacy.dlp.v2.InspectDataSourceDetails definition in proto format

InspectionRule

static

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

Properties

Parameter

hotwordRule

Object

Hotword-based detection rule.

This object should have the same structure as HotwordRule

exclusionRule

Object

Exclusion rule.

This object should have the same structure as ExclusionRule

See also

google.privacy.dlp.v2.InspectionRule definition in proto format

InspectionRuleSet

static

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.

Properties

Parameter

infoTypes

Array of Object

List of infoTypes this rule set is applied to.

This object should have the same structure as InfoType

rules

Array of Object

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

This object should have the same structure as InspectionRule

See also

google.privacy.dlp.v2.InspectionRuleSet definition in proto format

InspectJobConfig

static

Properties

Parameter

storageConfig

Object

The data to scan.

This object should have the same structure as StorageConfig

inspectConfig

Object

How and what to scan for.

This object should have the same structure as InspectConfig

inspectTemplateName

string

If provided, will be used as the default for all values in InspectConfig. inspect_config will be merged into the values persisted as part of the template.

actions

Array of Object

Actions to execute at the completion of the job. Are executed in the order provided.

This object should have the same structure as Action

See also

google.privacy.dlp.v2.InspectJobConfig definition in proto format

InspectResult

static

All the findings for a single scanned item.

Properties

Parameter

findings

Array of Object

List of findings for an item.

This object should have the same structure as Finding

findingsTruncated

boolean

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.

See also

google.privacy.dlp.v2.InspectResult definition in proto format

InspectTemplate

static

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.

Properties

Parameter

name

string

The template name. Output only.

The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID

displayName

string

Display name (max 256 chars).

description

string

Short description (max 256 chars).

createTime

Object

The creation timestamp of a inspectTemplate, output only field.

This object should have the same structure as Timestamp

updateTime

Object

The last update timestamp of a inspectTemplate, output only field.

This object should have the same structure as Timestamp

inspectConfig

Object

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

This object should have the same structure as InspectConfig

See also

google.privacy.dlp.v2.InspectTemplate definition in proto format

JobNotificationEmails

static

Enable email notification to project owners and editors on jobs's completion/failure.

See also

google.privacy.dlp.v2.Action.JobNotificationEmails definition in proto format

JobTrigger

static

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.

Properties

Parameter

name

string

Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/triggeredJobs/53234423.

displayName

string

Display name (max 100 chars)

description

string

User provided description (max 256 chars)

inspectJob

Object

This object should have the same structure as InspectJobConfig

triggers

Array of Object

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.

This object should have the same structure as Trigger

errors

Array of Object

A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. Output only field.

This object should have the same structure as Error

createTime

Object

The creation timestamp of a triggeredJob, output only field.

This object should have the same structure as Timestamp

updateTime

Object

The last update timestamp of a triggeredJob, output only field.

This object should have the same structure as Timestamp

lastRunTime

Object

The timestamp of the last time this trigger executed, output only field.

This object should have the same structure as Timestamp

status

number

A status for this trigger. [required]

The number should be among the values of Status

See also

google.privacy.dlp.v2.JobTrigger definition in proto format

KAnonymityConfig

static

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

Properties

Parameter

quasiIds

Array of Object

Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.

This object should have the same structure as FieldId

entityId

Object

Optional message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account.

Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored.

This object should have the same structure as EntityId

See also

google.privacy.dlp.v2.PrivacyMetric.KAnonymityConfig definition in proto format

KAnonymityEquivalenceClass

static

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

Properties

Parameter

quasiIdsValues

Array of Object

Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message. The order is always the same as the original request.

This object should have the same structure as Value

equivalenceClassSize

number

Size of the equivalence class, for example number of rows with the above set of values.

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KAnonymityResult.KAnonymityEquivalenceClass definition in proto format

KAnonymityHistogramBucket

static

Properties

Parameter

equivalenceClassSizeLowerBound

number

Lower bound on the size of the equivalence classes in this bucket.

equivalenceClassSizeUpperBound

number

Upper bound on the size of the equivalence classes in this bucket.

bucketSize

number

Total number of equivalence classes in this bucket.

bucketValues

Array of Object

Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.

This object should have the same structure as KAnonymityEquivalenceClass

bucketValueCount

number

Total number of distinct equivalence classes in this bucket.

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KAnonymityResult.KAnonymityHistogramBucket definition in proto format

KAnonymityResult

static

Result of the k-anonymity computation.

Property

Parameter

equivalenceClassHistogramBuckets

Array of Object

Histogram of k-anonymity equivalence classes.

This object should have the same structure as KAnonymityHistogramBucket

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KAnonymityResult definition in proto format

Key

static

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.

Properties

Parameter

partitionId

Object

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

This object should have the same structure as PartitionId

path

Array of Object

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.

This object should have the same structure as PathElement

See also

google.privacy.dlp.v2.Key definition in proto format

KindExpression

static

A representation of a Datastore kind.

Property

Parameter

name

string

The name of the kind.

See also

google.privacy.dlp.v2.KindExpression definition in proto format

KMapEstimationConfig

static

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. A column with a semantic tag attached.

Properties

Parameter

quasiIds

Array of Object

Fields considered to be quasi-identifiers. No two columns can have the same tag. [required]

This object should have the same structure as TaggedField

regionCode

string

ISO 3166-1 alpha-2 region code to use in the statistical modeling. Required if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.

auxiliaryTables

Array of Object

Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.

This object should have the same structure as AuxiliaryTable

See also

google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig definition in proto format

KMapEstimationHistogramBucket

static

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.

Properties

Parameter

minAnonymity

number

Always positive.

maxAnonymity

number

Always greater than or equal to min_anonymity.

bucketSize

number

Number of records within these anonymity bounds.

bucketValues

Array of Object

Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.

This object should have the same structure as KMapEstimationQuasiIdValues

bucketValueCount

number

Total number of distinct quasi-identifier tuple values in this bucket.

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KMapEstimationResult.KMapEstimationHistogramBucket definition in proto format

KMapEstimationQuasiIdValues

static

A tuple of values for the quasi-identifier columns.

Properties

Parameter

quasiIdsValues

Array of Object

The quasi-identifier values.

This object should have the same structure as Value

estimatedAnonymity

number

The estimated anonymity for these quasi-identifier values.

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KMapEstimationResult.KMapEstimationQuasiIdValues definition in proto format

KMapEstimationResult

static

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

Property

Parameter

kMapEstimationHistogram

Array of Object

The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10.

This object should have the same structure as KMapEstimationHistogramBucket

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KMapEstimationResult definition in proto format

KmsWrappedCryptoKey

static

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

Properties

Parameter

wrappedKey

string

The wrapped data crypto key. [required]

cryptoKeyName

string

The resource name of the KMS CryptoKey to use for unwrapping. [required]

See also

google.privacy.dlp.v2.KmsWrappedCryptoKey definition in proto format

LargeCustomDictionaryConfig

static

Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the limits page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using CustomInfoType.Dictionary for smaller dictionaries that satisfy the size requirements.

Properties

Parameter

outputPath

Object

Location to store dictionary artifacts in Google Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used.

This object should have the same structure as CloudStoragePath

cloudStorageFileSet

Object

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

This object should have the same structure as CloudStorageFileSet

bigQueryField

Object

Field in a BigQuery table where each cell represents a dictionary phrase.

This object should have the same structure as BigQueryField

See also

google.privacy.dlp.v2.LargeCustomDictionaryConfig definition in proto format

LDiversityConfig

static

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

Properties

Parameter

quasiIds

Array of Object

Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.

This object should have the same structure as FieldId

sensitiveAttribute

Object

Sensitive field for computing the l-value.

This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.PrivacyMetric.LDiversityConfig definition in proto format

LDiversityEquivalenceClass

static

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

Properties

Parameter

quasiIdsValues

Array of Object

Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request.

This object should have the same structure as Value

equivalenceClassSize

number

Size of the k-anonymity equivalence class.

numDistinctSensitiveValues

number

Number of distinct sensitive values in this equivalence class.

topSensitiveValues

Array of Object

Estimated frequencies of top sensitive values.

This object should have the same structure as ValueFrequency

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.LDiversityResult.LDiversityEquivalenceClass definition in proto format

LDiversityHistogramBucket

static

Properties

Parameter

sensitiveValueFrequencyLowerBound

number

Lower bound on the sensitive value frequencies of the equivalence classes in this bucket.

sensitiveValueFrequencyUpperBound

number

Upper bound on the sensitive value frequencies of the equivalence classes in this bucket.

bucketSize

number

Total number of equivalence classes in this bucket.

bucketValues

Array of Object

Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.

This object should have the same structure as LDiversityEquivalenceClass

bucketValueCount

number

Total number of distinct equivalence classes in this bucket.

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.LDiversityResult.LDiversityHistogramBucket definition in proto format

LDiversityResult

static

Result of the l-diversity computation.

Property

Parameter

sensitiveValueFrequencyHistogramBuckets

Array of Object

Histogram of l-diversity equivalence class sensitive value frequencies.

This object should have the same structure as LDiversityHistogramBucket

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.LDiversityResult definition in proto format

LikelihoodAdjustment

static

Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.

Properties

Parameter

fixedLikelihood

number

Set the likelihood of a finding to a fixed value.

The number should be among the values of Likelihood

relativeLikelihood

number

Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be POSSIBLE without the detection rule and relative_likelihood is 1, then it is upgraded to LIKELY, while a value of -1 would downgrade it to UNLIKELY. Likelihood may never drop below VERY_UNLIKELY or exceed VERY_LIKELY, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY will result in a final likelihood of LIKELY.

See also

google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment definition in proto format

ListDeidentifyTemplatesRequest

static

Request message for ListDeidentifyTemplates.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id or organizations/my-org-id.

pageToken

string

Optional page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.

pageSize

number

Optional size of the page, can be limited by server. If zero server returns a page of max size 100.

orderBy

string

Optional 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.
See also

google.privacy.dlp.v2.ListDeidentifyTemplatesRequest definition in proto format

ListDeidentifyTemplatesResponse

static

Response message for ListDeidentifyTemplates.

Properties

Parameter

deidentifyTemplates

Array of Object

List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest.

This object should have the same structure as DeidentifyTemplate

nextPageToken

string

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

See also

google.privacy.dlp.v2.ListDeidentifyTemplatesResponse definition in proto format

ListDlpJobsRequest

static

The request message for listing DLP jobs.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id.

filter

string

Optional. 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.
  • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
  • 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)

    The length of this field should be no more than 500 characters.

pageSize

number

The standard list page size.

pageToken

string

The standard list page token.

type

number

The type of job. Defaults to DlpJobType.INSPECT

The number should be among the values of DlpJobType

orderBy

string

Optional 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
See also

google.privacy.dlp.v2.ListDlpJobsRequest definition in proto format

ListDlpJobsResponse

static

The response message for listing DLP jobs.

Properties

Parameter

jobs

Array of Object

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

This object should have the same structure as DlpJob

nextPageToken

string

The standard List next-page token.

See also

google.privacy.dlp.v2.ListDlpJobsResponse definition in proto format

ListInfoTypesRequest

static

Request for the list of infoTypes.

Properties

Parameter

languageCode

string

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

filter

string

Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.

See also

google.privacy.dlp.v2.ListInfoTypesRequest definition in proto format

ListInfoTypesResponse

static

Response to the ListInfoTypes request.

Property

Parameter

infoTypes

Array of Object

Set of sensitive infoTypes.

This object should have the same structure as InfoTypeDescription

See also

google.privacy.dlp.v2.ListInfoTypesResponse definition in proto format

ListInspectTemplatesRequest

static

Request message for ListInspectTemplates.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id or organizations/my-org-id.

pageToken

string

Optional page token to continue retrieval. Comes from previous call to ListInspectTemplates.

pageSize

number

Optional size of the page, can be limited by server. If zero server returns a page of max size 100.

orderBy

string

Optional 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.
See also

google.privacy.dlp.v2.ListInspectTemplatesRequest definition in proto format

ListInspectTemplatesResponse

static

Response message for ListInspectTemplates.

Properties

Parameter

inspectTemplates

Array of Object

List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.

This object should have the same structure as InspectTemplate

nextPageToken

string

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

See also

google.privacy.dlp.v2.ListInspectTemplatesResponse definition in proto format

ListJobTriggersRequest

static

Request message for ListJobTriggers.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id.

pageToken

string

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

pageSize

number

Optional size of the page, can be limited by a server.

orderBy

string

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

filter

string

Optional. 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:
    • status - HEALTHY|PAUSED|CANCELLED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored.
    • 'error_count' - Number of errors that have occurred while running.
  • The operator must be = or != for status and inspected_storage.

    Examples:

  • inspected_storage = cloud_storage AND status = HEALTHY

  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
  • last_run_time > \"2017-12-12T00:00:00+00:00\"

    The length of this field should be no more than 500 characters.

See also

google.privacy.dlp.v2.ListJobTriggersRequest definition in proto format

ListJobTriggersResponse

static

Response message for ListJobTriggers.

Properties

Parameter

jobTriggers

Array of Object

List of triggeredJobs, up to page_size in ListJobTriggersRequest.

This object should have the same structure as JobTrigger

nextPageToken

string

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

See also

google.privacy.dlp.v2.ListJobTriggersResponse definition in proto format

ListStoredInfoTypesRequest

static

Request message for ListStoredInfoTypes.

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id or organizations/my-org-id.

pageToken

string

Optional page token to continue retrieval. Comes from previous call to ListStoredInfoTypes.

pageSize

number

Optional size of the page, can be limited by server. If zero server returns a page of max size 100.

orderBy

string

Optional 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.
See also

google.privacy.dlp.v2.ListStoredInfoTypesRequest definition in proto format

ListStoredInfoTypesResponse

static

Response message for ListStoredInfoTypes.

Properties

Parameter

storedInfoTypes

Array of Object

List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest.

This object should have the same structure as StoredInfoType

nextPageToken

string

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

See also

google.privacy.dlp.v2.ListStoredInfoTypesResponse definition in proto format

Location

static

Specifies the location of the finding.

Properties

Parameter

byteRange

Object

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.

This object should have the same structure as Range

codepointRange

Object

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

This object should have the same structure as Range

contentLocations

Array of Object

List of nested objects pointing to the precise location of the finding within the file or record.

This object should have the same structure as ContentLocation

See also

google.privacy.dlp.v2.Location definition in proto format

NumericalStatsConfig

static

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

Property

Parameter

field

Object

Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time.

This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.PrivacyMetric.NumericalStatsConfig definition in proto format

NumericalStatsResult

static

Result of the numerical stats computation.

Properties

Parameter

minValue

Object

Minimum value appearing in the column.

This object should have the same structure as Value

maxValue

Object

Maximum value appearing in the column.

This object should have the same structure as Value

quantileValues

Array of Object

List of 99 values that partition the set of field values into 100 equal sized buckets.

This object should have the same structure as Value

See also

google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.NumericalStatsResult definition in proto format

OutputStorageConfig

static

Cloud repository for storing output.

Properties

Parameter

table

Object

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.

This object should have the same structure as BigQueryTable

outputSchema

number

Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the Finding object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted.

If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema.

The number should be among the values of OutputSchema

See also

google.privacy.dlp.v2.OutputStorageConfig definition in proto format

PartitionId

static

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.

Properties

Parameter

projectId

string

The ID of the project to which the entities belong.

namespaceId

string

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

See also

google.privacy.dlp.v2.PartitionId definition in proto format

PathElement

static

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.

Properties

Parameter

kind

string

The kind of the entity. A kind matching regex .* is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be "".

id

number

The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

name

string

The name of the entity. A name matching regex .* is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be "".

See also

google.privacy.dlp.v2.Key.PathElement definition in proto format

PrimitiveTransformation

static

A rule for transforming a value.

Properties

Parameter

replaceConfig

Object

This object should have the same structure as ReplaceValueConfig

redactConfig

Object

This object should have the same structure as RedactConfig

characterMaskConfig

Object

This object should have the same structure as CharacterMaskConfig

cryptoReplaceFfxFpeConfig

Object

This object should have the same structure as CryptoReplaceFfxFpeConfig

fixedSizeBucketingConfig

Object

This object should have the same structure as FixedSizeBucketingConfig

bucketingConfig

Object

This object should have the same structure as BucketingConfig

replaceWithInfoTypeConfig

Object

This object should have the same structure as ReplaceWithInfoTypeConfig

timePartConfig

Object

This object should have the same structure as TimePartConfig

cryptoHashConfig

Object

This object should have the same structure as CryptoHashConfig

dateShiftConfig

Object

This object should have the same structure as DateShiftConfig

cryptoDeterministicConfig

Object

This object should have the same structure as CryptoDeterministicConfig

See also

google.privacy.dlp.v2.PrimitiveTransformation definition in proto format

PrivacyMetric

static

Privacy metric to compute for reidentification risk analysis.

Properties

Parameter

numericalStatsConfig

Object

This object should have the same structure as NumericalStatsConfig

categoricalStatsConfig

Object

This object should have the same structure as CategoricalStatsConfig

kAnonymityConfig

Object

This object should have the same structure as KAnonymityConfig

lDiversityConfig

Object

This object should have the same structure as LDiversityConfig

kMapEstimationConfig

Object

This object should have the same structure as KMapEstimationConfig

deltaPresenceEstimationConfig

Object

This object should have the same structure as DeltaPresenceEstimationConfig

See also

google.privacy.dlp.v2.PrivacyMetric definition in proto format

Proximity

static

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

Properties

Parameter

windowBefore

number

Number of characters before the finding to consider.

windowAfter

number

Number of characters after the finding to consider.

See also

google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity definition in proto format

PublishSummaryToCscc

static

Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect

See also

google.privacy.dlp.v2.Action.PublishSummaryToCscc definition in proto format

PublishToPubSub

static

Publish the results of a DlpJob to a pub sub channel. Compatible with: Inspect, Risk

Property

Parameter

topic

string

Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.

See also

google.privacy.dlp.v2.Action.PublishToPubSub definition in proto format

QuasiId

static

A column with a semantic tag attached.

Properties

Parameter

field

Object

Identifies the column. [required]

This object should have the same structure as FieldId

infoType

Object

A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

This object should have the same structure as InfoType

customTag

string

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

inferred

Object

If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data

This object should have the same structure as Empty

See also

google.privacy.dlp.v2.QuasiId definition in proto format

QuasiIdentifierField

static

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

Properties

Parameter

field

Object

This object should have the same structure as FieldId

customTag

string

See also

google.privacy.dlp.v2.StatisticalTable.QuasiIdentifierField definition in proto format

QuasiIdField

static

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

Properties

Parameter

field

Object

This object should have the same structure as FieldId

customTag

string

See also

google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig.AuxiliaryTable.QuasiIdField definition in proto format

QuoteInfo

static

Message for infoType-dependent details parsed from quote.

Property

Parameter

dateTime

Object

The date time indicated by the quote.

This object should have the same structure as DateTime

See also

google.privacy.dlp.v2.QuoteInfo definition in proto format

Range

static

Generic half-open interval [start, end)

Properties

Parameter

start

number

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

end

number

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

See also

google.privacy.dlp.v2.Range definition in proto format

RecordCondition

static

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

Property

Parameter

expressions

Object

An expression.

This object should have the same structure as Expressions

See also

google.privacy.dlp.v2.RecordCondition definition in proto format

RecordKey

static

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

Properties

Parameter

datastoreKey

Object

This object should have the same structure as DatastoreKey

bigQueryKey

Object

This object should have the same structure as BigQueryKey

idValues

Array of string

Values of identifying columns in the given row. Order of values matches the order of field identifiers specified in the scanning request.

See also

google.privacy.dlp.v2.RecordKey definition in proto format

RecordLocation

static

Location of a finding within a row or record.

Properties

Parameter

recordKey

Object

Key of the finding.

This object should have the same structure as RecordKey

fieldId

Object

Field id of the field containing the finding.

This object should have the same structure as FieldId

tableLocation

Object

Location within a ContentItem.Table.

This object should have the same structure as TableLocation

See also

google.privacy.dlp.v2.RecordLocation definition in proto format

RecordSuppression

static

Configuration to suppress records whose suppression conditions evaluate to true.

Property

Parameter

condition

Object

A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content.

This object should have the same structure as RecordCondition

See also

google.privacy.dlp.v2.RecordSuppression definition in proto format

RecordTransformations

static

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

Properties

Parameter

fieldTransformations

Array of Object

Transform the record by applying various field transformations.

This object should have the same structure as FieldTransformation

recordSuppressions

Array of Object

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

This object should have the same structure as RecordSuppression

See also

google.privacy.dlp.v2.RecordTransformations definition in proto format

RedactConfig

static

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

See also

google.privacy.dlp.v2.RedactConfig definition in proto format

RedactImageRequest

static

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

Properties

Parameter

parent

string

The parent resource name, for example projects/my-project-id.

inspectConfig

Object

Configuration for the inspector.

This object should have the same structure as InspectConfig

imageRedactionConfigs

Array of Object

The configuration for specifying what content to redact from images.

This object should have the same structure as ImageRedactionConfig

includeFindings

boolean

Whether the response should include findings along with the redacted image.

byteItem

Object

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

This object should have the same structure as ByteContentItem

See also

google.privacy.dlp.v2.RedactImageRequest definition in proto format

RedactImageResponse

static

Results of redacting an image.

Properties

Parameter

redactedImage

string

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

extractedText

string

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.

inspectResult

Object

The findings. Populated when include_findings in the request is true.

This object should have the same structure as InspectResult

See also

google.privacy.dlp.v2.RedactImageResponse definition in proto format

Regex

static

Message defining a custom regular expression.

Properties

Parameter

pattern

string

Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.

groupIndexes

Array of number

The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.

See also

google.privacy.dlp.v2.CustomInfoType.Regex definition in proto format

ReidentifyContentRequest

static

Request to re-identify an item.

Properties

Parameter

parent

string

The parent resource name.

reidentifyConfig

Object

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:

  • CryptoReplaceFfxFpeConfig

    This object should have the same structure as DeidentifyConfig

inspectConfig

Object

Configuration for the inspector.

This object should have the same structure as InspectConfig

item

Object

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

This object should have the same structure as ContentItem

inspectTemplateName

string

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

reidentifyTemplateName

string

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

See also

google.privacy.dlp.v2.ReidentifyContentRequest definition in proto format

ReidentifyContentResponse

static

Results of re-identifying a item.

Properties

Parameter

item

Object

The re-identified item.

This object should have the same structure as ContentItem

overview

Object

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

This object should have the same structure as TransformationOverview

See also

google.privacy.dlp.v2.ReidentifyContentResponse definition in proto format

ReplaceValueConfig

static

Replace each input value with a given Value.

Property

Parameter

newValue

Object

Value to replace it with.

This object should have the same structure as Value

See also

google.privacy.dlp.v2.ReplaceValueConfig definition in proto format

ReplaceWithInfoTypeConfig

static

Replace each matching finding with the name of the info_type.

See also

google.privacy.dlp.v2.ReplaceWithInfoTypeConfig definition in proto format

RequestedOptions

static

Properties

Parameter

snapshotInspectTemplate

Object

If run with an InspectTemplate, a snapshot of its state at the time of this run.

This object should have the same structure as InspectTemplate

jobConfig

Object

This object should have the same structure as InspectJobConfig

See also

google.privacy.dlp.v2.InspectDataSourceDetails.RequestedOptions definition in proto format

Result

static

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

Properties

Parameter

processedBytes

number

Total size in bytes that were processed.

totalEstimatedBytes

number

Estimate of the number of bytes to process.

infoTypeStats

Array of Object

Statistics of how many instances of each info type were found during inspect job.

This object should have the same structure as InfoTypeStats

See also

google.privacy.dlp.v2.InspectDataSourceDetails.Result definition in proto format

RiskAnalysisJobConfig

static

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

Properties

Parameter

privacyMetric

Object

Privacy metric to compute.

This object should have the same structure as PrivacyMetric

sourceTable

Object

Input dataset to compute metrics over.

This object should have the same structure as BigQueryTable

actions

Array of Object

Actions to execute at the completion of the job. Are executed in the order provided.

This object should have the same structure as Action

See also

google.privacy.dlp.v2.RiskAnalysisJobConfig definition in proto format

Row

static

Property

Parameter

values

Array of Object

This object should have the same structure as Value

See also

google.privacy.dlp.v2.Table.Row definition in proto format

SaveFindings

static

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

Property

Parameter

outputConfig

Object

This object should have the same structure as OutputStorageConfig

See also

google.privacy.dlp.v2.Action.SaveFindings definition in proto format

Schedule

static

Schedule for triggeredJobs.

Property

Parameter

recurrencePeriodDuration

Object

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.

This object should have the same structure as Duration

See also

google.privacy.dlp.v2.Schedule definition in proto format

StatisticalTable

static

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

Properties

Parameter

table

Object

Auxiliary table location. [required]

This object should have the same structure as BigQueryTable

quasiIds

Array of Object

Quasi-identifier columns. [required]

This object should have the same structure as QuasiIdentifierField

relativeFrequency

Object

The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero. [required]

This object should have the same structure as FieldId

See also

google.privacy.dlp.v2.StatisticalTable definition in proto format

StorageConfig

static

Shared message indicating Cloud storage type.

Properties

Parameter

datastoreOptions

Object

Google Cloud Datastore options specification.

This object should have the same structure as DatastoreOptions

cloudStorageOptions

Object

Google Cloud Storage options specification.

This object should have the same structure as CloudStorageOptions

bigQueryOptions

Object

BigQuery options specification.

This object should have the same structure as BigQueryOptions

timespanConfig

Object

This object should have the same structure as TimespanConfig

See also

google.privacy.dlp.v2.StorageConfig definition in proto format

StoredInfoType

static

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

Properties

Parameter

name

string

Resource name.

currentVersion

Object

Current version of the stored info type.

This object should have the same structure as StoredInfoTypeVersion

pendingVersions

Array of Object

Pending versions of the stored info type. Empty if no versions are pending.

This object should have the same structure as StoredInfoTypeVersion

See also

google.privacy.dlp.v2.StoredInfoType definition in proto format

StoredInfoTypeConfig

static

Configuration for a StoredInfoType.

Properties

Parameter

displayName

string

Display name of the StoredInfoType (max 256 characters).

description

string

Description of the StoredInfoType (max 256 characters).

largeCustomDictionary

Object

StoredInfoType where findings are defined by a dictionary of phrases.

This object should have the same structure as LargeCustomDictionaryConfig

See also

google.privacy.dlp.v2.StoredInfoTypeConfig definition in proto format

StoredInfoTypeVersion

static

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

Properties

Parameter

config

Object

StoredInfoType configuration.

This object should have the same structure as StoredInfoTypeConfig

createTime

Object

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

This object should have the same structure as Timestamp

state

number

Stored info type version state. Read-only, updated by the system during dictionary creation.

The number should be among the values of StoredInfoTypeState

errors

Array of Object

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.

This object should have the same structure as Error

See also

google.privacy.dlp.v2.StoredInfoTypeVersion definition in proto format

StoredType

static

A reference to a StoredInfoType to use with scanning.

Properties

Parameter

name

string

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

createTime

Object

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

This object should have the same structure as Timestamp

See also

google.privacy.dlp.v2.StoredType definition in proto format

SummaryResult

static

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

Properties

Parameter

count

number

code

number

The number should be among the values of TransformationResultCode

details

string

A place for warnings or errors to show up if a transformation didn't work as expected.

See also

google.privacy.dlp.v2.TransformationSummary.SummaryResult definition in proto format

SurrogateType

static

Message for detecting output from deidentification transformations such as 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 as surrogate_info_type. This CustomInfoType does not support the use of detection_rules.

See also

google.privacy.dlp.v2.CustomInfoType.SurrogateType definition in proto format

Table

static

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

Properties

Parameter

headers

Array of Object

This object should have the same structure as FieldId

rows

Array of Object

This object should have the same structure as Row

See also

google.privacy.dlp.v2.Table definition in proto format

TableLocation

static

Location of a finding within a table.

Property

Parameter

rowIndex

number

The zero-based index of the row where the finding is located.

See also

google.privacy.dlp.v2.TableLocation definition in proto format

TaggedField

static

Properties

Parameter

field

Object

Identifies the column. [required]

This object should have the same structure as FieldId

infoType

Object

A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter.

This object should have the same structure as InfoType

customTag

string

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

inferred

Object

If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data

This object should have the same structure as Empty

See also

google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig.TaggedField definition in proto format

TimePartConfig

static

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

Property

Parameter

partToExtract

number

The number should be among the values of TimePart

See also

google.privacy.dlp.v2.TimePartConfig definition in proto format

TimespanConfig

static

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

Properties

Parameter

startTime

Object

Exclude files or rows older than this value.

This object should have the same structure as Timestamp

endTime

Object

Exclude files or rows newer than this value. If set to zero, no upper time limit is applied.

This object should have the same structure as Timestamp

timestampField

Object

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore or BigQuery. If not specified for BigQuery, table last modification timestamp is checked against given time span. The valid data types of the timestamp field are: for BigQuery - timestamp, date, datetime; for Datastore - timestamp. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid.

This object should have the same structure as FieldId

enableAutoPopulationOfTimespanConfig

boolean

When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.

See also

google.privacy.dlp.v2.StorageConfig.TimespanConfig definition in proto format

TimeZone

static

Property

Parameter

offsetMinutes

number

Set only if the offset can be determined. Positive for time ahead of UTC. E.g. For "UTC-9", this value is -540.

See also

google.privacy.dlp.v2.DateTime.TimeZone definition in proto format

TransformationOverview

static

Overview of the modifications that occurred.

Properties

Parameter

transformedBytes

number

Total size in bytes that were transformed in some way.

transformationSummaries

Array of Object

Transformations applied to the dataset.

This object should have the same structure as TransformationSummary

See also

google.privacy.dlp.v2.TransformationOverview definition in proto format

TransformationSummary

static

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

Properties

Parameter

infoType

Object

Set if the transformation was limited to a specific InfoType.

This object should have the same structure as InfoType

field

Object

Set if the transformation was limited to a specific FieldId.

This object should have the same structure as FieldId

transformation

Object

The specific transformation these stats apply to.

This object should have the same structure as PrimitiveTransformation

fieldTransformations

Array of Object

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.

This object should have the same structure as FieldTransformation

recordSuppress

Object

The specific suppression option these stats apply to.

This object should have the same structure as RecordSuppression

results

Array of Object

This object should have the same structure as SummaryResult

transformedBytes

number

Total size in bytes that were transformed in some way.

See also

google.privacy.dlp.v2.TransformationSummary definition in proto format

TransientCryptoKey

static

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

Property

Parameter

name

string

Name of the key. [required] This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate TransientCryptoKey protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated).

See also

google.privacy.dlp.v2.TransientCryptoKey definition in proto format

Trigger

static

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

Property

Parameter

schedule

Object

Create a job on a repeating basis based on the elapse of time.

This object should have the same structure as Schedule

See also

google.privacy.dlp.v2.JobTrigger.Trigger definition in proto format

UnwrappedCryptoKey

static

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

Property

Parameter

key

string

A 128/192/256 bit key. [required]

See also

google.privacy.dlp.v2.UnwrappedCryptoKey definition in proto format

UpdateDeidentifyTemplateRequest

static

Request message for UpdateDeidentifyTemplate.

Properties

Parameter

name

string

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

deidentifyTemplate

Object

New DeidentifyTemplate value.

This object should have the same structure as DeidentifyTemplate

updateMask

Object

Mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.privacy.dlp.v2.UpdateDeidentifyTemplateRequest definition in proto format

UpdateInspectTemplateRequest

static

Request message for UpdateInspectTemplate.

Properties

Parameter

name

string

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

inspectTemplate

Object

New InspectTemplate value.

This object should have the same structure as InspectTemplate

updateMask

Object

Mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.privacy.dlp.v2.UpdateInspectTemplateRequest definition in proto format

UpdateJobTriggerRequest

static

Request message for UpdateJobTrigger.

Properties

Parameter

name

string

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

jobTrigger

Object

New JobTrigger value.

This object should have the same structure as JobTrigger

updateMask

Object

Mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.privacy.dlp.v2.UpdateJobTriggerRequest definition in proto format

UpdateStoredInfoTypeRequest

static

Request message for UpdateStoredInfoType.

Properties

Parameter

name

string

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

config

Object

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

This object should have the same structure as StoredInfoTypeConfig

updateMask

Object

Mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.privacy.dlp.v2.UpdateStoredInfoTypeRequest definition in proto format

Value

static

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.

Properties

Parameter

integerValue

number

floatValue

number

stringValue

string

booleanValue

boolean

timestampValue

Object

This object should have the same structure as Timestamp

timeValue

Object

This object should have the same structure as TimeOfDay

dateValue

Object

This object should have the same structure as Date

dayOfWeekValue

number

The number should be among the values of DayOfWeek

See also

google.privacy.dlp.v2.Value definition in proto format

ValueFrequency

static

A value of a field, including its frequency.

Properties

Parameter

value

Object

A value contained in the field in question.

This object should have the same structure as Value

count

number

How many times the value is contained in the field.

See also

google.privacy.dlp.v2.ValueFrequency definition in proto format

WordList

static

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

Property

Parameter

words

Array of string

Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]

See also

google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList definition in proto format