Enumerations

CharacterGroup

static

number

Value

CHARACTER_GROUP_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]

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)

Likelihood

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; information with all likelihoods is included.

VERY_UNLIKELY

Few matching elements.

UNLIKELY

POSSIBLE

Some matching elements.

LIKELY

VERY_LIKELY

Many matching elements.

LogicalOperator

static

number

Value

LOGICAL_OPERATOR_UNSPECIFIED

AND

RelationalOperator

static

number

Operators available for comparing the value of fields.

Value

RELATIONAL_OPERATOR_UNSPECIFIED

EQUAL_TO

Equal.

NOT_EQUAL_TO

Not equal to.

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

TimePart

static

number

Value

TIME_PART_UNSPECIFIED

YEAR

[000-9999]

MONTH

[1-12]

DAY_OF_MONTH

[1-31]

DAY_OF_WEEK

[1-7]

WEEK_OF_YEAR

[1-52]

HOUR_OF_DAY

[0-24]

TransformationResultCode

static

number

Possible outcomes of transformations.

Value

TRANSFORMATION_RESULT_CODE_UNSPECIFIED

SUCCESS

ERROR

Properties

CharacterGroup

static

number

Value

CHARACTER_GROUP_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]

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)

Likelihood

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; information with all likelihoods is included.

VERY_UNLIKELY

Few matching elements.

UNLIKELY

POSSIBLE

Some matching elements.

LIKELY

VERY_LIKELY

Many matching elements.

LogicalOperator

static

number

Value

LOGICAL_OPERATOR_UNSPECIFIED

AND

RelationalOperator

static

number

Operators available for comparing the value of fields.

Value

RELATIONAL_OPERATOR_UNSPECIFIED

EQUAL_TO

Equal.

NOT_EQUAL_TO

Not equal to.

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

TimePart

static

number

Value

TIME_PART_UNSPECIFIED

YEAR

[000-9999]

MONTH

[1-12]

DAY_OF_MONTH

[1-31]

DAY_OF_WEEK

[1-7]

WEEK_OF_YEAR

[1-52]

HOUR_OF_DAY

[0-24]

TransformationResultCode

static

number

Possible outcomes of transformations.

Value

TRANSFORMATION_RESULT_CODE_UNSPECIFIED

SUCCESS

ERROR

Abstract types

AnalyzeDataSourceRiskRequest

static

Request for creating a risk analysis operation.

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

See also

google.privacy.dlp.v2beta1.AnalyzeDataSourceRiskRequest 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

See also

google.privacy.dlp.v2beta1.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.v2beta1.BigQueryTable definition in proto format

Bucket

static

Buckets represented as ranges, along with replacement values. Ranges must be non-overlapping.

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

Property

Parameter

buckets

Array of Object

This object should have the same structure as Bucket

See also

google.privacy.dlp.v2beta1.BucketingConfig 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.v2beta1.PrivacyMetric.CategoricalStatsConfig definition in proto format

CategoricalStatsHistogramBucket

static

Histogram bucket of value frequencies in the column.

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

See also

google.privacy.dlp.v2beta1.RiskAnalysisOperationResult.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.v2beta1.RiskAnalysisOperationResult.CategoricalStatsResult definition in proto format

CategoryDescription

static

Info Type Category description.

Properties

Parameter

name

string

Internal name of the category.

displayName

string

Human readable form of the category name.

See also

google.privacy.dlp.v2beta1.CategoryDescription 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.v2beta1.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 CharacterGroup

See also

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

CloudStorageKey

static

Record key for a finding in a Cloud Storage file.

Properties

Parameter

filePath

string

Path to the file.

startOffset

number

Byte offset of the referenced data in the file.

See also

google.privacy.dlp.v2beta1.CloudStorageKey definition in proto format

CloudStorageOptions

static

Options defining a file or a set of files (path ending with *) within a Google Cloud Storage bucket.

Property

Parameter

fileSet

Object

This object should have the same structure as FileSet

See also

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

CloudStoragePath

static

A location in Cloud Storage.

Property

Parameter

path

string

The url, in the format of gs://bucket/<path>.

See also

google.privacy.dlp.v2beta1.CloudStoragePath 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.v2beta1.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.

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 info type 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.v2beta1.RecordCondition.Condition definition in proto format

Conditions

static

Property

Parameter

conditions

