1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dlp_v2.html">Cloud Data Loss Prevention (DLP) API</a> . <a href="dlp_v2.projects.html">projects</a> . <a href="dlp_v2.projects.locations.html">locations</a> . <a href="dlp_v2.projects.locations.storedInfoTypes.html">storedInfoTypes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">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.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <pre>Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. 107 108Args: 109 parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Request message for CreateStoredInfoType. 114 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # Required. Configuration of the storedInfoType to create. 115 "description": "A String", # Description of the StoredInfoType (max 256 characters). 116 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 117 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 118 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 119 }, 120 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 121 "words": [ # 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] 122 "A String", 123 ], 124 }, 125 }, 126 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 127 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 128 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 129 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 130 "name": "A String", # Name describing the field. 131 }, 132 "table": { # 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: `:.` or `..`. # Source table of the field. 133 "datasetId": "A String", # Dataset ID of the table. 134 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 135 "tableId": "A String", # Name of the table. 136 }, 137 }, 138 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 139 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 140 }, 141 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 142 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 143 }, 144 }, 145 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 146 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 147 42, 148 ], 149 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 150 }, 151 }, 152 "locationId": "A String", # Deprecated. This field has no effect. 153 "storedInfoTypeId": "A String", # The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. 154} 155 156 x__xgafv: string, V1 error format. 157 Allowed values 158 1 - v1 error format 159 2 - v2 error format 160 161Returns: 162 An object of the form: 163 164 { # StoredInfoType resource message that contains information about the current version and any pending updates. 165 "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. 166 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # StoredInfoType configuration. 167 "description": "A String", # Description of the StoredInfoType (max 256 characters). 168 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 169 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 170 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 171 }, 172 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 173 "words": [ # 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] 174 "A String", 175 ], 176 }, 177 }, 178 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 179 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 180 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 181 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 182 "name": "A String", # Name describing the field. 183 }, 184 "table": { # 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: `:.` or `..`. # Source table of the field. 185 "datasetId": "A String", # Dataset ID of the table. 186 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 187 "tableId": "A String", # Name of the table. 188 }, 189 }, 190 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 191 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 192 }, 193 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 194 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 195 }, 196 }, 197 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 198 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 199 42, 200 ], 201 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 202 }, 203 }, 204 "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system when the version is created. 205 "errors": [ # 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 Google 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. 206 { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. 207 "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages. 208 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 209 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 210 { 211 "a_key": "", # Properties of the object. Contains field @type with type URL. 212 }, 213 ], 214 "message": "A 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. 215 }, 216 "timestamps": [ # The times the error occurred. 217 "A String", 218 ], 219 }, 220 ], 221 "state": "A String", # Stored info type version state. Read-only, updated by the system during dictionary creation. 222 "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. 223 "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. 224 "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. 225 }, 226 }, 227 }, 228 "name": "A String", # Resource name. 229 "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. 230 { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. 231 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # StoredInfoType configuration. 232 "description": "A String", # Description of the StoredInfoType (max 256 characters). 233 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 234 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 235 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 236 }, 237 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 238 "words": [ # 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] 239 "A String", 240 ], 241 }, 242 }, 243 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 244 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 245 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 246 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 247 "name": "A String", # Name describing the field. 248 }, 249 "table": { # 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: `:.` or `..`. # Source table of the field. 250 "datasetId": "A String", # Dataset ID of the table. 251 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 252 "tableId": "A String", # Name of the table. 253 }, 254 }, 255 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 256 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 257 }, 258 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 259 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 260 }, 261 }, 262 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 263 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 264 42, 265 ], 266 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 267 }, 268 }, 269 "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system when the version is created. 270 "errors": [ # 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 Google 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. 271 { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. 272 "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages. 273 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 274 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 275 { 276 "a_key": "", # Properties of the object. Contains field @type with type URL. 277 }, 278 ], 279 "message": "A 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. 280 }, 281 "timestamps": [ # The times the error occurred. 282 "A String", 283 ], 284 }, 285 ], 286 "state": "A String", # Stored info type version state. Read-only, updated by the system during dictionary creation. 287 "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. 288 "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. 289 "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. 290 }, 291 }, 292 }, 293 ], 294}</pre> 295</div> 296 297<div class="method"> 298 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 299 <pre>Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. 300 301Args: 302 name: string, Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required) 303 x__xgafv: string, V1 error format. 304 Allowed values 305 1 - v1 error format 306 2 - v2 error format 307 308Returns: 309 An object of the form: 310 311 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 312}</pre> 313</div> 314 315<div class="method"> 316 <code class="details" id="get">get(name, x__xgafv=None)</code> 317 <pre>Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. 318 319Args: 320 name: string, Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342. (required) 321 x__xgafv: string, V1 error format. 322 Allowed values 323 1 - v1 error format 324 2 - v2 error format 325 326Returns: 327 An object of the form: 328 329 { # StoredInfoType resource message that contains information about the current version and any pending updates. 330 "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. 331 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # StoredInfoType configuration. 332 "description": "A String", # Description of the StoredInfoType (max 256 characters). 333 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 334 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 335 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 336 }, 337 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 338 "words": [ # 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] 339 "A String", 340 ], 341 }, 342 }, 343 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 344 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 345 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 346 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 347 "name": "A String", # Name describing the field. 348 }, 349 "table": { # 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: `:.` or `..`. # Source table of the field. 350 "datasetId": "A String", # Dataset ID of the table. 351 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 352 "tableId": "A String", # Name of the table. 353 }, 354 }, 355 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 356 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 357 }, 358 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 359 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 360 }, 361 }, 362 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 363 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 364 42, 365 ], 366 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 367 }, 368 }, 369 "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system when the version is created. 370 "errors": [ # 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 Google 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. 371 { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. 372 "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages. 373 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 374 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 375 { 376 "a_key": "", # Properties of the object. Contains field @type with type URL. 377 }, 378 ], 379 "message": "A 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. 380 }, 381 "timestamps": [ # The times the error occurred. 382 "A String", 383 ], 384 }, 385 ], 386 "state": "A String", # Stored info type version state. Read-only, updated by the system during dictionary creation. 387 "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. 388 "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. 389 "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. 390 }, 391 }, 392 }, 393 "name": "A String", # Resource name. 394 "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. 395 { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. 396 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # StoredInfoType configuration. 397 "description": "A String", # Description of the StoredInfoType (max 256 characters). 398 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 399 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 400 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 401 }, 402 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 403 "words": [ # 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] 404 "A String", 405 ], 406 }, 407 }, 408 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 409 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 410 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 411 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 412 "name": "A String", # Name describing the field. 413 }, 414 "table": { # 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: `:.` or `..`. # Source table of the field. 415 "datasetId": "A String", # Dataset ID of the table. 416 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 417 "tableId": "A String", # Name of the table. 418 }, 419 }, 420 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 421 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 422 }, 423 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 424 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 425 }, 426 }, 427 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 428 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 429 42, 430 ], 431 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 432 }, 433 }, 434 "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system when the version is created. 435 "errors": [ # 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 Google 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. 436 { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. 437 "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages. 438 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 439 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 440 { 441 "a_key": "", # Properties of the object. Contains field @type with type URL. 442 }, 443 ], 444 "message": "A 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. 445 }, 446 "timestamps": [ # The times the error occurred. 447 "A String", 448 ], 449 }, 450 ], 451 "state": "A String", # Stored info type version state. Read-only, updated by the system during dictionary creation. 452 "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. 453 "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. 454 "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. 455 }, 456 }, 457 }, 458 ], 459}</pre> 460</div> 461 462<div class="method"> 463 <code class="details" id="list">list(parent, locationId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 464 <pre>Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. 465 466Args: 467 parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required) 468 locationId: string, Deprecated. This field has no effect. 469 orderBy: string, Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. 470 pageSize: integer, Size of the page, can be limited by server. If zero server returns a page of max size 100. 471 pageToken: string, Page token to continue retrieval. Comes from previous call to `ListStoredInfoTypes`. 472 x__xgafv: string, V1 error format. 473 Allowed values 474 1 - v1 error format 475 2 - v2 error format 476 477Returns: 478 An object of the form: 479 480 { # Response message for ListStoredInfoTypes. 481 "nextPageToken": "A String", # If the next page is available then the next page token to be used in following ListStoredInfoTypes request. 482 "storedInfoTypes": [ # List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. 483 { # StoredInfoType resource message that contains information about the current version and any pending updates. 484 "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. 485 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # StoredInfoType configuration. 486 "description": "A String", # Description of the StoredInfoType (max 256 characters). 487 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 488 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 489 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 490 }, 491 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 492 "words": [ # 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] 493 "A String", 494 ], 495 }, 496 }, 497 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 498 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 499 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 500 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 501 "name": "A String", # Name describing the field. 502 }, 503 "table": { # 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: `:.` or `..`. # Source table of the field. 504 "datasetId": "A String", # Dataset ID of the table. 505 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 506 "tableId": "A String", # Name of the table. 507 }, 508 }, 509 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 510 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 511 }, 512 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 513 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 514 }, 515 }, 516 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 517 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 518 42, 519 ], 520 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 521 }, 522 }, 523 "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system when the version is created. 524 "errors": [ # 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 Google 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. 525 { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. 526 "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages. 527 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 528 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 529 { 530 "a_key": "", # Properties of the object. Contains field @type with type URL. 531 }, 532 ], 533 "message": "A 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. 534 }, 535 "timestamps": [ # The times the error occurred. 536 "A String", 537 ], 538 }, 539 ], 540 "state": "A String", # Stored info type version state. Read-only, updated by the system during dictionary creation. 541 "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. 542 "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. 543 "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. 544 }, 545 }, 546 }, 547 "name": "A String", # Resource name. 548 "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. 549 { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. 550 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # StoredInfoType configuration. 551 "description": "A String", # Description of the StoredInfoType (max 256 characters). 552 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 553 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 554 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 555 }, 556 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 557 "words": [ # 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] 558 "A String", 559 ], 560 }, 561 }, 562 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 563 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 564 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 565 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 566 "name": "A String", # Name describing the field. 567 }, 568 "table": { # 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: `:.` or `..`. # Source table of the field. 569 "datasetId": "A String", # Dataset ID of the table. 570 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 571 "tableId": "A String", # Name of the table. 572 }, 573 }, 574 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 575 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 576 }, 577 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 578 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 579 }, 580 }, 581 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 582 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 583 42, 584 ], 585 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 586 }, 587 }, 588 "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system when the version is created. 589 "errors": [ # 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 Google 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. 590 { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. 591 "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages. 592 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 593 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 594 { 595 "a_key": "", # Properties of the object. Contains field @type with type URL. 596 }, 597 ], 598 "message": "A 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. 599 }, 600 "timestamps": [ # The times the error occurred. 601 "A String", 602 ], 603 }, 604 ], 605 "state": "A String", # Stored info type version state. Read-only, updated by the system during dictionary creation. 606 "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. 607 "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. 608 "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. 609 }, 610 }, 611 }, 612 ], 613 }, 614 ], 615}</pre> 616</div> 617 618<div class="method"> 619 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 620 <pre>Retrieves the next page of results. 621 622Args: 623 previous_request: The request for the previous page. (required) 624 previous_response: The response from the request for the previous page. (required) 625 626Returns: 627 A request object that you can call 'execute()' on to request the next 628 page. Returns None if there are no more items in the collection. 629 </pre> 630</div> 631 632<div class="method"> 633 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> 634 <pre>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. 635 636Args: 637 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) 638 body: object, The request body. 639 The object takes the form of: 640 641{ # Request message for UpdateStoredInfoType. 642 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration. 643 "description": "A String", # Description of the StoredInfoType (max 256 characters). 644 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 645 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 646 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 647 }, 648 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 649 "words": [ # 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] 650 "A String", 651 ], 652 }, 653 }, 654 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 655 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 656 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 657 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 658 "name": "A String", # Name describing the field. 659 }, 660 "table": { # 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: `:.` or `..`. # Source table of the field. 661 "datasetId": "A String", # Dataset ID of the table. 662 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 663 "tableId": "A String", # Name of the table. 664 }, 665 }, 666 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 667 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 668 }, 669 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 670 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 671 }, 672 }, 673 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 674 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 675 42, 676 ], 677 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 678 }, 679 }, 680 "updateMask": "A String", # Mask to control which fields get updated. 681} 682 683 x__xgafv: string, V1 error format. 684 Allowed values 685 1 - v1 error format 686 2 - v2 error format 687 688Returns: 689 An object of the form: 690 691 { # StoredInfoType resource message that contains information about the current version and any pending updates. 692 "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. # Current version of the stored info type. 693 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # StoredInfoType configuration. 694 "description": "A String", # Description of the StoredInfoType (max 256 characters). 695 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 696 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 697 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 698 }, 699 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 700 "words": [ # 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] 701 "A String", 702 ], 703 }, 704 }, 705 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 706 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 707 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 708 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 709 "name": "A String", # Name describing the field. 710 }, 711 "table": { # 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: `:.` or `..`. # Source table of the field. 712 "datasetId": "A String", # Dataset ID of the table. 713 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 714 "tableId": "A String", # Name of the table. 715 }, 716 }, 717 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 718 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 719 }, 720 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 721 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 722 }, 723 }, 724 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 725 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 726 42, 727 ], 728 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 729 }, 730 }, 731 "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system when the version is created. 732 "errors": [ # 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 Google 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. 733 { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. 734 "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages. 735 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 736 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 737 { 738 "a_key": "", # Properties of the object. Contains field @type with type URL. 739 }, 740 ], 741 "message": "A 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. 742 }, 743 "timestamps": [ # The times the error occurred. 744 "A String", 745 ], 746 }, 747 ], 748 "state": "A String", # Stored info type version state. Read-only, updated by the system during dictionary creation. 749 "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. 750 "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. 751 "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. 752 }, 753 }, 754 }, 755 "name": "A String", # Resource name. 756 "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are pending. 757 { # Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. 758 "config": { # Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/dlp/docs/creating-custom-infotypes. # StoredInfoType configuration. 759 "description": "A String", # Description of the StoredInfoType (max 256 characters). 760 "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Store dictionary-based CustomInfoType. 761 "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. 762 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 763 }, 764 "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. 765 "words": [ # 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] 766 "A String", 767 ], 768 }, 769 }, 770 "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). 771 "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/dlp/limits) page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements. # StoredInfoType where findings are defined by a dictionary of phrases. 772 "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. 773 "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. 774 "name": "A String", # Name describing the field. 775 }, 776 "table": { # 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: `:.` or `..`. # Source table of the field. 777 "datasetId": "A String", # Dataset ID of the table. 778 "projectId": "A String", # The Google Cloud Platform project ID of the project containing the table. If omitted, project ID is inferred from the API call. 779 "tableId": "A String", # Name of the table. 780 }, 781 }, 782 "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. 783 "url": "A String", # The url, in the format `gs:///`. Trailing wildcard in the path is allowed. 784 }, 785 "outputPath": { # Message representing a single file or path in Cloud Storage. # Location to store dictionary artifacts in Google 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. 786 "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. Example: gs://[BUCKET_NAME]/dictionary.txt 787 }, 788 }, 789 "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. 790 "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 791 42, 792 ], 793 "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. 794 }, 795 }, 796 "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system when the version is created. 797 "errors": [ # 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 Google 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. 798 { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. 799 "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages. 800 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 801 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 802 { 803 "a_key": "", # Properties of the object. Contains field @type with type URL. 804 }, 805 ], 806 "message": "A 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. 807 }, 808 "timestamps": [ # The times the error occurred. 809 "A String", 810 ], 811 }, 812 ], 813 "state": "A String", # Stored info type version state. Read-only, updated by the system during dictionary creation. 814 "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. 815 "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. 816 "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. 817 }, 818 }, 819 }, 820 ], 821}</pre> 822</div> 823 824</body></html>