gcp_dlp_stored_info_type
ancestors
Type: UNORDERED_LIST_STRING
current_version
Type: STRUCT
Provider name: currentVersion
Description: Current version of the stored info type.
config
Type: STRUCT
Provider name: config
Description: StoredInfoType configuration.
description
Type: STRING
Provider name: description
Description: Description of the StoredInfoType (max 256 characters).
dictionary
Type: STRUCT
Provider name: dictionary
Description: Store dictionary-based 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]
gcp_display_name
Type: STRING
Provider name: displayName
Description: Display name of the StoredInfoType (max 256 characters).
large_custom_dictionary
Type: STRUCT
Provider name: largeCustomDictionary
Description: StoredInfoType where findings are defined by a dictionary of phrases.
big_query_field
Type: STRUCT
Provider name: bigQueryField
Description: Field in a BigQuery table where each cell represents a dictionary phrase.
field
Type: STRUCT
Provider name: field
Description: Designated field in the BigQuery table.
name
Type: STRING
Provider name: name
Description: Name describing the field.
table
Type: STRUCT
Provider name: table
Description: Source table of the field.
dataset_id
Type: STRING
Provider name: datasetId
Description: Dataset ID of the table.
project_id
Type: STRING
Provider name: projectId
Description: The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
table_id
Type: STRING
Provider name: tableId
Description: Name of the table.
cloud_storage_file_set
Type: STRUCT
Provider name: cloudStorageFileSet
Description: Set of files containing newline-delimited lists of dictionary phrases.
url
Type: STRING
Provider name: url
Description: The url, in the format gs:///. Trailing wildcard in the path is allowed.
output_path
Type: STRUCT
Provider name: outputPath
Description: Location to store dictionary artifacts in Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used.
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
regex
Type: STRUCT
Provider name: regex
Description: Store regular expression-based StoredInfoType.
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.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Create timestamp of the version. Read-only, determined by the system when the version is created.
errors
Type: UNORDERED_LIST_STRUCT
Provider name: errors
Description: Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user’s Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same config if it was not the source of the error.
details
Type: STRUCT
Provider name: details
Description: Detailed error codes and messages.
code
Type: INT32
Provider name: code
Description: The status code, which should be an enum value of google.rpc.Code.
message
Type: STRING
Provider name: message
Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
extra_info
Type: STRING
Provider name: extraInfo
Description: Additional information about the error.
Possible values:
ERROR_INFO_UNSPECIFIED - Unused.
IMAGE_SCAN_UNAVAILABLE_IN_REGION - Image scan is not available in the region.
FILE_STORE_CLUSTER_UNSUPPORTED - File store cluster is not supported for profile generation.
timestamps
Type: UNORDERED_LIST_TIMESTAMP
Provider name: timestamps
Description: The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
state
Type: STRING
Provider name: state
Description: Stored info type version state. Read-only, updated by the system during dictionary creation.
Possible values:
STORED_INFO_TYPE_STATE_UNSPECIFIED - Unused
PENDING - StoredInfoType version is being created.
READY - StoredInfoType version is ready for use.
FAILED - StoredInfoType creation failed. All relevant error messages are returned in the StoredInfoTypeVersion message.
INVALID - StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the UpdateStoredInfoType method to create a new version.
stats
Type: STRUCT
Provider name: stats
Description: Statistics about this storedInfoType version.
large_custom_dictionary
Type: STRUCT
Provider name: largeCustomDictionary
Description: StoredInfoType where findings are defined by a dictionary of phrases.
approx_num_phrases
Type: INT64
Provider name: approxNumPhrases
Description: Approximate number of distinct phrases in the dictionary.
labels
Type: UNORDERED_LIST_STRING
name
Type: STRING
Provider name: name
Description: Resource name.
organization_id
Type: STRING
parent
Type: STRING
pending_versions
Type: UNORDERED_LIST_STRUCT
Provider name: pendingVersions
Description: Pending versions of the stored info type. Empty if no versions are pending.
config
Type: STRUCT
Provider name: config
Description: StoredInfoType configuration.
description
Type: STRING
Provider name: description
Description: Description of the StoredInfoType (max 256 characters).
dictionary
Type: STRUCT
Provider name: dictionary
Description: Store dictionary-based 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]
gcp_display_name
Type: STRING
Provider name: displayName
Description: Display name of the StoredInfoType (max 256 characters).
large_custom_dictionary
Type: STRUCT
Provider name: largeCustomDictionary
Description: StoredInfoType where findings are defined by a dictionary of phrases.
big_query_field
Type: STRUCT
Provider name: bigQueryField
Description: Field in a BigQuery table where each cell represents a dictionary phrase.
field
Type: STRUCT
Provider name: field
Description: Designated field in the BigQuery table.
name
Type: STRING
Provider name: name
Description: Name describing the field.
table
Type: STRUCT
Provider name: table
Description: Source table of the field.
dataset_id
Type: STRING
Provider name: datasetId
Description: Dataset ID of the table.
project_id
Type: STRING
Provider name: projectId
Description: The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
table_id
Type: STRING
Provider name: tableId
Description: Name of the table.
cloud_storage_file_set
Type: STRUCT
Provider name: cloudStorageFileSet
Description: Set of files containing newline-delimited lists of dictionary phrases.
url
Type: STRING
Provider name: url
Description: The url, in the format gs:///. Trailing wildcard in the path is allowed.
output_path
Type: STRUCT
Provider name: outputPath
Description: Location to store dictionary artifacts in Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used.
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
regex
Type: STRUCT
Provider name: regex
Description: Store regular expression-based StoredInfoType.
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.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Create timestamp of the version. Read-only, determined by the system when the version is created.
errors
Type: UNORDERED_LIST_STRUCT
Provider name: errors
Description: Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user’s Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same config if it was not the source of the error.
details
Type: STRUCT
Provider name: details
Description: Detailed error codes and messages.
code
Type: INT32
Provider name: code
Description: The status code, which should be an enum value of google.rpc.Code.
message
Type: STRING
Provider name: message
Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
extra_info
Type: STRING
Provider name: extraInfo
Description: Additional information about the error.
Possible values:
ERROR_INFO_UNSPECIFIED - Unused.
IMAGE_SCAN_UNAVAILABLE_IN_REGION - Image scan is not available in the region.
FILE_STORE_CLUSTER_UNSUPPORTED - File store cluster is not supported for profile generation.
timestamps
Type: UNORDERED_LIST_TIMESTAMP
Provider name: timestamps
Description: The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
state
Type: STRING
Provider name: state
Description: Stored info type version state. Read-only, updated by the system during dictionary creation.
Possible values:
STORED_INFO_TYPE_STATE_UNSPECIFIED - Unused
PENDING - StoredInfoType version is being created.
READY - StoredInfoType version is ready for use.
FAILED - StoredInfoType creation failed. All relevant error messages are returned in the StoredInfoTypeVersion message.
INVALID - StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the UpdateStoredInfoType method to create a new version.
stats
Type: STRUCT
Provider name: stats
Description: Statistics about this storedInfoType version.
large_custom_dictionary
Type: STRUCT
Provider name: largeCustomDictionary
Description: StoredInfoType where findings are defined by a dictionary of phrases.
approx_num_phrases
Type: INT64
Provider name: approxNumPhrases
Description: Approximate number of distinct phrases in the dictionary.
project_id
Type: STRING
project_number
Type: STRING
region_id
Type: STRING
resource_name
Type: STRING
Type: UNORDERED_LIST_STRING
zone_id
Type: STRING