Array of Object

This object should have the same structure as Condition

See also

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

ContentItem

static

Container structure for the content to inspect.

Properties

Parameter

type

string

Type of the content, as defined in Content-Type HTTP header. Supported types are: all "text" types, octet streams, PNG images, JPEG images.

data

string

Content data to inspect or redact.

value

string

String data to inspect or redact.

table

Object

Structured content for inspection.

This object should have the same structure as Table

See also

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

CreateInspectOperationRequest

static

Request for scheduling a scan of a data subset from a Google Platform data repository.

Properties

Parameter

inspectConfig

Object

Configuration for the inspector.

This object should have the same structure as InspectConfig

storageConfig

Object

Specification of the data set to process.

This object should have the same structure as StorageConfig

outputConfig

Object

Optional location to store findings.

This object should have the same structure as OutputStorageConfig

operationConfig

Object

Additional configuration settings for long running operations.

This object should have the same structure as OperationConfig

See also

google.privacy.dlp.v2beta1.CreateInspectOperationRequest definition in proto format

CryptoHashConfig

static

Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a 32 byte digest as an uppercase hex string (for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE). Currently, only string and integer values can be hashed.

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.v2beta1.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.v2beta1.CryptoKey definition in proto format

CryptoReplaceFfxFpeConfig

static

Replaces an identifier with an surrogate using FPE with the FFX mode of operation. The identifier must be representable by the US-ASCII character set. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Note that a given identifier must be either the empty string or be at least two characters long.

Properties

Parameter

cryptoKey

Object

The key used by the encryption algorithm. [required]

This object should have the same structure as CryptoKey

context

Object

A context may be used for higher security since the same identifier in two different contexts likely will be given a distinct surrogate. The principle is that the likeliness is inversely related to the ratio of the number of distinct identifiers per context over the number of possible surrogates: As long as this ratio is small, the likehood is large.

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 is also known as the 'tweak', as in tweakable encryption.

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

See also

google.privacy.dlp.v2beta1.CryptoReplaceFfxFpeConfig 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.v2beta1.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

projection

Array of Object

Properties to scan. If none are specified, all properties will be scanned by default.

This object should have the same structure as Projection

See also

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

DeidentificationSummary

static

High level summary of deidentification.

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.v2beta1.DeidentificationSummary 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.v2beta1.DeidentifyConfig definition in proto format

DeidentifyContentRequest

static

Request to de-identify a list of items.

Properties

Parameter

deidentifyConfig

Object

Configuration for the de-identification of the list of content items.

This object should have the same structure as DeidentifyConfig

inspectConfig

Object

Configuration for the inspector.

This object should have the same structure as InspectConfig

items

Array of Object

