This product is not supported for your selected
Datadog site. (
).
gcp_dlp_inspect_template
ancestors
Type: UNORDERED_LIST_STRING
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. The creation timestamp of an inspectTemplate.
description
Type: STRING
Provider name: description
Description: Short description (max 256 chars).
gcp_display_name
Type: STRING
Provider name: displayName
Description: Display name (max 256 chars).
inspect_config
Type: STRUCT
Provider name: inspectConfig
Description: The core content of the template. Configuration of the scanning process.
content_options
Type: UNORDERED_LIST_STRING
Provider name: contentOptions
Description: Deprecated and unused.
custom_info_types
Type: UNORDERED_LIST_STRUCT
Provider name: customInfoTypes
Description: CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more.
detection_rules
Type: UNORDERED_LIST_STRUCT
Provider name: detectionRules
Description: Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the surrogate_type
CustomInfoType.
hotword_rule
Type: STRUCT
Provider name: hotwordRule
Description: Hotword-based detection rule.
hotword_regex
Type: STRUCT
Provider name: hotwordRegex
Description: Regular expression pattern defining what qualifies as a hotword.
group_indexes
Type: UNORDERED_LIST_INT32
Provider name: groupIndexes
Description: The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.
pattern
Type: STRING
Provider name: pattern
Description: Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.
likelihood_adjustment
Type: STRUCT
Provider name: likelihoodAdjustment
Description: Likelihood adjustment to apply to all matching findings.
fixed_likelihood
Type: STRING
Provider name: fixedLikelihood
Description: Set the likelihood of a finding to a fixed value.
Possible values:
LIKELIHOOD_UNSPECIFIED
- Default value; same as POSSIBLE.
VERY_UNLIKELY
- Highest chance of a false positive.
UNLIKELY
- High chance of a false positive.
POSSIBLE
- Some matching signals. The default value.
LIKELY
- Low chance of a false positive.
VERY_LIKELY
- Confidence level is high. Lowest chance of a false positive.
relative_likelihood
Type: INT32
Provider name: relativeLikelihood
Description: Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be POSSIBLE
without the detection rule and relative_likelihood
is 1, then it is upgraded to LIKELY
, while a value of -1 would downgrade it to UNLIKELY
. Likelihood may never drop below VERY_UNLIKELY
or exceed VERY_LIKELY
, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY
will result in a final likelihood of LIKELY
.
proximity
Type: STRUCT
Provider name: proximity
Description: Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex “(\d{3}) \d{3}-\d{4}” if the area code is known to be the area code of a company’s office. In this case, use the hotword regex “(xxx)”, where “xxx” is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).
dictionary
Type: STRUCT
Provider name: dictionary
Description: A list of phrases to detect as a CustomInfoType.
cloud_storage_path
Type: STRUCT
Provider name: cloudStoragePath
Description: Newline-delimited file of words in Cloud Storage. Only a single file is accepted.
path
Type: STRING
Provider name: path
Description: A URL representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt
word_list
Type: STRUCT
Provider name: wordList
Description: List of words or phrases to search for.
words
Type: UNORDERED_LIST_STRING
Provider name: words
Description: Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]
exclusion_type
Type: STRING
Provider name: exclusionType
Description: If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.
Possible values:
EXCLUSION_TYPE_UNSPECIFIED
- A finding of this custom info type will not be excluded from results.
EXCLUSION_TYPE_EXCLUDE
- A finding of this custom info type will be excluded from final results, but can still affect rule execution.
info_type
Type: STRUCT
Provider name: infoType
Description: CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in InspectContent.info_types
field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in InspectContent.info_types
list then the name is treated as a custom info type.
name
Type: STRING
Provider 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/sensitive-data-protection/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}
.
sensitivity_score
Type: STRUCT
Provider name: sensitivityScore
Description: Optional custom sensitivity for this InfoType. This only applies to data profiling.
score
Type: STRING
Provider name: score
Description: The sensitivity score applied to the resource.
Possible values:
SENSITIVITY_SCORE_UNSPECIFIED
- Unused.
SENSITIVITY_LOW
- No sensitive information detected. The resource isn’t publicly accessible.
SENSITIVITY_UNKNOWN
- Unable to determine sensitivity.
SENSITIVITY_MODERATE
- Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.
SENSITIVITY_HIGH
- High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII.
version
Type: STRING
Provider name: version
Description: Optional version name for this InfoType.
likelihood
Type: STRING
Provider name: likelihood
Description: Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to VERY_LIKELY
if not specified.
Possible values:
LIKELIHOOD_UNSPECIFIED
- Default value; same as POSSIBLE.
VERY_UNLIKELY
- Highest chance of a false positive.
UNLIKELY
- High chance of a false positive.
POSSIBLE
- Some matching signals. The default value.
LIKELY
- Low chance of a false positive.
VERY_LIKELY
- Confidence level is high. Lowest chance of a false positive.
regex
Type: STRUCT
Provider name: regex
Description: Regular expression based CustomInfoType.
group_indexes
Type: UNORDERED_LIST_INT32
Provider name: groupIndexes
Description: The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.
pattern
Type: STRING
Provider name: pattern
Description: Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.
sensitivity_score
Type: STRUCT
Provider name: sensitivityScore
Description: Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling.
score
Type: STRING
Provider name: score
Description: The sensitivity score applied to the resource.
Possible values:
SENSITIVITY_SCORE_UNSPECIFIED
- Unused.
SENSITIVITY_LOW
- No sensitive information detected. The resource isn’t publicly accessible.
SENSITIVITY_UNKNOWN
- Unable to determine sensitivity.
SENSITIVITY_MODERATE
- Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.
SENSITIVITY_HIGH
- High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII.
stored_type
Type: STRUCT
Provider name: storedType
Description: Load an existing StoredInfoType
resource for use in InspectDataSource
. Not currently supported in InspectContent
.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Timestamp indicating when the version of the StoredInfoType
used for inspection was created. Output-only field, populated by the system.
name
Type: STRING
Provider name: name
Description: Resource name of the requested StoredInfoType
, for example organizations/433245324/storedInfoTypes/432452342
or projects/project-id/storedInfoTypes/432452342
.
surrogate_type
Type: STRUCT
Provider name: surrogateType
Description: Message for detecting output from deidentification transformations that support reversing.
exclude_info_types
Type: BOOLEAN
Provider name: excludeInfoTypes
Description: When true, excludes type information of the findings. This is not used for data profiling.
include_quote
Type: BOOLEAN
Provider name: includeQuote
Description: When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling.
info_types
Type: UNORDERED_LIST_STRUCT
Provider name: infoTypes
Description: Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.
name
Type: STRING
Provider 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/sensitive-data-protection/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}
.
sensitivity_score
Type: STRUCT
Provider name: sensitivityScore
Description: Optional custom sensitivity for this InfoType. This only applies to data profiling.
score
Type: STRING
Provider name: score
Description: The sensitivity score applied to the resource.
Possible values:
SENSITIVITY_SCORE_UNSPECIFIED
- Unused.
SENSITIVITY_LOW
- No sensitive information detected. The resource isn’t publicly accessible.
SENSITIVITY_UNKNOWN
- Unable to determine sensitivity.
SENSITIVITY_MODERATE
- Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.
SENSITIVITY_HIGH
- High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII.
version
Type: STRING
Provider name: version
Description: Optional version name for this InfoType.
limits
Type: STRUCT
Provider name: limits
Description: Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don’t apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don’t include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren’t hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values.
max_findings_per_info_type
Type: UNORDERED_LIST_STRUCT
Provider name: maxFindingsPerInfoType
Description: Configuration of findings limit given for specified infoTypes.
info_type
Type: STRUCT
Provider name: infoType
Description: Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.
name
Type: STRING
Provider 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/sensitive-data-protection/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}
.
sensitivity_score
Type: STRUCT
Provider name: sensitivityScore
Description: Optional custom sensitivity for this InfoType. This only applies to data profiling.
score
Type: STRING
Provider name: score
Description: The sensitivity score applied to the resource.
Possible values:
SENSITIVITY_SCORE_UNSPECIFIED
- Unused.
SENSITIVITY_LOW
- No sensitive information detected. The resource isn’t publicly accessible.
SENSITIVITY_UNKNOWN
- Unable to determine sensitivity.
SENSITIVITY_MODERATE
- Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.
SENSITIVITY_HIGH
- High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII.
version
Type: STRING
Provider name: version
Description: Optional version name for this InfoType.
max_findings
Type: INT32
Provider name: maxFindings
Description: Max findings limit for the given infoType.
max_findings_per_item
Type: INT32
Provider name: maxFindingsPerItem
Description: Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This value isn’t a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value.
max_findings_per_request
Type: INT32
Provider name: maxFindingsPerRequest
Description: Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum value is the value that you set or 3,000, whichever is lower. This value isn’t a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value.
min_likelihood
Type: STRING
Provider name: minLikelihood
Description: Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see Match likelihood.
Possible values:
LIKELIHOOD_UNSPECIFIED
- Default value; same as POSSIBLE.
VERY_UNLIKELY
- Highest chance of a false positive.
UNLIKELY
- High chance of a false positive.
POSSIBLE
- Some matching signals. The default value.
LIKELY
- Low chance of a false positive.
VERY_LIKELY
- Confidence level is high. Lowest chance of a false positive.
min_likelihood_per_info_type
Type: UNORDERED_LIST_STRUCT
Provider name: minLikelihoodPerInfoType
Description: Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood.
info_type
Type: STRUCT
Provider name: infoType
Description: Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails.
name
Type: STRING
Provider 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/sensitive-data-protection/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}
.
sensitivity_score
Type: STRUCT
Provider name: sensitivityScore
Description: Optional custom sensitivity for this InfoType. This only applies to data profiling.
score
Type: STRING
Provider name: score
Description: The sensitivity score applied to the resource.
Possible values:
SENSITIVITY_SCORE_UNSPECIFIED
- Unused.
SENSITIVITY_LOW
- No sensitive information detected. The resource isn’t publicly accessible.
SENSITIVITY_UNKNOWN
- Unable to determine sensitivity.
SENSITIVITY_MODERATE
- Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.
SENSITIVITY_HIGH
- High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII.
version
Type: STRING
Provider name: version
Description: Optional version name for this InfoType.
min_likelihood
Type: STRING
Provider name: minLikelihood
Description: Only returns findings equal to or above this threshold. This field is required or else the configuration fails.
Possible values:
LIKELIHOOD_UNSPECIFIED
- Default value; same as POSSIBLE.
VERY_UNLIKELY
- Highest chance of a false positive.
UNLIKELY
- High chance of a false positive.
POSSIBLE
- Some matching signals. The default value.
LIKELY
- Low chance of a false positive.
VERY_LIKELY
- Confidence level is high. Lowest chance of a false positive.
rule_set
Type: UNORDERED_LIST_STRUCT
Provider name: ruleSet
Description: Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.
info_types
Type: UNORDERED_LIST_STRUCT
Provider name: infoTypes
Description: List of infoTypes this rule set is applied to.
name
Type: STRING
Provider 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/sensitive-data-protection/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}
.
sensitivity_score
Type: STRUCT
Provider name: sensitivityScore
Description: Optional custom sensitivity for this InfoType. This only applies to data profiling.
score
Type: STRING
Provider name: score
Description: The sensitivity score applied to the resource.
Possible values:
SENSITIVITY_SCORE_UNSPECIFIED
- Unused.
SENSITIVITY_LOW
- No sensitive information detected. The resource isn’t publicly accessible.
SENSITIVITY_UNKNOWN
- Unable to determine sensitivity.
SENSITIVITY_MODERATE
- Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.
SENSITIVITY_HIGH
- High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII.
version
Type: STRING
Provider name: version
Description: Optional version name for this InfoType.
rules
Type: UNORDERED_LIST_STRUCT
Provider name: rules
Description: Set of rules to be applied to infoTypes. The rules are applied in order.
exclusion_rule
Type: STRUCT
Provider name: exclusionRule
Description: Exclusion rule.
dictionary
Type: STRUCT
Provider name: dictionary
Description: Dictionary which defines the rule.
cloud_storage_path
Type: STRUCT
Provider name: cloudStoragePath
Description: Newline-delimited file of words in Cloud Storage. Only a single file is accepted.
path
Type: STRING
Provider name: path
Description: A URL representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt
word_list
Type: STRUCT
Provider name: wordList
Description: List of words or phrases to search for.
words
Type: UNORDERED_LIST_STRING
Provider name: words
Description: Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]
exclude_by_hotword
Type: STRUCT
Provider name: excludeByHotword
Description: Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name.
hotword_regex
Type: STRUCT
Provider name: hotwordRegex
Description: Regular expression pattern defining what qualifies as a hotword.
group_indexes
Type: UNORDERED_LIST_INT32
Provider name: groupIndexes
Description: The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.
pattern
Type: STRING
Provider name: pattern
Description: Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.
proximity
Type: STRUCT
Provider name: proximity
Description: Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header.
exclude_info_types
Type: STRUCT
Provider name: excludeInfoTypes
Description: Set of infoTypes for which findings would affect this rule.
info_types
Type: UNORDERED_LIST_STRUCT
Provider name: infoTypes
Description: InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for InspectionRuleSet.info_types
containing “PHONE_NUMBER”and
exclusion_rulecontaining
exclude_info_types.info_types` with “EMAIL_ADDRESS” the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to “555-222-2222@example.org” to generate only a single finding, namely email address.
name
Type: STRING
Provider 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/sensitive-data-protection/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}
.
sensitivity_score
Type: STRUCT
Provider name: sensitivityScore
Description: Optional custom sensitivity for this InfoType. This only applies to data profiling.
score
Type: STRING
Provider name: score
Description: The sensitivity score applied to the resource.
Possible values:
SENSITIVITY_SCORE_UNSPECIFIED
- Unused.
SENSITIVITY_LOW
- No sensitive information detected. The resource isn’t publicly accessible.
SENSITIVITY_UNKNOWN
- Unable to determine sensitivity.
SENSITIVITY_MODERATE
- Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.
SENSITIVITY_HIGH
- High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII.
version
Type: STRING
Provider name: version
Description: Optional version name for this InfoType.
matching_type
Type: STRING
Provider name: matchingType
Description: How the rule is applied, see MatchingType documentation for details.
Possible values:
MATCHING_TYPE_UNSPECIFIED
- Invalid.
MATCHING_TYPE_FULL_MATCH
- Full match. - Dictionary: join of Dictionary results matched complete finding quote - Regex: all regex matches fill a finding quote start to end - Exclude info type: completely inside affecting info types findings
MATCHING_TYPE_PARTIAL_MATCH
- Partial match. - Dictionary: at least one of the tokens in the finding matches - Regex: substring of the finding matches - Exclude info type: intersects with affecting info types findings
MATCHING_TYPE_INVERSE_MATCH
- Inverse match. - Dictionary: no tokens in the finding match the dictionary - Regex: finding doesn’t match the regex - Exclude info type: no intersection with affecting info types findings
regex
Type: STRUCT
Provider name: regex
Description: Regular expression which defines the rule.
group_indexes
Type: UNORDERED_LIST_INT32
Provider name: groupIndexes
Description: The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.
pattern
Type: STRING
Provider name: pattern
Description: Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.
hotword_rule
Type: STRUCT
Provider name: hotwordRule
Description: Hotword-based detection rule.
hotword_regex
Type: STRUCT
Provider name: hotwordRegex
Description: Regular expression pattern defining what qualifies as a hotword.
group_indexes
Type: UNORDERED_LIST_INT32
Provider name: groupIndexes
Description: The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.
pattern
Type: STRING
Provider name: pattern
Description: Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.
likelihood_adjustment
Type: STRUCT
Provider name: likelihoodAdjustment
Description: Likelihood adjustment to apply to all matching findings.
fixed_likelihood
Type: STRING
Provider name: fixedLikelihood
Description: Set the likelihood of a finding to a fixed value.
Possible values:
LIKELIHOOD_UNSPECIFIED
- Default value; same as POSSIBLE.
VERY_UNLIKELY
- Highest chance of a false positive.
UNLIKELY
- High chance of a false positive.
POSSIBLE
- Some matching signals. The default value.
LIKELY
- Low chance of a false positive.
VERY_LIKELY
- Confidence level is high. Lowest chance of a false positive.
relative_likelihood
Type: INT32
Provider name: relativeLikelihood
Description: Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be POSSIBLE
without the detection rule and relative_likelihood
is 1, then it is upgraded to LIKELY
, while a value of -1 would downgrade it to UNLIKELY
. Likelihood may never drop below VERY_UNLIKELY
or exceed VERY_LIKELY
, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY
will result in a final likelihood of LIKELY
.
proximity
Type: STRUCT
Provider name: proximity
Description: Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex “(\d{3}) \d{3}-\d{4}” if the area code is known to be the area code of a company’s office. In this case, use the hotword regex “(xxx)”, where “xxx” is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).
labels
Type: UNORDERED_LIST_STRING
name
Type: STRING
Provider name: name
Description: Output only. The template name. The template will have one of the following formats: projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID
OR organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID
;
organization_id
Type: STRING
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
resource_name
Type: STRING
Type: UNORDERED_LIST_STRING
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The last update timestamp of an inspectTemplate.