services/google/dlp/beta/deidentify_template.yaml (6,399 lines of code) (raw):
# Copyright 2025 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
info:
title: Dlp/DeidentifyTemplate
description: The Dlp DeidentifyTemplate resource
x-dcl-struct-name: DeidentifyTemplate
x-dcl-has-iam: false
paths:
get:
description: The function used to get information about a DeidentifyTemplate
parameters:
- name: deidentifyTemplate
required: true
description: A full instance of a DeidentifyTemplate
apply:
description: The function used to apply information about a DeidentifyTemplate
parameters:
- name: deidentifyTemplate
required: true
description: A full instance of a DeidentifyTemplate
delete:
description: The function used to delete a DeidentifyTemplate
parameters:
- name: deidentifyTemplate
required: true
description: A full instance of a DeidentifyTemplate
deleteAll:
description: The function used to delete all DeidentifyTemplate
parameters:
- name: location
required: true
schema:
type: string
- name: parent
required: true
schema:
type: string
list:
description: The function used to list information about many DeidentifyTemplate
parameters:
- name: location
required: true
schema:
type: string
- name: parent
required: true
schema:
type: string
components:
schemas:
DeidentifyTemplate:
title: DeidentifyTemplate
x-dcl-id: '{{parent}}/deidentifyTemplates/{{name}}'
x-dcl-locations:
- region
x-dcl-has-create: true
x-dcl-has-iam: false
x-dcl-read-timeout: 0
x-dcl-apply-timeout: 0
x-dcl-delete-timeout: 0
type: object
required:
- parent
properties:
createTime:
type: string
format: date-time
x-dcl-go-name: CreateTime
readOnly: true
description: Output only. The creation timestamp of an inspectTemplate.
x-kubernetes-immutable: true
deidentifyConfig:
type: object
x-dcl-go-name: DeidentifyConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfig
description: The core content of the template.
properties:
infoTypeTransformations:
type: object
x-dcl-go-name: InfoTypeTransformations
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformations
description: Treat the dataset as free-form text and apply the same
free text transformation everywhere.
x-dcl-conflicts:
- recordTransformations
required:
- transformations
properties:
transformations:
type: array
x-dcl-go-name: Transformations
description: Required. Transformation for each infoType. Cannot
specify more than one for a given infoType.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformations
required:
- primitiveTransformation
properties:
infoTypes:
type: array
x-dcl-go-name: InfoTypes
description: 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`.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsInfoTypes
properties:
name:
type: string
x-dcl-go-name: Name
description: Name of the information type. Either a
name of your choosing when creating a CustomInfoType,
or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference
when specifying a built-in type. When sending Cloud
DLP results to Data Catalog, infoType names should
conform to the pattern `[A-Za-z0-9$-_]{1,64}`.
primitiveTransformation:
type: object
x-dcl-go-name: PrimitiveTransformation
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformation
description: Required. Primitive transformation to apply to
the infoType.
properties:
bucketingConfig:
type: object
x-dcl-go-name: BucketingConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfig
description: Bucketing
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
buckets:
type: array
x-dcl-go-name: Buckets
description: Set of buckets. Ranges must be non-overlapping.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBuckets
required:
- replacementValue
properties:
max:
type: object
x-dcl-go-name: Max
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMax
description: Upper bound of the range, exclusive;
type must match min.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMaxDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be
from 1 to 31 and valid for the year
and month, or 0 to specify a year
by itself or a year and month where
the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be
from 1 to 12, or 0 to specify a year
without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMaxDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMaxTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour
format. Should be from 0 to 23. An
API may choose to allow the value
"24:00:00" for scenarios like business
closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day.
Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in
nanoseconds. Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the
time. Must normally be from 0 to 59.
An API may allow the value 60 if it
allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
min:
type: object
x-dcl-go-name: Min
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMin
description: Lower bound of the range, inclusive.
Type should be the same as max if used.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMinDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be
from 1 to 31 and valid for the year
and month, or 0 to specify a year
by itself or a year and month where
the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be
from 1 to 12, or 0 to specify a year
without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMinDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMinTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour
format. Should be from 0 to 23. An
API may choose to allow the value
"24:00:00" for scenarios like business
closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day.
Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in
nanoseconds. Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the
time. Must normally be from 0 to 59.
An API may allow the value 60 if it
allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
replacementValue:
type: object
x-dcl-go-name: ReplacementValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValue
description: Required. Replacement value for
this bucket.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be
from 1 to 31 and valid for the year
and month, or 0 to specify a year
by itself or a year and month where
the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be
from 1 to 12, or 0 to specify a year
without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour
format. Should be from 0 to 23. An
API may choose to allow the value
"24:00:00" for scenarios like business
closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day.
Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in
nanoseconds. Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the
time. Must normally be from 0 to 59.
An API may allow the value 60 if it
allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
characterMaskConfig:
type: object
x-dcl-go-name: CharacterMaskConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCharacterMaskConfig
description: Mask
x-dcl-conflicts:
- replaceConfig
- redactConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
charactersToIgnore:
type: array
x-dcl-go-name: CharactersToIgnore
description: When masking a string, items in this
list will be skipped when replacing characters.
For example, if the input string is `555-555-5555`
and you instruct Cloud DLP to skip `-` and mask
5 characters with `*`, Cloud DLP returns `***-**5-5555`.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCharacterMaskConfigCharactersToIgnore
properties:
charactersToSkip:
type: string
x-dcl-go-name: CharactersToSkip
description: Characters to not transform when
masking.
x-dcl-conflicts:
- commonCharactersToIgnore
commonCharactersToIgnore:
type: string
x-dcl-go-name: CommonCharactersToIgnore
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCharacterMaskConfigCharactersToIgnoreCommonCharactersToIgnoreEnum
description: 'Common characters to not transform
when masking. Useful to avoid removing punctuation.
Possible values: COMMON_CHARS_TO_IGNORE_UNSPECIFIED,
NUMERIC, ALPHA_UPPER_CASE, ALPHA_LOWER_CASE,
PUNCTUATION, WHITESPACE'
x-dcl-conflicts:
- charactersToSkip
enum:
- COMMON_CHARS_TO_IGNORE_UNSPECIFIED
- NUMERIC
- ALPHA_UPPER_CASE
- ALPHA_LOWER_CASE
- PUNCTUATION
- WHITESPACE
maskingCharacter:
type: string
x-dcl-go-name: MaskingCharacter
description: Character to use to mask the sensitive
values—for example, `*` for an alphabetic string
such as a name, or `0` for a numeric string such
as ZIP code or credit card number. This string must
have a length of 1. If not supplied, this value
defaults to `*` for strings, and `0` for digits.
numberToMask:
type: integer
format: int64
x-dcl-go-name: NumberToMask
description: Number of characters to mask. If not
set, all matching chars will be masked. Skipped
characters do not count towards this tally.
reverseOrder:
type: boolean
x-dcl-go-name: ReverseOrder
description: Mask characters in reverse order. For
example, if `masking_character` is `0`, `number_to_mask`
is `14`, and `reverse_order` is `false`, then the
input string `1234-5678-9012-3456` is masked as
`00000000000000-3456`. If `masking_character` is
`*`, `number_to_mask` is `3`, and `reverse_order`
is `true`, then the string `12345` is masked as
`12***`.
cryptoDeterministicConfig:
type: object
x-dcl-go-name: CryptoDeterministicConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfig
description: Deterministic Crypto
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
properties:
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigContext
description: '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
`ContentItem`s.'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKey
description: The key used by the encryption function.
For deterministic encryption using AES-SIV, the
provided key is internally expanded to 64 bytes
prior to use.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource name of
the KMS CryptoKey to use for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped data crypto
key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256 bit key.
surrogateInfoType:
type: object
x-dcl-go-name: SurrogateInfoType
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigSurrogateInfoType
description: 'The custom info type to annotate the
surrogate with. This annotation will be applied
to the surrogate by prefixing it with the name of
the custom info type followed by the number of characters
comprising the surrogate. The following scheme defines
the format: {info type name}({surrogate character
count}):{surrogate} For example, if the name of
custom info type is ''MY_TOKEN_INFO_TYPE'' and the
surrogate is ''abc'', the full replacement value
will be: ''MY_TOKEN_INFO_TYPE(3):abc'' This annotation
identifies the surrogate when inspecting content
using the custom info type ''Surrogate''. This facilitates
reversal of the surrogate when it occurs in free
text. Note: For record transformations where the
entire cell in a table is being transformed, surrogates
are not mandatory. Surrogates are used to denote
the location of the token and are necessary for
re-identification in free form text. In order for
inspection to work properly, the name of this info
type must not occur naturally anywhere in your data;
otherwise, inspection may either - reverse a surrogate
that does not correspond to an actual identifier
- be unable to parse the surrogate and result in
an error Therefore, choose your custom info type
name carefully after considering what your data
looks like. One way to select a name that has a
high chance of yielding reliable detection is to
include one or more unicode characters that are
highly improbable to exist in your data. For example,
assuming your data is entered from a regular ASCII
keyboard, the symbol with the hex code point 29DD
might be used like so: ⧝MY_TOKEN_TYPE.'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name of the information type. Either
a name of your choosing when creating a CustomInfoType,
or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference
when specifying a built-in type. When sending
Cloud DLP results to Data Catalog, infoType
names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.
cryptoHashConfig:
type: object
x-dcl-go-name: CryptoHashConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfig
description: Crypto
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfigCryptoKey
description: The key used by the hash function.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource name of
the KMS CryptoKey to use for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped data crypto
key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256 bit key.
cryptoReplaceFfxFpeConfig:
type: object
x-dcl-go-name: CryptoReplaceFfxFpeConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfig
description: Ffx-Fpe
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
required:
- cryptoKey
properties:
commonAlphabet:
type: string
x-dcl-go-name: CommonAlphabet
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCommonAlphabetEnum
description: 'Common alphabets. Possible values: FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED,
NUMERIC, HEXADECIMAL, UPPER_CASE_ALPHA_NUMERIC,
ALPHA_NUMERIC'
x-dcl-conflicts:
- customAlphabet
- radix
enum:
- FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED
- NUMERIC
- HEXADECIMAL
- UPPER_CASE_ALPHA_NUMERIC
- ALPHA_NUMERIC
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigContext
description: '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 1. the field is not present when transforming
a given value, a default tweak will be used. Note
that case (1) is expected when an `InfoTypeTransformation`
is applied to both structured and non-structured
`ContentItem`s. Currently, the referenced field
may be of value type integer or string. The tweak
is constructed as a sequence of bytes in big endian
byte order such that: - a 64 bit integer is encoded
followed by a single byte of value 1 - a string
is encoded in UTF-8 format followed by a single
byte of value 2'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKey
description: Required. The key used by the encryption
algorithm.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource name of
the KMS CryptoKey to use for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped data crypto
key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256 bit key.
customAlphabet:
type: string
x-dcl-go-name: CustomAlphabet
description: '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, 95]. This
must be encoded as ASCII. The order of characters
does not matter. The full list of allowed characters
is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
~`!@#$%^&*()_-+={[}]|:;"''<,>.?/``'
x-dcl-conflicts:
- commonAlphabet
- radix
radix:
type: integer
format: int64
x-dcl-go-name: Radix
description: The native way to select the alphabet.
Must be in the range [2, 95].
x-dcl-conflicts:
- commonAlphabet
- customAlphabet
surrogateInfoType:
type: object
x-dcl-go-name: SurrogateInfoType
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigSurrogateInfoType
description: '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`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#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'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name of the information type. Either
a name of your choosing when creating a CustomInfoType,
or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference
when specifying a built-in type. When sending
Cloud DLP results to Data Catalog, infoType
names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.
dateShiftConfig:
type: object
x-dcl-go-name: DateShiftConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfig
description: Date Shift
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- cryptoDeterministicConfig
required:
- upperBoundDays
- lowerBoundDays
properties:
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigContext
description: Points to the field that contains the
context, for example, an entity id. If set, must
also set cryptoKey. If set, shift will be consistent
for the given context.
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigCryptoKey
description: 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.
If set, must also set context. Can only be applied
to table items.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource name of
the KMS CryptoKey to use for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped data crypto
key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256 bit key.
lowerBoundDays:
type: integer
format: int64
x-dcl-go-name: LowerBoundDays
description: Required. For example, -5 means shift
date to at most 5 days back in the past.
upperBoundDays:
type: integer
format: int64
x-dcl-go-name: UpperBoundDays
description: Required. 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.
fixedSizeBucketingConfig:
type: object
x-dcl-go-name: FixedSizeBucketingConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfig
description: Fixed size bucketing
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
required:
- lowerBound
- upperBound
- bucketSize
properties:
bucketSize:
type: number
format: double
x-dcl-go-name: BucketSize
description: 'Required. 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.'
lowerBound:
type: object
x-dcl-go-name: LowerBound
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBound
description: Required. 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".
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be from
1 to 31 and valid for the year and month,
or 0 to specify a year by itself or a year
and month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be from
1 to 12, or 0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must be from
1 to 9999, or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundDayOfWeekValueEnum
description: 'day of week Possible values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
SATURDAY, SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour format.
Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day. Must
be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the time.
Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
upperBound:
type: object
x-dcl-go-name: UpperBound
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBound
description: Required. Upper bound value of buckets.
All values greater than upper_bound are grouped
together into a single bucket; for example if `upper_bound`
= 89, then all values greater than 89 are replaced
with the value "89+".
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be from
1 to 31 and valid for the year and month,
or 0 to specify a year by itself or a year
and month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be from
1 to 12, or 0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must be from
1 to 9999, or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundDayOfWeekValueEnum
description: 'day of week Possible values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
SATURDAY, SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour format.
Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day. Must
be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the time.
Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
redactConfig:
type: object
x-dcl-go-name: RedactConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationRedactConfig
description: Redact
x-dcl-conflicts:
- replaceConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
x-dcl-send-empty: true
replaceConfig:
type: object
x-dcl-go-name: ReplaceConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfig
description: Replace with a specified value.
x-dcl-conflicts:
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
newValue:
type: object
x-dcl-go-name: NewValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfigNewValue
description: Value to replace it with.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfigNewValueDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be from
1 to 31 and valid for the year and month,
or 0 to specify a year by itself or a year
and month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be from
1 to 12, or 0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must be from
1 to 9999, or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfigNewValueDayOfWeekValueEnum
description: 'day of week Possible values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
SATURDAY, SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfigNewValueTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour format.
Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day. Must
be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the time.
Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
replaceWithInfoTypeConfig:
type: object
x-dcl-go-name: ReplaceWithInfoTypeConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceWithInfoTypeConfig
description: Replace with infotype
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
x-dcl-send-empty: true
timePartConfig:
type: object
x-dcl-go-name: TimePartConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationTimePartConfig
description: Time extraction
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
partToExtract:
type: string
x-dcl-go-name: PartToExtract
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationsPrimitiveTransformationTimePartConfigPartToExtractEnum
description: 'The part of the time to keep. Possible
values: TIME_PART_UNSPECIFIED, YEAR, MONTH, DAY_OF_MONTH,
DAY_OF_WEEK, WEEK_OF_YEAR, HOUR_OF_DAY'
enum:
- TIME_PART_UNSPECIFIED
- YEAR
- MONTH
- DAY_OF_MONTH
- DAY_OF_WEEK
- WEEK_OF_YEAR
- HOUR_OF_DAY
recordTransformations:
type: object
x-dcl-go-name: RecordTransformations
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformations
description: Treat the dataset as structured. Transformations can be
applied to specific locations within structured datasets, such as
transforming a column within a table.
x-dcl-conflicts:
- infoTypeTransformations
properties:
fieldTransformations:
type: array
x-dcl-go-name: FieldTransformations
description: Transform the record by applying various field transformations.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformations
required:
- fields
properties:
condition:
type: object
x-dcl-go-name: Condition
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsCondition
description: 'Only apply the transformation if the condition
evaluates to true for the given `RecordCondition`. The conditions
are allowed to reference fields that are not used in the
actual transformation. Example Use Cases: - Apply a different
bucket transformation to an age column if the zip code column
for the same record is within a specific range. - Redact
a field if the date of birth field is greater than 85.'
properties:
expressions:
type: object
x-dcl-go-name: Expressions
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressions
description: An expression.
properties:
conditions:
type: object
x-dcl-go-name: Conditions
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsConditions
description: Conditions to apply to the expression.
properties:
conditions:
type: array
x-dcl-go-name: Conditions
description: A collection of conditions.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsConditionsConditions
required:
- field
- operator
properties:
field:
type: object
x-dcl-go-name: Field
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsConditionsConditionsField
description: Required. Field within the
record this condition is evaluated against.
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
operator:
type: string
x-dcl-go-name: Operator
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsConditionsConditionsOperatorEnum
description: 'Required. Operator used to
compare the field or infoType to the value.
Possible values: LOGICAL_OPERATOR_UNSPECIFIED,
AND'
enum:
- LOGICAL_OPERATOR_UNSPECIFIED
- AND
value:
type: object
x-dcl-go-name: Value
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsConditionsConditionsValue
description: Value to compare against. [Mandatory,
except for `EXISTS` tests.]
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsConditionsConditionsValueDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must
be from 1 to 31 and valid for
the year and month, or 0 to specify
a year by itself or a year and
month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must
be from 1 to 12, or 0 to specify
a year without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsConditionsConditionsValueDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsConditionsConditionsValueTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24
hour format. Should be from 0
to 23. An API may choose to allow
the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of
day. Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds
in nanoseconds. Must be from 0
to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes
of the time. Must normally be
from 0 to 59. An API may allow
the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
logicalOperator:
type: string
x-dcl-go-name: LogicalOperator
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsConditionExpressionsLogicalOperatorEnum
description: 'The operator to apply to the result
of conditions. Default and currently only supported
value is `AND`. Possible values: LOGICAL_OPERATOR_UNSPECIFIED,
AND'
enum:
- LOGICAL_OPERATOR_UNSPECIFIED
- AND
fields:
type: array
x-dcl-go-name: Fields
description: Required. Input field(s) to apply the transformation
to. When you have columns that reference their position
within a list, omit the index from the FieldId. FieldId
name matching ignores the index. For example, instead of
"contact.nums[0].type", use "contact.nums.type".
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsFields
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
infoTypeTransformations:
type: object
x-dcl-go-name: InfoTypeTransformations
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformations
description: Treat the contents of the field as free text,
and selectively transform content that matches an `InfoType`.
x-dcl-conflicts:
- primitiveTransformation
required:
- transformations
properties:
transformations:
type: array
x-dcl-go-name: Transformations
description: Required. Transformation for each infoType.
Cannot specify more than one for a given infoType.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformations
required:
- primitiveTransformation
properties:
infoTypes:
type: array
x-dcl-go-name: InfoTypes
description: 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`.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsInfoTypes
properties:
name:
type: string
x-dcl-go-name: Name
description: Name of the information type.
Either a name of your choosing when creating
a CustomInfoType, or one of the names listed
at https://cloud.google.com/dlp/docs/infotypes-reference
when specifying a built-in type. When sending
Cloud DLP results to Data Catalog, infoType
names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.
primitiveTransformation:
type: object
x-dcl-go-name: PrimitiveTransformation
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformation
description: Required. Primitive transformation
to apply to the infoType.
properties:
bucketingConfig:
type: object
x-dcl-go-name: BucketingConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfig
description: Bucketing
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
buckets:
type: array
x-dcl-go-name: Buckets
description: Set of buckets. Ranges must
be non-overlapping.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBuckets
required:
- replacementValue
properties:
max:
type: object
x-dcl-go-name: Max
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMax
description: Upper bound of the range,
exclusive; type must match min.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMaxDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month.
Must be from 1 to 31 and
valid for the year and month,
or 0 to specify a year by
itself or a year and month
where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year.
Must be from 1 to 12, or
0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date.
Must be from 1 to 9999,
or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMaxDayOfWeekValueEnum
description: 'day of week Possible
values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY,
THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMaxTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day
in 24 hour format. Should
be from 0 to 23. An API
may choose to allow the
value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour
of day. Must be from 0 to
59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of
seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes
of the time. Must normally
be from 0 to 59. An API
may allow the value 60 if
it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
min:
type: object
x-dcl-go-name: Min
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMin
description: Lower bound of the range,
inclusive. Type should be the same
as max if used.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMinDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month.
Must be from 1 to 31 and
valid for the year and month,
or 0 to specify a year by
itself or a year and month
where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year.
Must be from 1 to 12, or
0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date.
Must be from 1 to 9999,
or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMinDayOfWeekValueEnum
description: 'day of week Possible
values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY,
THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsMinTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day
in 24 hour format. Should
be from 0 to 23. An API
may choose to allow the
value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour
of day. Must be from 0 to
59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of
seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes
of the time. Must normally
be from 0 to 59. An API
may allow the value 60 if
it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
replacementValue:
type: object
x-dcl-go-name: ReplacementValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValue
description: Required. Replacement
value for this bucket.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month.
Must be from 1 to 31 and
valid for the year and month,
or 0 to specify a year by
itself or a year and month
where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year.
Must be from 1 to 12, or
0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date.
Must be from 1 to 9999,
or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueDayOfWeekValueEnum
description: 'day of week Possible
values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY,
THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day
in 24 hour format. Should
be from 0 to 23. An API
may choose to allow the
value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour
of day. Must be from 0 to
59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of
seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes
of the time. Must normally
be from 0 to 59. An API
may allow the value 60 if
it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
characterMaskConfig:
type: object
x-dcl-go-name: CharacterMaskConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCharacterMaskConfig
description: Mask
x-dcl-conflicts:
- replaceConfig
- redactConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
charactersToIgnore:
type: array
x-dcl-go-name: CharactersToIgnore
description: When masking a string, items
in this list will be skipped when replacing
characters. For example, if the input
string is `555-555-5555` and you instruct
Cloud DLP to skip `-` and mask 5 characters
with `*`, Cloud DLP returns `***-**5-5555`.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCharacterMaskConfigCharactersToIgnore
properties:
charactersToSkip:
type: string
x-dcl-go-name: CharactersToSkip
description: Characters to not transform
when masking.
x-dcl-conflicts:
- commonCharactersToIgnore
commonCharactersToIgnore:
type: string
x-dcl-go-name: CommonCharactersToIgnore
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCharacterMaskConfigCharactersToIgnoreCommonCharactersToIgnoreEnum
description: 'Common characters to
not transform when masking. Useful
to avoid removing punctuation. Possible
values: COMMON_CHARS_TO_IGNORE_UNSPECIFIED,
NUMERIC, ALPHA_UPPER_CASE, ALPHA_LOWER_CASE,
PUNCTUATION, WHITESPACE'
x-dcl-conflicts:
- charactersToSkip
enum:
- COMMON_CHARS_TO_IGNORE_UNSPECIFIED
- NUMERIC
- ALPHA_UPPER_CASE
- ALPHA_LOWER_CASE
- PUNCTUATION
- WHITESPACE
maskingCharacter:
type: string
x-dcl-go-name: MaskingCharacter
description: Character to use to mask the
sensitive values—for example, `*` for
an alphabetic string such as a name, or
`0` for a numeric string such as ZIP code
or credit card number. This string must
have a length of 1. If not supplied, this
value defaults to `*` for strings, and
`0` for digits.
numberToMask:
type: integer
format: int64
x-dcl-go-name: NumberToMask
description: Number of characters to mask.
If not set, all matching chars will be
masked. Skipped characters do not count
towards this tally.
reverseOrder:
type: boolean
x-dcl-go-name: ReverseOrder
description: Mask characters in reverse
order. For example, if `masking_character`
is `0`, `number_to_mask` is `14`, and
`reverse_order` is `false`, then the input
string `1234-5678-9012-3456` is masked
as `00000000000000-3456`. If `masking_character`
is `*`, `number_to_mask` is `3`, and `reverse_order`
is `true`, then the string `12345` is
masked as `12***`.
cryptoDeterministicConfig:
type: object
x-dcl-go-name: CryptoDeterministicConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfig
description: Deterministic Crypto
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
properties:
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigContext
description: '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
`ContentItem`s.'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKey
description: The key used by the encryption
function. For deterministic encryption
using AES-SIV, the provided key is internally
expanded to 64 bytes prior to use.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud
KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource
name of the KMS CryptoKey to use
for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped
data crypto key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of
the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256
bit key.
surrogateInfoType:
type: object
x-dcl-go-name: SurrogateInfoType
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoDeterministicConfigSurrogateInfoType
description: 'The custom info type to annotate
the surrogate with. This annotation will
be applied to the surrogate by prefixing
it with the name of the custom info type
followed by the number of characters comprising
the surrogate. The following scheme defines
the format: {info type name}({surrogate
character count}):{surrogate} For example,
if the name of custom info type is ''MY_TOKEN_INFO_TYPE''
and the surrogate is ''abc'', the full
replacement value will be: ''MY_TOKEN_INFO_TYPE(3):abc''
This annotation identifies the surrogate
when inspecting content using the custom
info type ''Surrogate''. This facilitates
reversal of the surrogate when it occurs
in free text. Note: For record transformations
where the entire cell in a table is being
transformed, surrogates are not mandatory.
Surrogates are used to denote the location
of the token and are necessary for re-identification
in free form text. In order for inspection
to work properly, the name of this info
type must not occur naturally anywhere
in your data; otherwise, inspection may
either - reverse a surrogate that does
not correspond to an actual identifier
- be unable to parse the surrogate and
result in an error Therefore, choose your
custom info type name carefully after
considering what your data looks like.
One way to select a name that has a high
chance of yielding reliable detection
is to include one or more unicode characters
that are highly improbable to exist in
your data. For example, assuming your
data is entered from a regular ASCII keyboard,
the symbol with the hex code point 29DD
might be used like so: ⧝MY_TOKEN_TYPE.'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name of the information
type. Either a name of your choosing
when creating a CustomInfoType, or
one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference
when specifying a built-in type. When
sending Cloud DLP results to Data
Catalog, infoType names should conform
to the pattern `[A-Za-z0-9$-_]{1,64}`.
cryptoHashConfig:
type: object
x-dcl-go-name: CryptoHashConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfig
description: Crypto
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfigCryptoKey
description: The key used by the hash function.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud
KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource
name of the KMS CryptoKey to use
for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped
data crypto key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of
the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256
bit key.
cryptoReplaceFfxFpeConfig:
type: object
x-dcl-go-name: CryptoReplaceFfxFpeConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfig
description: Ffx-Fpe
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
required:
- cryptoKey
properties:
commonAlphabet:
type: string
x-dcl-go-name: CommonAlphabet
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCommonAlphabetEnum
description: 'Common alphabets. Possible
values: FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED,
NUMERIC, HEXADECIMAL, UPPER_CASE_ALPHA_NUMERIC,
ALPHA_NUMERIC'
x-dcl-conflicts:
- customAlphabet
- radix
enum:
- FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED
- NUMERIC
- HEXADECIMAL
- UPPER_CASE_ALPHA_NUMERIC
- ALPHA_NUMERIC
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigContext
description: '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 1. the field is not present
when transforming a given value, a default
tweak will be used. Note that case (1)
is expected when an `InfoTypeTransformation`
is applied to both structured and non-structured
`ContentItem`s. Currently, the referenced
field may be of value type integer or
string. The tweak is constructed as a
sequence of bytes in big endian byte order
such that: - a 64 bit integer is encoded
followed by a single byte of value 1 -
a string is encoded in UTF-8 format followed
by a single byte of value 2'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKey
description: Required. The key used by the
encryption algorithm.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud
KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource
name of the KMS CryptoKey to use
for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped
data crypto key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of
the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256
bit key.
customAlphabet:
type: string
x-dcl-go-name: CustomAlphabet
description: '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, 95]. This must be encoded as ASCII.
The order of characters does not matter.
The full list of allowed characters is:
``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
~`!@#$%^&*()_-+={[}]|:;"''<,>.?/``'
x-dcl-conflicts:
- commonAlphabet
- radix
radix:
type: integer
format: int64
x-dcl-go-name: Radix
description: The native way to select the
alphabet. Must be in the range [2, 95].
x-dcl-conflicts:
- commonAlphabet
- customAlphabet
surrogateInfoType:
type: object
x-dcl-go-name: SurrogateInfoType
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigSurrogateInfoType
description: '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`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#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'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name of the information
type. Either a name of your choosing
when creating a CustomInfoType, or
one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference
when specifying a built-in type. When
sending Cloud DLP results to Data
Catalog, infoType names should conform
to the pattern `[A-Za-z0-9$-_]{1,64}`.
dateShiftConfig:
type: object
x-dcl-go-name: DateShiftConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfig
description: Date Shift
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- cryptoDeterministicConfig
required:
- upperBoundDays
- lowerBoundDays
properties:
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigContext
description: Points to the field that contains
the context, for example, an entity id.
If set, must also set cryptoKey. If set,
shift will be consistent for the given
context.
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigCryptoKey
description: 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. If set, must also
set context. Can only be applied to table
items.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud
KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource
name of the KMS CryptoKey to use
for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped
data crypto key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of
the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256
bit key.
lowerBoundDays:
type: integer
format: int64
x-dcl-go-name: LowerBoundDays
description: Required. For example, -5 means
shift date to at most 5 days back in the
past.
upperBoundDays:
type: integer
format: int64
x-dcl-go-name: UpperBoundDays
description: Required. 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.
fixedSizeBucketingConfig:
type: object
x-dcl-go-name: FixedSizeBucketingConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfig
description: Fixed size bucketing
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
required:
- lowerBound
- upperBound
- bucketSize
properties:
bucketSize:
type: number
format: double
x-dcl-go-name: BucketSize
description: 'Required. 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.'
lowerBound:
type: object
x-dcl-go-name: LowerBound
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBound
description: Required. 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".
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must
be from 1 to 31 and valid for
the year and month, or 0 to specify
a year by itself or a year and
month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must
be from 1 to 12, or 0 to specify
a year without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24
hour format. Should be from 0
to 23. An API may choose to allow
the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of
day. Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds
in nanoseconds. Must be from 0
to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes
of the time. Must normally be
from 0 to 59. An API may allow
the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
upperBound:
type: object
x-dcl-go-name: UpperBound
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBound
description: Required. Upper bound value
of buckets. All values greater than upper_bound
are grouped together into a single bucket;
for example if `upper_bound` = 89, then
all values greater than 89 are replaced
with the value "89+".
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must
be from 1 to 31 and valid for
the year and month, or 0 to specify
a year by itself or a year and
month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must
be from 1 to 12, or 0 to specify
a year without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24
hour format. Should be from 0
to 23. An API may choose to allow
the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of
day. Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds
in nanoseconds. Must be from 0
to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes
of the time. Must normally be
from 0 to 59. An API may allow
the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
redactConfig:
type: object
x-dcl-go-name: RedactConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationRedactConfig
description: Redact
x-dcl-conflicts:
- replaceConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
x-dcl-send-empty: true
replaceConfig:
type: object
x-dcl-go-name: ReplaceConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfig
description: Replace with a specified value.
x-dcl-conflicts:
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
newValue:
type: object
x-dcl-go-name: NewValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfigNewValue
description: Value to replace it with.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfigNewValueDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must
be from 1 to 31 and valid for
the year and month, or 0 to specify
a year by itself or a year and
month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must
be from 1 to 12, or 0 to specify
a year without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfigNewValueDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceConfigNewValueTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24
hour format. Should be from 0
to 23. An API may choose to allow
the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of
day. Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds
in nanoseconds. Must be from 0
to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes
of the time. Must normally be
from 0 to 59. An API may allow
the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
replaceWithInfoTypeConfig:
type: object
x-dcl-go-name: ReplaceWithInfoTypeConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationReplaceWithInfoTypeConfig
description: Replace with infotype
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
x-dcl-send-empty: true
timePartConfig:
type: object
x-dcl-go-name: TimePartConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationTimePartConfig
description: Time extraction
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
partToExtract:
type: string
x-dcl-go-name: PartToExtract
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsInfoTypeTransformationsTransformationsPrimitiveTransformationTimePartConfigPartToExtractEnum
description: 'The part of the time to keep.
Possible values: TIME_PART_UNSPECIFIED,
YEAR, MONTH, DAY_OF_MONTH, DAY_OF_WEEK,
WEEK_OF_YEAR, HOUR_OF_DAY'
enum:
- TIME_PART_UNSPECIFIED
- YEAR
- MONTH
- DAY_OF_MONTH
- DAY_OF_WEEK
- WEEK_OF_YEAR
- HOUR_OF_DAY
primitiveTransformation:
type: object
x-dcl-go-name: PrimitiveTransformation
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformation
description: Apply the transformation to the entire field.
x-dcl-conflicts:
- infoTypeTransformations
properties:
bucketingConfig:
type: object
x-dcl-go-name: BucketingConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfig
description: Bucketing
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
buckets:
type: array
x-dcl-go-name: Buckets
description: Set of buckets. Ranges must be non-overlapping.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBuckets
required:
- replacementValue
properties:
max:
type: object
x-dcl-go-name: Max
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsMax
description: Upper bound of the range, exclusive;
type must match min.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsMaxDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be
from 1 to 31 and valid for the year
and month, or 0 to specify a year
by itself or a year and month where
the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be
from 1 to 12, or 0 to specify a year
without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsMaxDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsMaxTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour
format. Should be from 0 to 23. An
API may choose to allow the value
"24:00:00" for scenarios like business
closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day.
Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in
nanoseconds. Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the
time. Must normally be from 0 to 59.
An API may allow the value 60 if it
allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
min:
type: object
x-dcl-go-name: Min
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsMin
description: Lower bound of the range, inclusive.
Type should be the same as max if used.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsMinDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be
from 1 to 31 and valid for the year
and month, or 0 to specify a year
by itself or a year and month where
the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be
from 1 to 12, or 0 to specify a year
without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsMinDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsMinTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour
format. Should be from 0 to 23. An
API may choose to allow the value
"24:00:00" for scenarios like business
closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day.
Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in
nanoseconds. Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the
time. Must normally be from 0 to 59.
An API may allow the value 60 if it
allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
replacementValue:
type: object
x-dcl-go-name: ReplacementValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValue
description: Required. Replacement value for
this bucket.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be
from 1 to 31 and valid for the year
and month, or 0 to specify a year
by itself or a year and month where
the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be
from 1 to 12, or 0 to specify a year
without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationBucketingConfigBucketsReplacementValueTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour
format. Should be from 0 to 23. An
API may choose to allow the value
"24:00:00" for scenarios like business
closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day.
Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in
nanoseconds. Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the
time. Must normally be from 0 to 59.
An API may allow the value 60 if it
allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
characterMaskConfig:
type: object
x-dcl-go-name: CharacterMaskConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCharacterMaskConfig
description: Mask
x-dcl-conflicts:
- replaceConfig
- redactConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
charactersToIgnore:
type: array
x-dcl-go-name: CharactersToIgnore
description: When masking a string, items in this
list will be skipped when replacing characters.
For example, if the input string is `555-555-5555`
and you instruct Cloud DLP to skip `-` and mask
5 characters with `*`, Cloud DLP returns `***-**5-5555`.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCharacterMaskConfigCharactersToIgnore
properties:
charactersToSkip:
type: string
x-dcl-go-name: CharactersToSkip
description: Characters to not transform when
masking.
x-dcl-conflicts:
- commonCharactersToIgnore
commonCharactersToIgnore:
type: string
x-dcl-go-name: CommonCharactersToIgnore
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCharacterMaskConfigCharactersToIgnoreCommonCharactersToIgnoreEnum
description: 'Common characters to not transform
when masking. Useful to avoid removing punctuation.
Possible values: COMMON_CHARS_TO_IGNORE_UNSPECIFIED,
NUMERIC, ALPHA_UPPER_CASE, ALPHA_LOWER_CASE,
PUNCTUATION, WHITESPACE'
x-dcl-conflicts:
- charactersToSkip
enum:
- COMMON_CHARS_TO_IGNORE_UNSPECIFIED
- NUMERIC
- ALPHA_UPPER_CASE
- ALPHA_LOWER_CASE
- PUNCTUATION
- WHITESPACE
maskingCharacter:
type: string
x-dcl-go-name: MaskingCharacter
description: Character to use to mask the sensitive
values—for example, `*` for an alphabetic string
such as a name, or `0` for a numeric string such
as ZIP code or credit card number. This string must
have a length of 1. If not supplied, this value
defaults to `*` for strings, and `0` for digits.
numberToMask:
type: integer
format: int64
x-dcl-go-name: NumberToMask
description: Number of characters to mask. If not
set, all matching chars will be masked. Skipped
characters do not count towards this tally.
reverseOrder:
type: boolean
x-dcl-go-name: ReverseOrder
description: Mask characters in reverse order. For
example, if `masking_character` is `0`, `number_to_mask`
is `14`, and `reverse_order` is `false`, then the
input string `1234-5678-9012-3456` is masked as
`00000000000000-3456`. If `masking_character` is
`*`, `number_to_mask` is `3`, and `reverse_order`
is `true`, then the string `12345` is masked as
`12***`.
cryptoDeterministicConfig:
type: object
x-dcl-go-name: CryptoDeterministicConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoDeterministicConfig
description: Deterministic Crypto
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
properties:
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoDeterministicConfigContext
description: '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
`ContentItem`s.'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKey
description: The key used by the encryption function.
For deterministic encryption using AES-SIV, the
provided key is internally expanded to 64 bytes
prior to use.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource name of
the KMS CryptoKey to use for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped data crypto
key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoDeterministicConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256 bit key.
surrogateInfoType:
type: object
x-dcl-go-name: SurrogateInfoType
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoDeterministicConfigSurrogateInfoType
description: 'The custom info type to annotate the
surrogate with. This annotation will be applied
to the surrogate by prefixing it with the name of
the custom info type followed by the number of characters
comprising the surrogate. The following scheme defines
the format: {info type name}({surrogate character
count}):{surrogate} For example, if the name of
custom info type is ''MY_TOKEN_INFO_TYPE'' and the
surrogate is ''abc'', the full replacement value
will be: ''MY_TOKEN_INFO_TYPE(3):abc'' This annotation
identifies the surrogate when inspecting content
using the custom info type ''Surrogate''. This facilitates
reversal of the surrogate when it occurs in free
text. Note: For record transformations where the
entire cell in a table is being transformed, surrogates
are not mandatory. Surrogates are used to denote
the location of the token and are necessary for
re-identification in free form text. In order for
inspection to work properly, the name of this info
type must not occur naturally anywhere in your data;
otherwise, inspection may either - reverse a surrogate
that does not correspond to an actual identifier
- be unable to parse the surrogate and result in
an error Therefore, choose your custom info type
name carefully after considering what your data
looks like. One way to select a name that has a
high chance of yielding reliable detection is to
include one or more unicode characters that are
highly improbable to exist in your data. For example,
assuming your data is entered from a regular ASCII
keyboard, the symbol with the hex code point 29DD
might be used like so: ⧝MY_TOKEN_TYPE.'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name of the information type. Either
a name of your choosing when creating a CustomInfoType,
or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference
when specifying a built-in type. When sending
Cloud DLP results to Data Catalog, infoType
names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.
cryptoHashConfig:
type: object
x-dcl-go-name: CryptoHashConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoHashConfig
description: Crypto
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoHashConfigCryptoKey
description: The key used by the hash function.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource name of
the KMS CryptoKey to use for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped data crypto
key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoHashConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256 bit key.
cryptoReplaceFfxFpeConfig:
type: object
x-dcl-go-name: CryptoReplaceFfxFpeConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfig
description: Ffx-Fpe
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
required:
- cryptoKey
properties:
commonAlphabet:
type: string
x-dcl-go-name: CommonAlphabet
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCommonAlphabetEnum
description: 'Common alphabets. Possible values: FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED,
NUMERIC, HEXADECIMAL, UPPER_CASE_ALPHA_NUMERIC,
ALPHA_NUMERIC'
x-dcl-conflicts:
- customAlphabet
- radix
enum:
- FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED
- NUMERIC
- HEXADECIMAL
- UPPER_CASE_ALPHA_NUMERIC
- ALPHA_NUMERIC
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigContext
description: '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 1. the field is not present when transforming
a given value, a default tweak will be used. Note
that case (1) is expected when an `InfoTypeTransformation`
is applied to both structured and non-structured
`ContentItem`s. Currently, the referenced field
may be of value type integer or string. The tweak
is constructed as a sequence of bytes in big endian
byte order such that: - a 64 bit integer is encoded
followed by a single byte of value 1 - a string
is encoded in UTF-8 format followed by a single
byte of value 2'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKey
description: Required. The key used by the encryption
algorithm.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource name of
the KMS CryptoKey to use for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped data crypto
key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256 bit key.
customAlphabet:
type: string
x-dcl-go-name: CustomAlphabet
description: '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, 95]. This
must be encoded as ASCII. The order of characters
does not matter. The full list of allowed characters
is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
~`!@#$%^&*()_-+={[}]|:;"''<,>.?/``'
x-dcl-conflicts:
- commonAlphabet
- radix
radix:
type: integer
format: int64
x-dcl-go-name: Radix
description: The native way to select the alphabet.
Must be in the range [2, 95].
x-dcl-conflicts:
- commonAlphabet
- customAlphabet
surrogateInfoType:
type: object
x-dcl-go-name: SurrogateInfoType
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationCryptoReplaceFfxFpeConfigSurrogateInfoType
description: '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`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#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'
properties:
name:
type: string
x-dcl-go-name: Name
description: Name of the information type. Either
a name of your choosing when creating a CustomInfoType,
or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference
when specifying a built-in type. When sending
Cloud DLP results to Data Catalog, infoType
names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.
dateShiftConfig:
type: object
x-dcl-go-name: DateShiftConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationDateShiftConfig
description: Date Shift
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- cryptoDeterministicConfig
required:
- upperBoundDays
- lowerBoundDays
properties:
context:
type: object
x-dcl-go-name: Context
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationDateShiftConfigContext
description: Points to the field that contains the
context, for example, an entity id. If set, must
also set cryptoKey. If set, shift will be consistent
for the given context.
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
cryptoKey:
type: object
x-dcl-go-name: CryptoKey
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationDateShiftConfigCryptoKey
description: 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.
If set, must also set context. Can only be applied
to table items.
properties:
kmsWrapped:
type: object
x-dcl-go-name: KmsWrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyKmsWrapped
description: Key wrapped using Cloud KMS
x-dcl-conflicts:
- transient
- unwrapped
required:
- wrappedKey
- cryptoKeyName
properties:
cryptoKeyName:
type: string
x-dcl-go-name: CryptoKeyName
description: Required. The resource name of
the KMS CryptoKey to use for unwrapping.
x-dcl-references:
- resource: Cloudkms/CryptoKey
field: name
wrappedKey:
type: string
x-dcl-go-name: WrappedKey
description: Required. The wrapped data crypto
key.
transient:
type: object
x-dcl-go-name: Transient
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyTransient
description: Transient crypto key
x-dcl-conflicts:
- unwrapped
- kmsWrapped
required:
- name
properties:
name:
type: string
x-dcl-go-name: Name
description: 'Required. Name of the key. 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).'
unwrapped:
type: object
x-dcl-go-name: Unwrapped
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationDateShiftConfigCryptoKeyUnwrapped
description: Unwrapped crypto key
x-dcl-conflicts:
- transient
- kmsWrapped
required:
- key
properties:
key:
type: string
x-dcl-go-name: Key
description: Required. A 128/192/256 bit key.
lowerBoundDays:
type: integer
format: int64
x-dcl-go-name: LowerBoundDays
description: Required. For example, -5 means shift
date to at most 5 days back in the past.
upperBoundDays:
type: integer
format: int64
x-dcl-go-name: UpperBoundDays
description: Required. 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.
fixedSizeBucketingConfig:
type: object
x-dcl-go-name: FixedSizeBucketingConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfig
description: Fixed size bucketing
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
required:
- lowerBound
- upperBound
- bucketSize
properties:
bucketSize:
type: number
format: double
x-dcl-go-name: BucketSize
description: 'Required. 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.'
lowerBound:
type: object
x-dcl-go-name: LowerBound
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBound
description: Required. 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".
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be from
1 to 31 and valid for the year and month,
or 0 to specify a year by itself or a year
and month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be from
1 to 12, or 0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must be from
1 to 9999, or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundDayOfWeekValueEnum
description: 'day of week Possible values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
SATURDAY, SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfigLowerBoundTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour format.
Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day. Must
be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the time.
Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
upperBound:
type: object
x-dcl-go-name: UpperBound
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBound
description: Required. Upper bound value of buckets.
All values greater than upper_bound are grouped
together into a single bucket; for example if `upper_bound`
= 89, then all values greater than 89 are replaced
with the value "89+".
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be from
1 to 31 and valid for the year and month,
or 0 to specify a year by itself or a year
and month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be from
1 to 12, or 0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must be from
1 to 9999, or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundDayOfWeekValueEnum
description: 'day of week Possible values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
SATURDAY, SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationFixedSizeBucketingConfigUpperBoundTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour format.
Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day. Must
be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the time.
Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
redactConfig:
type: object
x-dcl-go-name: RedactConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationRedactConfig
description: Redact
x-dcl-conflicts:
- replaceConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
x-dcl-send-empty: true
replaceConfig:
type: object
x-dcl-go-name: ReplaceConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationReplaceConfig
description: Replace with a specified value.
x-dcl-conflicts:
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
newValue:
type: object
x-dcl-go-name: NewValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationReplaceConfigNewValue
description: Value to replace it with.
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationReplaceConfigNewValueDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must be from
1 to 31 and valid for the year and month,
or 0 to specify a year by itself or a year
and month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must be from
1 to 12, or 0 to specify a year without
a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must be from
1 to 9999, or 0 to specify a date without
a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationReplaceConfigNewValueDayOfWeekValueEnum
description: 'day of week Possible values: DAY_OF_WEEK_UNSPECIFIED,
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
SATURDAY, SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationReplaceConfigNewValueTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24 hour format.
Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of day. Must
be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds in nanoseconds.
Must be from 0 to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes of the time.
Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
replaceWithInfoTypeConfig:
type: object
x-dcl-go-name: ReplaceWithInfoTypeConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationReplaceWithInfoTypeConfig
description: Replace with infotype
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- timePartConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
x-dcl-send-empty: true
timePartConfig:
type: object
x-dcl-go-name: TimePartConfig
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationTimePartConfig
description: Time extraction
x-dcl-conflicts:
- replaceConfig
- redactConfig
- characterMaskConfig
- cryptoReplaceFfxFpeConfig
- fixedSizeBucketingConfig
- bucketingConfig
- replaceWithInfoTypeConfig
- cryptoHashConfig
- dateShiftConfig
- cryptoDeterministicConfig
properties:
partToExtract:
type: string
x-dcl-go-name: PartToExtract
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsFieldTransformationsPrimitiveTransformationTimePartConfigPartToExtractEnum
description: 'The part of the time to keep. Possible
values: TIME_PART_UNSPECIFIED, YEAR, MONTH, DAY_OF_MONTH,
DAY_OF_WEEK, WEEK_OF_YEAR, HOUR_OF_DAY'
enum:
- TIME_PART_UNSPECIFIED
- YEAR
- MONTH
- DAY_OF_MONTH
- DAY_OF_WEEK
- WEEK_OF_YEAR
- HOUR_OF_DAY
recordSuppressions:
type: array
x-dcl-go-name: RecordSuppressions
description: Configuration defining which records get suppressed
entirely. Records that match any suppression rule are omitted
from the output.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressions
properties:
condition:
type: object
x-dcl-go-name: Condition
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsCondition
description: A condition that when it evaluates to true will
result in the record being evaluated to be suppressed from
the transformed content.
properties:
expressions:
type: object
x-dcl-go-name: Expressions
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressions
description: An expression.
properties:
conditions:
type: object
x-dcl-go-name: Conditions
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsConditions
description: Conditions to apply to the expression.
properties:
conditions:
type: array
x-dcl-go-name: Conditions
description: A collection of conditions.
x-dcl-send-empty: true
x-dcl-list-type: list
items:
type: object
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsConditionsConditions
required:
- field
- operator
properties:
field:
type: object
x-dcl-go-name: Field
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsConditionsConditionsField
description: Required. Field within the
record this condition is evaluated against.
properties:
name:
type: string
x-dcl-go-name: Name
description: Name describing the field.
operator:
type: string
x-dcl-go-name: Operator
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsConditionsConditionsOperatorEnum
description: 'Required. Operator used to
compare the field or infoType to the value.
Possible values: LOGICAL_OPERATOR_UNSPECIFIED,
AND'
enum:
- LOGICAL_OPERATOR_UNSPECIFIED
- AND
value:
type: object
x-dcl-go-name: Value
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsConditionsConditionsValue
description: Value to compare against. [Mandatory,
except for `EXISTS` tests.]
properties:
booleanValue:
type: boolean
x-dcl-go-name: BooleanValue
description: boolean
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
dateValue:
type: object
x-dcl-go-name: DateValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsConditionsConditionsValueDateValue
description: date
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dayOfWeekValue
properties:
day:
type: integer
format: int64
x-dcl-go-name: Day
description: Day of a month. Must
be from 1 to 31 and valid for
the year and month, or 0 to specify
a year by itself or a year and
month where the day isn't significant.
month:
type: integer
format: int64
x-dcl-go-name: Month
description: Month of a year. Must
be from 1 to 12, or 0 to specify
a year without a month and day.
year:
type: integer
format: int64
x-dcl-go-name: Year
description: Year of the date. Must
be from 1 to 9999, or 0 to specify
a date without a year.
dayOfWeekValue:
type: string
x-dcl-go-name: DayOfWeekValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsConditionsConditionsValueDayOfWeekValueEnum
description: 'day of week Possible values:
DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY,
WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
SUNDAY'
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
enum:
- DAY_OF_WEEK_UNSPECIFIED
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
floatValue:
type: number
format: double
x-dcl-go-name: FloatValue
description: float
x-dcl-conflicts:
- integerValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
integerValue:
type: integer
format: int64
x-dcl-go-name: IntegerValue
description: integer
x-dcl-conflicts:
- floatValue
- stringValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
stringValue:
type: string
x-dcl-go-name: StringValue
description: string
x-dcl-conflicts:
- integerValue
- floatValue
- booleanValue
- timestampValue
- timeValue
- dateValue
- dayOfWeekValue
timeValue:
type: object
x-dcl-go-name: TimeValue
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsConditionsConditionsValueTimeValue
description: time of day
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timestampValue
- dateValue
- dayOfWeekValue
properties:
hours:
type: integer
format: int64
x-dcl-go-name: Hours
description: Hours of day in 24
hour format. Should be from 0
to 23. An API may choose to allow
the value "24:00:00" for scenarios
like business closing time.
minutes:
type: integer
format: int64
x-dcl-go-name: Minutes
description: Minutes of hour of
day. Must be from 0 to 59.
nanos:
type: integer
format: int64
x-dcl-go-name: Nanos
description: Fractions of seconds
in nanoseconds. Must be from 0
to 999,999,999.
seconds:
type: integer
format: int64
x-dcl-go-name: Seconds
description: Seconds of minutes
of the time. Must normally be
from 0 to 59. An API may allow
the value 60 if it allows leap-seconds.
timestampValue:
type: string
format: date-time
x-dcl-go-name: TimestampValue
description: timestamp
x-dcl-conflicts:
- integerValue
- floatValue
- stringValue
- booleanValue
- timeValue
- dateValue
- dayOfWeekValue
logicalOperator:
type: string
x-dcl-go-name: LogicalOperator
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigRecordTransformationsRecordSuppressionsConditionExpressionsLogicalOperatorEnum
description: 'The operator to apply to the result
of conditions. Default and currently only supported
value is `AND`. Possible values: LOGICAL_OPERATOR_UNSPECIFIED,
AND'
enum:
- LOGICAL_OPERATOR_UNSPECIFIED
- AND
transformationErrorHandling:
type: object
x-dcl-go-name: TransformationErrorHandling
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigTransformationErrorHandling
description: Mode for handling transformation errors. If left unspecified,
the default mode is `TransformationErrorHandling.ThrowError`.
properties:
leaveUntransformed:
type: object
x-dcl-go-name: LeaveUntransformed
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigTransformationErrorHandlingLeaveUntransformed
description: Ignore errors
x-dcl-conflicts:
- throwError
throwError:
type: object
x-dcl-go-name: ThrowError
x-dcl-go-type: DeidentifyTemplateDeidentifyConfigTransformationErrorHandlingThrowError
description: Throw an error
x-dcl-conflicts:
- leaveUntransformed
description:
type: string
x-dcl-go-name: Description
description: Short description (max 256 chars).
displayName:
type: string
x-dcl-go-name: DisplayName
description: Display name (max 256 chars).
location:
type: string
x-dcl-go-name: Location
description: The location of the resource
x-kubernetes-immutable: true
x-dcl-parameter: true
locationId:
type: string
x-dcl-go-name: LocationId
readOnly: true
description: Output only. The geographic location where this resource is
stored.
x-kubernetes-immutable: true
name:
type: string
x-dcl-go-name: Name
description: 'Output only. The template name. The template will have one
of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID`
OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`'
x-kubernetes-immutable: true
x-dcl-server-generated-parameter: true
parent:
type: string
x-dcl-go-name: Parent
description: The parent of the resource
x-kubernetes-immutable: true
x-dcl-forward-slash-allowed: true
x-dcl-references:
- resource: Cloudresourcemanager/Organization
field: name
parent: true
- resource: Cloudresourcemanager/Project
field: name
parent: true
x-dcl-parameter: true
updateTime:
type: string
format: date-time
x-dcl-go-name: UpdateTime
readOnly: true
description: Output only. The last update timestamp of an inspectTemplate.
x-kubernetes-immutable: true