The list of items to inspect. Up to 100 are allowed per request. All items will be treated as text/*.

This object should have the same structure as ContentItem

See also

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

DeidentifyContentResponse

static

Results of de-identifying a list of items.

Properties

Parameter

items

Array of Object

This object should have the same structure as ContentItem

summaries

Array of Object

A review of the transformations that took place for each item.

This object should have the same structure as DeidentificationSummary

See also

google.privacy.dlp.v2beta1.DeidentifyContentResponse 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 be consistent across multiple rows pertaining 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.v2beta1.EntityId definition in proto format

Expressions

static

A collection of expressions

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.v2beta1.RecordCondition.Expressions definition in proto format

FieldId

static

General identifier of a data field in a storage service.

Property

Parameter

columnName

string

Name describing the field.

See also

google.privacy.dlp.v2beta1.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.v2beta1.FieldTransformation definition in proto format

FileSet

static

Set of files to scan.

Property

Parameter

url

string

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

See also

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

Finding

static

Container structure describing a single finding within a string or image.

Properties

Parameter

quote

string

The specific string that may be potentially sensitive info.

infoType

Object

The specific type of info the string might be.

This object should have the same structure as InfoType

likelihood

number

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

The number should be among the values of Likelihood

location

Object

Location of the info 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

See also

google.privacy.dlp.v2beta1.Finding 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 resulting value will be a hyphenated string of lower_bound-upper_bound. 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.

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.v2beta1.FixedSizeBucketingConfig definition in proto format

ImageLocation

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.v2beta1.ImageLocation definition in proto format

ImageRedactionConfig

static

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

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.v2beta1.RedactContentRequest.ImageRedactionConfig definition in proto format

InfoType

static

Type of information detected by the API.

Property

Parameter

name

string

Name of the information type.

See also

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

InfoTypeDescription

static

Description of the information type (infoType).

Properties

Parameter

name

string

Internal name of the infoType.

displayName

string

Human readable form of the infoType name.

categories

Array of Object

List of categories this infoType belongs to.

This object should have the same structure as CategoryDescription

See also

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

InfoTypeLimit

static

Max findings configuration per info type, per content item or long running operation.

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.v2beta1.InspectConfig.InfoTypeLimit definition in proto format

InfoTypeStatistics

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

See also

google.privacy.dlp.v2beta1.InfoTypeStatistics 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

Info types to apply the transformation to. Empty list will match all available info types for this transformation.

This object should have the same structure as InfoType

primitiveTransformation

Object

Primitive transformation to apply to the info type. [required]

This object should have the same structure as PrimitiveTransformation

See also

google.privacy.dlp.v2beta1.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 info type. Cannot specify more than one for a given info type. [required]

This object should have the same structure as InfoTypeTransformation

See also

google.privacy.dlp.v2beta1.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 found in documentation. Empty info_types runs all enabled detectors.

This object should have the same structure as InfoType

minLikelihood

number

Only returns findings equal or above this threshold.

The number should be among the values of Likelihood

maxFindings

number

Limits the number of findings per content item or long running operation.

includeQuote

boolean

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

excludeTypes

boolean

When true, excludes type information of the findings.

infoTypeLimits

Array of Object

Configuration of findings limit given for specified info types.

This object should have the same structure as InfoTypeLimit

See also

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

InspectContentRequest

static

Request to search for potentially sensitive info in a list of items.

Properties

Parameter

inspectConfig

Object

Configuration for the inspector.

This object should have the same structure as InspectConfig

items

Array of Object

The list of items to inspect. Items in a single request are considered "related" unless inspect_config.independent_inputs is true. Up to 100 are allowed per request.

This object should have the same structure as ContentItem

See also

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

InspectContentResponse

static

Results of inspecting a list of items.

Property

Parameter

results

Array of Object

Each content_item from the request has a result in this list, in the same order as the request.

This object should have the same structure as InspectResult

See also

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

InspectOperationMetadata

static

Metadata returned within GetOperation for an inspect request.

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

This object should have the same structure as InfoTypeStatistics

createTime

Object

The time which this request was started.

This object should have the same structure as Timestamp

requestInspectConfig

Object

The inspect config used to create the Operation.

This object should have the same structure as InspectConfig

requestStorageConfig

Object

The storage config used to create the Operation.

This object should have the same structure as StorageConfig

requestOutputConfig

Object

Optional location to store findings.

This object should have the same structure as OutputStorageConfig

See also

google.privacy.dlp.v2beta1.InspectOperationMetadata definition in proto format

InspectOperationResult

static

The operational data.

Property

Parameter

name

string

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of inspect/results/{id}.

See also

google.privacy.dlp.v2beta1.InspectOperationResult 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.v2beta1.InspectResult 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 each distinct EntityId should not contribute to the k-anonymity count more than once per equivalence class.

This object should have the same structure as EntityId

See also

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

KAnonymityEquivalenceClass

static

The set of columns' values that share the same k-anonymity 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.v2beta1.RiskAnalysisOperationResult.KAnonymityResult.KAnonymityEquivalenceClass definition in proto format

KAnonymityHistogramBucket

static

Histogram bucket of equivalence class sizes in the table.

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

See also

google.privacy.dlp.v2beta1.RiskAnalysisOperationResult.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.v2beta1.RiskAnalysisOperationResult.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.v2beta1.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.v2beta1.KindExpression definition in proto format

KmsWrappedCryptoKey

static

Include to use an existing data crypto key wrapped by KMS. 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.v2beta1.KmsWrappedCryptoKey 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.v2beta1.PrivacyMetric.LDiversityConfig definition in proto format

LDiversityEquivalenceClass

static

The set of columns' values that share the same l-diversity 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.v2beta1.RiskAnalysisOperationResult.LDiversityResult.LDiversityEquivalenceClass definition in proto format

LDiversityHistogramBucket

static

Histogram bucket of sensitive value frequencies in the table.

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

See also

google.privacy.dlp.v2beta1.RiskAnalysisOperationResult.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.v2beta1.RiskAnalysisOperationResult.LDiversityResult definition in proto format

ListInfoTypesRequest

static

Request for the list of info types belonging to a given category, or all supported info types if no category is specified.

Properties

Parameter

category

string

Category name as returned by ListRootCategories.

languageCode

string

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

See also

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

ListInfoTypesResponse

static

Response to the ListInfoTypes request.

Property

Parameter

infoTypes

Array of Object

Set of sensitive info types belonging to a category.

This object should have the same structure as InfoTypeDescription

See also

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

ListInspectFindingsRequest

static

Request for the list of results in a given inspect operation.

Properties

Parameter

name

string

Identifier of the results set returned as metadata of the longrunning operation created by a call to InspectDataSource. Should be in the format of inspect/results/{id}.

pageSize

number

Maximum number of results to return. If 0, the implementation selects a reasonable value.

pageToken

string

The value returned by the last ListInspectFindingsResponse; indicates that this is a continuation of a prior ListInspectFindings call, and that the system should return the next page of data.

filter

string

Restricts findings to items that match. Supports info_type and likelihood.

Examples:

  • info_type=EMAIL_ADDRESS
  • info_type=PHONE_NUMBER,EMAIL_ADDRESS
  • likelihood=VERY_LIKELY
  • likelihood=VERY_LIKELY,LIKELY
  • info_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY
See also

google.privacy.dlp.v2beta1.ListInspectFindingsRequest definition in proto format

ListInspectFindingsResponse

static

Response to the ListInspectFindings request.

Properties

Parameter

result

Object

The results.

This object should have the same structure as InspectResult

nextPageToken

string

If not empty, indicates that there may be more results that match the request; this value should be passed in a new ListInspectFindingsRequest.

See also

google.privacy.dlp.v2beta1.ListInspectFindingsResponse definition in proto format

ListRootCategoriesRequest

static

Request for root categories of Info Types supported by the API. Example values might include "FINANCE", "HEALTH", "FAST", "DEFAULT".

Property

Parameter

languageCode

string

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

See also

google.privacy.dlp.v2beta1.ListRootCategoriesRequest definition in proto format

ListRootCategoriesResponse

static

Response for ListRootCategories request.

Property

Parameter

categories

Array of Object

List of all into type categories supported by the API.

This object should have the same structure as CategoryDescription

See also

google.privacy.dlp.v2beta1.ListRootCategoriesResponse definition in proto format

Location

static

Specifies the location of a finding within its source item.

Properties

Parameter

byteRange

Object

Zero-based byte offsets within a content item.

This object should have the same structure as Range

codepointRange

Object

Character offsets within a content item, included when content type is a text. Default charset assumed to be UTF-8.

This object should have the same structure as Range

imageBoxes

Array of Object

Location within an image's pixels.

This object should have the same structure as ImageLocation

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.v2beta1.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.v2beta1.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.v2beta1.RiskAnalysisOperationResult.NumericalStatsResult definition in proto format

OperationConfig

static

Additional configuration for inspect long running operations.

Property

Parameter

maxItemFindings

number

Max number of findings per file, Datastore entity, or database row.

See also

google.privacy.dlp.v2beta1.OperationConfig definition in proto format

OutputStorageConfig

static

Cloud repository for storing output.

Properties

Parameter

table

Object

Store findings in a new table in the dataset.

This object should have the same structure as BigQueryTable

storagePath

Object

The path to a Google Cloud Storage location to store output. The bucket must already exist and the Google APIs service account for DLP must have write permission to write to the given bucket. Results are split over multiple csv files with each file name matching the pattern "[operationid][count].csv", for example 3094877188788974909_1.csv. The operation_id matches the identifier for the Operation, and the count is a counter used for tracking the number of files written.

The CSV file(s) contain the following columns regardless of storage type scanned:

  • id
  • info_type
  • likelihood
  • byte size of finding
  • quote
  • timestamp

    For Cloud Storage the next columns are:

  • file_path

  • start_offset

    For Cloud Datastore the next columns are:

  • project_id

  • namespace_id
  • path
  • column_name
  • offset

    For BigQuery the next columns are:

  • row_number

  • project_id
  • dataset_id
  • table_id

    This object should have the same structure as CloudStoragePath

See also

google.privacy.dlp.v2beta1.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.v2beta1.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.v2beta1.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

See also

google.privacy.dlp.v2beta1.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

See also

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

Projection

static

A representation of a Datastore property in a projection.

Property

Parameter

property

Object

The property to project.

This object should have the same structure as PropertyReference

See also

google.privacy.dlp.v2beta1.Projection definition in proto format

PropertyReference

static

A reference to a property relative to the Datastore kind expressions.

Property

Parameter

name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.

See also

google.privacy.dlp.v2beta1.PropertyReference 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.v2beta1.Range definition in proto format

RecordCondition

static

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

Property

Parameter

expressions

Object

This object should have the same structure as Expressions

See also

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

RecordKey

static

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

Properties

Parameter

cloudStorageKey

Object

This object should have the same structure as CloudStorageKey

datastoreKey

Object

This object should have the same structure as DatastoreKey

See also

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

RecordSuppression

static

Configuration to suppress records whose suppression conditions evaluate to true.

Property

Parameter

condition

Object

This object should have the same structure as RecordCondition

See also

google.privacy.dlp.v2beta1.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.v2beta1.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.v2beta1.RedactConfig definition in proto format

RedactContentRequest

static

Request to search for potentially sensitive info in a list of items and replace it with a default or provided content.

Properties

Parameter

inspectConfig

Object

Configuration for the inspector.

This object should have the same structure as InspectConfig

items

Array of Object

The list of items to inspect. Up to 100 are allowed per request.

This object should have the same structure as ContentItem

replaceConfigs

Array of Object

The strings to replace findings text findings with. Must specify at least one of these or one ImageRedactionConfig if redacting images.

This object should have the same structure as ReplaceConfig

imageRedactionConfigs

Array of Object

The configuration for specifying what content to redact from images.

This object should have the same structure as ImageRedactionConfig

See also

google.privacy.dlp.v2beta1.RedactContentRequest definition in proto format

RedactContentResponse

static

Results of redacting a list of items.

Property

Parameter

items

Array of Object

The redacted content.

This object should have the same structure as ContentItem

See also

google.privacy.dlp.v2beta1.RedactContentResponse definition in proto format

ReplaceConfig

static

Properties

Parameter

infoType

Object

Type of information to replace. Only one ReplaceConfig per info_type should be provided. If ReplaceConfig does not have an info_type, the DLP API matches it against all info_types that are found but not specified in another ReplaceConfig.

This object should have the same structure as InfoType

replaceWith

string

Content replacing sensitive information of given type. Max 256 chars.

See also

google.privacy.dlp.v2beta1.RedactContentRequest.ReplaceConfig 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.v2beta1.ReplaceValueConfig definition in proto format

ReplaceWithInfoTypeConfig

static

Replace each matching finding with the name of the info_type.

See also

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

RiskAnalysisOperationMetadata

static

Metadata returned within the riskAnalysis.operations.get for risk analysis.

Properties

Parameter

createTime

Object

The time which this request was started.

This object should have the same structure as Timestamp

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

See also

google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata definition in proto format

RiskAnalysisOperationResult

static

Result of a risk analysis Operation request.

Properties

Parameter

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

See also

google.privacy.dlp.v2beta1.RiskAnalysisOperationResult 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.v2beta1.Table.Row 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

See also

google.privacy.dlp.v2beta1.StorageConfig 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.v2beta1.TransformationSummary.SummaryResult definition in proto format

Table

static

Structured content to inspect. Up to 50,000 Values per request allowed.

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.v2beta1.Table definition in proto format

TableLocation

static

Location of a finding within a ContentItem.Table.

Property

Parameter

rowIndex

number

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

See also

google.privacy.dlp.v2beta1.TableLocation 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.v2beta1.TimePartConfig definition in proto format

TransformationSummary

static

Summary of a single tranformation.

Properties

Parameter

infoType

Object

Set if the transformation was limited to a specific info_type.

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. This list will contain multiple only in the case of errors.

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

See also

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

TransientCryptoKey

static

Use this to have a random data crypto key generated. It will be discarded after the operation/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.v2beta1.TransientCryptoKey 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

The AES 128/192/256 bit key. [required]

See also

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

Value

static

Set of primitive values supported by the system.

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

See also

google.privacy.dlp.v2beta1.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.v2beta1.ValueFrequency definition in proto format