| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="dlp_v2.html">Cloud Data Loss Prevention (DLP) API</a> . <a href="dlp_v2.organizations.html">organizations</a> . <a href="dlp_v2.organizations.locations.html">locations</a> . <a href="dlp_v2.organizations.locations.storedInfoTypes.html">storedInfoTypes</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a pre-built stored infoType to be used for inspection.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a stored infoType.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a stored infoType.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, orderBy=None, locationId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists stored infoTypes.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the stored infoType by creating a new version. The existing version</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| parent: string, Required. Parent resource name. |
| - Format:projects/[PROJECT-ID] |
| - Format:organizations/[ORGANIZATION-ID] |
| - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] |
| - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for CreateStoredInfoType. |
| "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. |
| "locationId": "A String", # Deprecated. This field has no effect. |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # Required. Configuration of the storedInfoType to create. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # StoredInfoType resource message that contains information about the current |
| # version and any pending updates. |
| "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, # Current version of the stored info type. |
| # create timestamp, and current state. |
| "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. |
| "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. |
| "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. |
| }, |
| }, |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # StoredInfoType configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "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. |
| { # Details information about an error encountered during job execution or |
| # the results of an unsuccessful activation of the JobTrigger. |
| "timestamps": [ # The times the error occurred. |
| "A String", |
| ], |
| "details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages. |
| # 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). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| }, |
| ], |
| "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system |
| # when the version is created. |
| "state": "A String", # Stored info type version state. Read-only, updated by the system |
| # during dictionary creation. |
| }, |
| "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are |
| # pending. |
| { # Version of a StoredInfoType, including the configuration used to build it, |
| # create timestamp, and current state. |
| "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. |
| "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. |
| "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. |
| }, |
| }, |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # StoredInfoType configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "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. |
| { # Details information about an error encountered during job execution or |
| # the results of an unsuccessful activation of the JobTrigger. |
| "timestamps": [ # The times the error occurred. |
| "A String", |
| ], |
| "details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages. |
| # 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). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| }, |
| ], |
| "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system |
| # when the version is created. |
| "state": "A String", # Stored info type version state. Read-only, updated by the system |
| # during dictionary creation. |
| }, |
| ], |
| "name": "A String", # Resource name. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a stored infoType. |
| See https://cloud.google.com/dlp/docs/creating-stored-infotypes to |
| learn more. |
| |
| Args: |
| 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) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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 `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a stored infoType. |
| See https://cloud.google.com/dlp/docs/creating-stored-infotypes to |
| learn more. |
| |
| Args: |
| 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) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # StoredInfoType resource message that contains information about the current |
| # version and any pending updates. |
| "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, # Current version of the stored info type. |
| # create timestamp, and current state. |
| "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. |
| "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. |
| "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. |
| }, |
| }, |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # StoredInfoType configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "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. |
| { # Details information about an error encountered during job execution or |
| # the results of an unsuccessful activation of the JobTrigger. |
| "timestamps": [ # The times the error occurred. |
| "A String", |
| ], |
| "details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages. |
| # 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). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| }, |
| ], |
| "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system |
| # when the version is created. |
| "state": "A String", # Stored info type version state. Read-only, updated by the system |
| # during dictionary creation. |
| }, |
| "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are |
| # pending. |
| { # Version of a StoredInfoType, including the configuration used to build it, |
| # create timestamp, and current state. |
| "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. |
| "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. |
| "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. |
| }, |
| }, |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # StoredInfoType configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "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. |
| { # Details information about an error encountered during job execution or |
| # the results of an unsuccessful activation of the JobTrigger. |
| "timestamps": [ # The times the error occurred. |
| "A String", |
| ], |
| "details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages. |
| # 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). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| }, |
| ], |
| "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system |
| # when the version is created. |
| "state": "A String", # Stored info type version state. Read-only, updated by the system |
| # during dictionary creation. |
| }, |
| ], |
| "name": "A String", # Resource name. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, orderBy=None, locationId=None, x__xgafv=None)</code> |
| <pre>Lists stored infoTypes. |
| See https://cloud.google.com/dlp/docs/creating-stored-infotypes to |
| learn more. |
| |
| Args: |
| parent: string, Required. Parent resource name. |
| - Format:projects/[PROJECT-ID] |
| - Format:organizations/[ORGANIZATION-ID] |
| - Format:projects/[PROJECT-ID]/locations/[LOCATION-ID] |
| - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] (required) |
| pageSize: integer, Size of the page, can be limited by server. If zero server returns |
| a page of max size 100. |
| pageToken: string, Page token to continue retrieval. Comes from previous call |
| to `ListStoredInfoTypes`. |
| 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. |
| locationId: string, Deprecated. This field has no effect. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ListStoredInfoTypes. |
| "storedInfoTypes": [ # List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. |
| { # StoredInfoType resource message that contains information about the current |
| # version and any pending updates. |
| "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, # Current version of the stored info type. |
| # create timestamp, and current state. |
| "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. |
| "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. |
| "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. |
| }, |
| }, |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # StoredInfoType configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "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. |
| { # Details information about an error encountered during job execution or |
| # the results of an unsuccessful activation of the JobTrigger. |
| "timestamps": [ # The times the error occurred. |
| "A String", |
| ], |
| "details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages. |
| # 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). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| }, |
| ], |
| "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system |
| # when the version is created. |
| "state": "A String", # Stored info type version state. Read-only, updated by the system |
| # during dictionary creation. |
| }, |
| "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are |
| # pending. |
| { # Version of a StoredInfoType, including the configuration used to build it, |
| # create timestamp, and current state. |
| "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. |
| "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. |
| "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. |
| }, |
| }, |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # StoredInfoType configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "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. |
| { # Details information about an error encountered during job execution or |
| # the results of an unsuccessful activation of the JobTrigger. |
| "timestamps": [ # The times the error occurred. |
| "A String", |
| ], |
| "details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages. |
| # 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). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| }, |
| ], |
| "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system |
| # when the version is created. |
| "state": "A String", # Stored info type version state. Read-only, updated by the system |
| # during dictionary creation. |
| }, |
| ], |
| "name": "A String", # Resource name. |
| }, |
| ], |
| "nextPageToken": "A String", # If the next page is available then the next page token to be used |
| # in following ListStoredInfoTypes request. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| 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) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for UpdateStoredInfoType. |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # Updated configuration for the storedInfoType. If not provided, a new |
| # version of the storedInfoType will be created with the existing |
| # configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "updateMask": "A String", # Mask to control which fields get updated. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # StoredInfoType resource message that contains information about the current |
| # version and any pending updates. |
| "currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, # Current version of the stored info type. |
| # create timestamp, and current state. |
| "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. |
| "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. |
| "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. |
| }, |
| }, |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # StoredInfoType configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "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. |
| { # Details information about an error encountered during job execution or |
| # the results of an unsuccessful activation of the JobTrigger. |
| "timestamps": [ # The times the error occurred. |
| "A String", |
| ], |
| "details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages. |
| # 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). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| }, |
| ], |
| "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system |
| # when the version is created. |
| "state": "A String", # Stored info type version state. Read-only, updated by the system |
| # during dictionary creation. |
| }, |
| "pendingVersions": [ # Pending versions of the stored info type. Empty if no versions are |
| # pending. |
| { # Version of a StoredInfoType, including the configuration used to build it, |
| # create timestamp, and current state. |
| "stats": { # Statistics for a StoredInfoType. # Statistics about this storedInfoType version. |
| "largeCustomDictionary": { # Summary statistics of a custom dictionary. # StoredInfoType where findings are defined by a dictionary of phrases. |
| "approxNumPhrases": "A String", # Approximate number of distinct phrases in the dictionary. |
| }, |
| }, |
| "config": { # Configuration for stored infoTypes. All fields and subfield are provided # StoredInfoType configuration. |
| # by the user. For more information, see |
| # https://cloud.google.com/dlp/docs/creating-custom-infotypes. |
| "dictionary": { # Custom information type based on a dictionary of words or phrases. This can # Store dictionary-based CustomInfoType. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. |
| "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] |
| "A String", |
| ], |
| }, |
| }, |
| "largeCustomDictionary": { # Configuration for a custom dictionary created from a data source of any size # StoredInfoType where findings are defined by a dictionary of phrases. |
| # 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. |
| "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. |
| "path": "A String", # A url representing a file or path (no wildcards) in Cloud Storage. |
| # Example: gs://[BUCKET_NAME]/dictionary.txt |
| }, |
| "bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase. |
| "table": { # Message defining the location of a BigQuery table. A table is uniquely # Source table of the field. |
| # 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: |
| # `<project_id>:<dataset_id>.<table_id>` or |
| # `<project_id>.<dataset_id>.<table_id>`. |
| "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. |
| "datasetId": "A String", # Dataset ID of the table. |
| "tableId": "A String", # Name of the table. |
| }, |
| "field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table. |
| "name": "A String", # Name describing the field. |
| }, |
| }, |
| "cloudStorageFileSet": { # Message representing a set of files in Cloud Storage. # Set of files containing newline-delimited lists of dictionary phrases. |
| "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
| # path is allowed. |
| }, |
| }, |
| "regex": { # Message defining a custom regular expression. # Store regular expression-based StoredInfoType. |
| "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. |
| 42, |
| ], |
| "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. |
| }, |
| "description": "A String", # Description of the StoredInfoType (max 256 characters). |
| "displayName": "A String", # Display name of the StoredInfoType (max 256 characters). |
| }, |
| "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. |
| { # Details information about an error encountered during job execution or |
| # the results of an unsuccessful activation of the JobTrigger. |
| "timestamps": [ # The times the error occurred. |
| "A String", |
| ], |
| "details": { # The `Status` type defines a logical error model that is suitable for # Detailed error codes and messages. |
| # 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). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "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. |
| }, |
| }, |
| ], |
| "createTime": "A String", # Create timestamp of the version. Read-only, determined by the system |
| # when the version is created. |
| "state": "A String", # Stored info type version state. Read-only, updated by the system |
| # during dictionary creation. |
| }, |
| ], |
| "name": "A String", # Resource name. |
| }</pre> |
| </div> |
| |
| </body></html> |
