create(parent, body, x__xgafv=None)
Creates a pre-built stored infoType to be used for inspection.
Deletes a stored infoType.
Gets a stored infoType.
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists stored infoTypes.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body, x__xgafv=None)
Updates the stored infoType by creating a new version. The existing version
create(parent, body, x__xgafv=None)
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, The parent resource name, for example projects/my-project-id or
organizations/my-org-id. (required)
body: object, The request body. (required)
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.
"config": { # Configuration for a StoredInfoType. # Configuration of the storedInfoType to create.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description 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.
"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.
"config": { # Configuration for a StoredInfoType. # StoredInfoType configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description of the StoredInfoType (max 256 characters).
},
"state": "A String", # Stored info type version state. Read-only, updated by the system
# during dictionary creation.
"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.
# Output only field.
"timestamps": [ # The times the error occurred.
"A String",
],
"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).
"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.
"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.
},
],
},
},
],
"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.
},
},
"createTime": "A String", # Create timestamp of the version. Read-only, determined by the system
# when the version is created.
},
],
"currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, # Current version of the stored info type.
# create timestamp, and current state.
"config": { # Configuration for a StoredInfoType. # StoredInfoType configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description of the StoredInfoType (max 256 characters).
},
"state": "A String", # Stored info type version state. Read-only, updated by the system
# during dictionary creation.
"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.
# Output only field.
"timestamps": [ # The times the error occurred.
"A String",
],
"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).
"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.
"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.
},
],
},
},
],
"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.
},
},
"createTime": "A String", # Create timestamp of the version. Read-only, determined by the system
# when the version is created.
},
"name": "A String", # Resource name.
}
delete(name, x__xgafv=None)
Deletes a stored infoType.
See https://cloud.google.com/dlp/docs/creating-stored-infotypes to
learn more.
Args:
name: string, 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 `{}`.
}
get(name, x__xgafv=None)
Gets a stored infoType.
See https://cloud.google.com/dlp/docs/creating-stored-infotypes to
learn more.
Args:
name: string, 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.
"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.
"config": { # Configuration for a StoredInfoType. # StoredInfoType configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description of the StoredInfoType (max 256 characters).
},
"state": "A String", # Stored info type version state. Read-only, updated by the system
# during dictionary creation.
"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.
# Output only field.
"timestamps": [ # The times the error occurred.
"A String",
],
"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).
"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.
"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.
},
],
},
},
],
"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.
},
},
"createTime": "A String", # Create timestamp of the version. Read-only, determined by the system
# when the version is created.
},
],
"currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, # Current version of the stored info type.
# create timestamp, and current state.
"config": { # Configuration for a StoredInfoType. # StoredInfoType configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description of the StoredInfoType (max 256 characters).
},
"state": "A String", # Stored info type version state. Read-only, updated by the system
# during dictionary creation.
"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.
# Output only field.
"timestamps": [ # The times the error occurred.
"A String",
],
"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).
"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.
"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.
},
],
},
},
],
"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.
},
},
"createTime": "A String", # Create timestamp of the version. Read-only, determined by the system
# when the version is created.
},
"name": "A String", # Resource name.
}
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists stored infoTypes.
See https://cloud.google.com/dlp/docs/creating-stored-infotypes to
learn more.
Args:
parent: string, The parent resource name, for example projects/my-project-id or
organizations/my-org-id. (required)
orderBy: string, Optional 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.
pageSize: integer, Optional size of the page, can be limited by server. If zero server returns
a page of max size 100.
pageToken: string, Optional page token to continue retrieval. Comes from previous call
to `ListStoredInfoTypes`.
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.
"nextPageToken": "A String", # If the next page is available then the next page token to be used
# in following ListStoredInfoTypes request.
"storedInfoTypes": [ # List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest.
{ # StoredInfoType resource message that contains information about the current
# version and any pending updates.
"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.
"config": { # Configuration for a StoredInfoType. # StoredInfoType configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description of the StoredInfoType (max 256 characters).
},
"state": "A String", # Stored info type version state. Read-only, updated by the system
# during dictionary creation.
"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.
# Output only field.
"timestamps": [ # The times the error occurred.
"A String",
],
"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).
"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.
"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.
},
],
},
},
],
"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.
},
},
"createTime": "A String", # Create timestamp of the version. Read-only, determined by the system
# when the version is created.
},
],
"currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, # Current version of the stored info type.
# create timestamp, and current state.
"config": { # Configuration for a StoredInfoType. # StoredInfoType configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description of the StoredInfoType (max 256 characters).
},
"state": "A String", # Stored info type version state. Read-only, updated by the system
# during dictionary creation.
"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.
# Output only field.
"timestamps": [ # The times the error occurred.
"A String",
],
"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).
"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.
"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.
},
],
},
},
],
"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.
},
},
"createTime": "A String", # Create timestamp of the version. Read-only, determined by the system
# when the version is created.
},
"name": "A String", # Resource name.
},
],
}
list_next(previous_request, previous_response)
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.
patch(name, body, x__xgafv=None)
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, 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. (required)
The object takes the form of:
{ # Request message for UpdateStoredInfoType.
"config": { # Configuration for a StoredInfoType. # Updated configuration for the storedInfoType. If not provided, a new
# version of the storedInfoType will be created with the existing
# configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description 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.
"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.
"config": { # Configuration for a StoredInfoType. # StoredInfoType configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description of the StoredInfoType (max 256 characters).
},
"state": "A String", # Stored info type version state. Read-only, updated by the system
# during dictionary creation.
"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.
# Output only field.
"timestamps": [ # The times the error occurred.
"A String",
],
"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).
"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.
"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.
},
],
},
},
],
"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.
},
},
"createTime": "A String", # Create timestamp of the version. Read-only, determined by the system
# when the version is created.
},
],
"currentVersion": { # Version of a StoredInfoType, including the configuration used to build it, # Current version of the stored info type.
# create timestamp, and current state.
"config": { # Configuration for a StoredInfoType. # StoredInfoType configuration.
"displayName": "A String", # Display name of the StoredInfoType (max 256 characters).
"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
},
"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:///`. Trailing wildcard in the
# path is allowed.
},
"bigQueryField": { # Message defining a field of a BigQuery table. # Field in a BigQuery table where each cell represents a dictionary phrase.
"field": { # General identifier of a data field in a storage service. # Designated field in the BigQuery table.
"name": "A String", # Name describing the field.
},
"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:
# `:.` or
# `..`.
"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.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
},
},
"description": "A String", # Description of the StoredInfoType (max 256 characters).
},
"state": "A String", # Stored info type version state. Read-only, updated by the system
# during dictionary creation.
"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.
# Output only field.
"timestamps": [ # The times the error occurred.
"A String",
],
"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).
"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.
"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.
},
],
},
},
],
"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.
},
},
"createTime": "A String", # Create timestamp of the version. Read-only, determined by the system
# when the version is created.
},
"name": "A String", # Resource name.
}