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/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
Scopes
You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform.
You can set the scope for this method like this: dlp2 --scope <scope> projects stored-info-types-patch ...
Required Scalar Argument
- <name> (string)
- Required. Resource name of organization and storedInfoType to be updated, for example
organizations/433245324/storedInfoTypes/432452342
or projects/project-id/storedInfoTypes/432452342.
- Required. Resource name of organization and storedInfoType to be updated, for example
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
GooglePrivacyDlpV2UpdateStoredInfoTypeRequest:
config:
description: string
dictionary:
cloud-storage-path:
path: string
word-list:
words: [string]
display-name: string
large-custom-dictionary:
big-query-field:
field:
name: string
table:
dataset-id: string
project-id: string
table-id: string
cloud-storage-file-set:
url: string
output-path:
path: string
regex:
group-indexes: [integer]
pattern: string
update-mask: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r .config description=sit
- Description of the StoredInfoType (max 256 characters).
-
dictionary.cloud-storage-path path=sed
- A URL representing a file or path (no wildcards) in Cloud Storage. Example:
gs://[BUCKET_NAME]/dictionary.txt
- A URL representing a file or path (no wildcards) in Cloud Storage. Example:
-
..word-list words=duo
- 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]
- Each invocation of this argument appends the given value to the array.
-
... display-name=et
- Display name of the StoredInfoType (max 256 characters).
-
large-custom-dictionary.big-query-field.field name=dolor
- Name describing the field.
-
..table dataset-id=et
- Dataset ID of the table.
project-id=sed
- The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call.
-
table-id=justo
- Name of the table.
-
...cloud-storage-file-set url=sadipscing
- The url, in the format
gs:///
. Trailing wildcard in the path is allowed.
- The url, in the format
-
..output-path path=accusam
- A URL representing a file or path (no wildcards) in Cloud Storage. Example:
gs://[BUCKET_NAME]/dictionary.txt
- A URL representing a file or path (no wildcards) in Cloud Storage. Example:
-
...regex group-indexes=42
- The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.
- Each invocation of this argument appends the given value to the array.
-
pattern=invidunt
- Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.
-
... update-mask=invidunt
- Mask to control which fields get updated.
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").