Patch
|
|||||
|
|
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
Input
This building block consumes 13 input parameters
Name | Format | Description |
---|---|---|
name Required |
STRING |
Resource name of organization and storedInfoType to be updated, for
example |
updateMask |
ANY |
Mask to control which fields get updated |
config |
OBJECT |
Configuration for a StoredInfoType |
config.displayName |
STRING |
Display name of the StoredInfoType (max 256 characters) |
config.description |
STRING |
Description of the StoredInfoType (max 256 characters) |
config.largeCustomDictionary |
OBJECT |
Configuration for a custom dictionary created from a data source of any size
up to the maximum size defined in the
limits page. The artifacts of
dictionary creation are stored in the specified Google Cloud Storage
location. Consider using |
config.largeCustomDictionary.bigQueryField |
OBJECT |
Message defining a field of a BigQuery table |
config.largeCustomDictionary.bigQueryField.table |
OBJECT |
Message defining the location of a BigQuery table. A table is uniquely
identified by its project_id, dataset_id, and table_name. Within a query
a table is often referenced with a string in the format of:
|
config.largeCustomDictionary.bigQueryField.field |
OBJECT |
General identifier of a data field in a storage service |
config.largeCustomDictionary.cloudStorageFileSet |
OBJECT |
Message representing a set of files in Cloud Storage |
config.largeCustomDictionary.cloudStorageFileSet.url |
STRING |
The url, in the format |
config.largeCustomDictionary.outputPath |
OBJECT |
Message representing a single file or path in Cloud Storage |
config.largeCustomDictionary.outputPath.path |
STRING |
A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt |
= Parameter name
= Format
name STRING Required Resource name of organization and storedInfoType to be updated, for
example |
updateMask ANY Mask to control which fields get updated |
config OBJECT Configuration for a StoredInfoType |
config.displayName STRING Display name of the StoredInfoType (max 256 characters) |
config.description STRING Description of the StoredInfoType (max 256 characters) |
config.largeCustomDictionary OBJECT Configuration for a custom dictionary created from a data source of any size
up to the maximum size defined in the
limits page. The artifacts of
dictionary creation are stored in the specified Google Cloud Storage
location. Consider using |
config.largeCustomDictionary.bigQueryField OBJECT Message defining a field of a BigQuery table |
config.largeCustomDictionary.bigQueryField.table OBJECT Message defining the location of a BigQuery table. A table is uniquely
identified by its project_id, dataset_id, and table_name. Within a query
a table is often referenced with a string in the format of:
|
config.largeCustomDictionary.bigQueryField.field OBJECT General identifier of a data field in a storage service |
config.largeCustomDictionary.cloudStorageFileSet OBJECT Message representing a set of files in Cloud Storage |
config.largeCustomDictionary.cloudStorageFileSet.url STRING The url, in the format |
config.largeCustomDictionary.outputPath OBJECT Message representing a single file or path in Cloud Storage |
config.largeCustomDictionary.outputPath.path STRING A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt |
Output
This building block provides 32 output parameters
Name | Format | Description |
---|---|---|
pendingVersions[] |
OBJECT |
Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state |
pendingVersions[].createTime |
ANY |
Create timestamp of the version. Read-only, determined by the system when the version is created |
pendingVersions[].stats |
OBJECT |
Statistics for a StoredInfoType |
pendingVersions[].stats.largeCustomDictionary |
OBJECT |
Summary statistics of a custom dictionary |
pendingVersions[].stats.largeCustomDictionary.approxNumPhrases |
INTEGER |
Approximate number of distinct phrases in the dictionary |
pendingVersions[].config |
OBJECT |
Configuration for a StoredInfoType |
pendingVersions[].config.displayName |
STRING |
Display name of the StoredInfoType (max 256 characters) |
pendingVersions[].config.description |
STRING |
Description of the StoredInfoType (max 256 characters) |
pendingVersions[].config.largeCustomDictionary |
OBJECT |
Configuration for a custom dictionary created from a data source of any size
up to the maximum size defined in the
limits page. The artifacts of
dictionary creation are stored in the specified Google Cloud Storage
location. Consider using |
pendingVersions[].state |
ENUMERATION |
Stored info type version state. Read-only, updated by the system during dictionary creation |
pendingVersions[].errors[] |
OBJECT |
Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field |
pendingVersions[].errors[].timestamps[] |
ANY |
|
pendingVersions[].errors[].details |
OBJECT |
The You can find out more about this error model and how to work with it in the API Design Guide |
currentVersion |
OBJECT |
Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state |
currentVersion.createTime |
ANY |
Create timestamp of the version. Read-only, determined by the system when the version is created |
currentVersion.stats |
OBJECT |
Statistics for a StoredInfoType |
currentVersion.stats.largeCustomDictionary |
OBJECT |
Summary statistics of a custom dictionary |
currentVersion.stats.largeCustomDictionary.approxNumPhrases |
INTEGER |
Approximate number of distinct phrases in the dictionary |
currentVersion.config |
OBJECT |
Configuration for a StoredInfoType |
currentVersion.config.displayName |
STRING |
Display name of the StoredInfoType (max 256 characters) |
currentVersion.config.description |
STRING |
Description of the StoredInfoType (max 256 characters) |
currentVersion.config.largeCustomDictionary |
OBJECT |
Configuration for a custom dictionary created from a data source of any size
up to the maximum size defined in the
limits page. The artifacts of
dictionary creation are stored in the specified Google Cloud Storage
location. Consider using |
currentVersion.config.largeCustomDictionary.bigQueryField |
OBJECT |
Message defining a field of a BigQuery table |
currentVersion.config.largeCustomDictionary.cloudStorageFileSet |
OBJECT |
Message representing a set of files in Cloud Storage |
currentVersion.config.largeCustomDictionary.outputPath |
OBJECT |
Message representing a single file or path in Cloud Storage |
currentVersion.state |
ENUMERATION |
Stored info type version state. Read-only, updated by the system during dictionary creation |
currentVersion.errors[] |
OBJECT |
Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field |
currentVersion.errors[].timestamps[] |
ANY |
|
currentVersion.errors[].details |
OBJECT |
The You can find out more about this error model and how to work with it in the API Design Guide |
currentVersion.errors[].details.code |
INTEGER |
The status code, which should be an enum value of google.rpc.Code |
currentVersion.errors[].details.message |
STRING |
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 |
name |
STRING |
Resource name |
= Parameter name
= Format
pendingVersions[] OBJECT Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state |
pendingVersions[].createTime ANY Create timestamp of the version. Read-only, determined by the system when the version is created |
pendingVersions[].stats OBJECT Statistics for a StoredInfoType |
pendingVersions[].stats.largeCustomDictionary OBJECT Summary statistics of a custom dictionary |
pendingVersions[].stats.largeCustomDictionary.approxNumPhrases INTEGER Approximate number of distinct phrases in the dictionary |
pendingVersions[].config OBJECT Configuration for a StoredInfoType |
pendingVersions[].config.displayName STRING Display name of the StoredInfoType (max 256 characters) |
pendingVersions[].config.description STRING Description of the StoredInfoType (max 256 characters) |
pendingVersions[].config.largeCustomDictionary OBJECT Configuration for a custom dictionary created from a data source of any size
up to the maximum size defined in the
limits page. The artifacts of
dictionary creation are stored in the specified Google Cloud Storage
location. Consider using |
pendingVersions[].state ENUMERATION Stored info type version state. Read-only, updated by the system during dictionary creation |
pendingVersions[].errors[] OBJECT Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field |
pendingVersions[].errors[].timestamps[] ANY |
pendingVersions[].errors[].details OBJECT The You can find out more about this error model and how to work with it in the API Design Guide |
currentVersion OBJECT Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state |
currentVersion.createTime ANY Create timestamp of the version. Read-only, determined by the system when the version is created |
currentVersion.stats OBJECT Statistics for a StoredInfoType |
currentVersion.stats.largeCustomDictionary OBJECT Summary statistics of a custom dictionary |
currentVersion.stats.largeCustomDictionary.approxNumPhrases INTEGER Approximate number of distinct phrases in the dictionary |
currentVersion.config OBJECT Configuration for a StoredInfoType |
currentVersion.config.displayName STRING Display name of the StoredInfoType (max 256 characters) |
currentVersion.config.description STRING Description of the StoredInfoType (max 256 characters) |
currentVersion.config.largeCustomDictionary OBJECT Configuration for a custom dictionary created from a data source of any size
up to the maximum size defined in the
limits page. The artifacts of
dictionary creation are stored in the specified Google Cloud Storage
location. Consider using |
currentVersion.config.largeCustomDictionary.bigQueryField OBJECT Message defining a field of a BigQuery table |
currentVersion.config.largeCustomDictionary.cloudStorageFileSet OBJECT Message representing a set of files in Cloud Storage |
currentVersion.config.largeCustomDictionary.outputPath OBJECT Message representing a single file or path in Cloud Storage |
currentVersion.state ENUMERATION Stored info type version state. Read-only, updated by the system during dictionary creation |
currentVersion.errors[] OBJECT Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field |
currentVersion.errors[].timestamps[] ANY |
currentVersion.errors[].details OBJECT The You can find out more about this error model and how to work with it in the API Design Guide |
currentVersion.errors[].details.code INTEGER The status code, which should be an enum value of google.rpc.Code |
currentVersion.errors[].details.message STRING 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 |
name STRING Resource name |