Types for Google Cloud Datacatalog v1beta1 API¶
- class google.cloud.datacatalog_v1beta1.types.BigQueryDateShardedSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpec for a group of BigQuery tables with name pattern
[prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding- dataset¶
Output only. The Data Catalog resource name of the dataset entry the current table belongs to, for example,
projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}.- Type
- table_prefix¶
Output only. The table name prefix of the shards. The name of any given shard is
[table_prefix]YYYYMMDD, for example, for shardMyTable20180101, thetable_prefixisMyTable.- Type
- class google.cloud.datacatalog_v1beta1.types.BigQueryTableSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a BigQuery table.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- table_source_type¶
Output only. The table source type.
- view_spec¶
Table view specification. This field should only be populated if
table_source_typeisBIGQUERY_VIEW.This field is a member of oneof
type_spec.
- class google.cloud.datacatalog_v1beta1.types.ColumnSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresentation of a column within a schema. Columns could be nested inside other columns.
- mode¶
Optional. A column’s mode indicates whether the values in this column are required, nullable, etc. Only
NULLABLE,REQUIREDandREPEATEDare supported. Default mode isNULLABLE.- Type
- subcolumns¶
Optional. Schema of sub-columns. A column can have zero or more sub-columns.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.ColumnSchema]
- class google.cloud.datacatalog_v1beta1.types.CreateEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntryGroup].
- parent¶
Required. The name of the project this entry group is in. Example:
projects/{project_id}/locations/{location}
Note that this EntryGroup and its child resources may not actually be stored in the location in this name.
- Type
- entry_group_id¶
Required. The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.
- Type
- entry_group¶
The entry group to create. Defaults to an empty entry group.
- class google.cloud.datacatalog_v1beta1.types.CreateEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry].
- parent¶
Required. The name of the entry group this entry is in. Example:
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
Note that this Entry and its child resources may not actually be stored in the location in this name.
- Type
- entry¶
Required. The entry to create.
- class google.cloud.datacatalog_v1beta1.types.CreatePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreatePolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.CreatePolicyTag].
- policy_tag¶
The policy tag to be created.
- class google.cloud.datacatalog_v1beta1.types.CreateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateTag][google.cloud.datacatalog.v1beta1.DataCatalog.CreateTag].
- parent¶
Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example:
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Note that this Tag and its child resources may not actually be stored in the location in this name.
- Type
- tag¶
Required. The tag to create.
- class google.cloud.datacatalog_v1beta1.types.CreateTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateTagTemplateField][google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplateField].
- parent¶
Required. The name of the project and the template location region.
Example:
projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id}
- Type
- tag_template_field_id¶
Required. The ID of the tag template field to create. Field ids can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
- Type
- tag_template_field¶
Required. The tag template field to create.
- class google.cloud.datacatalog_v1beta1.types.CreateTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplate].
- parent¶
Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions.
Example:
projects/{project_id}/locations/us-central1
- Type
- tag_template¶
Required. The tag template to create.
- class google.cloud.datacatalog_v1beta1.types.CreateTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.CreateTaxonomy].
- taxonomy¶
The taxonomy to be created.
- class google.cloud.datacatalog_v1beta1.types.DeleteEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntryGroup].
- name¶
Required. The name of the entry group. For example,
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}.- Type
- class google.cloud.datacatalog_v1beta1.types.DeleteEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteEntry][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntry].
- class google.cloud.datacatalog_v1beta1.types.DeletePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeletePolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.DeletePolicyTag].
- class google.cloud.datacatalog_v1beta1.types.DeleteTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteTag][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTag].
- class google.cloud.datacatalog_v1beta1.types.DeleteTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteTagTemplateField][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplateField].
- name¶
Required. The name of the tag template field to delete. Example:
projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
- Type
- class google.cloud.datacatalog_v1beta1.types.DeleteTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplate].
- name¶
Required. The name of the tag template to delete. Example:
projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
- Type
- class google.cloud.datacatalog_v1beta1.types.DeleteTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.DeleteTaxonomy].
- class google.cloud.datacatalog_v1beta1.types.Entry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or outside of Google Cloud Platform. Clients can use the
linked_resourcefield in the Entry resource to refer to the original resource ID of the source system.An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a [Tag][google.cloud.datacatalog.v1beta1.Tag].
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- name¶
Output only. The Data Catalog resource name of the entry in URL format. Example:
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Note that this Entry and its child resources may not actually be stored in the location in this name.
- Type
- linked_resource¶
The resource this metadata entry refers to.
For Google Cloud Platform resources,
linked_resourceis the full name of the resource. For example, thelinked_resourcefor a table resource from BigQuery is://bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
- Type
- type_¶
The type of the entry. Only used for Entries with types in the EntryType enum.
This field is a member of oneof
entry_type.
- user_specified_type¶
Entry type if it does not fit any of the input-allowed values listed in
EntryTypeenum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example “my_special_type”.user_specified_typestrings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use
user_specified_type.This field is a member of oneof
entry_type.- Type
- integrated_system¶
Output only. This field indicates the entry’s source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
This field is a member of oneof
system.- Type
google.cloud.datacatalog_v1beta1.types.IntegratedSystem
- user_specified_system¶
This field indicates the entry’s source system that Data Catalog does not integrate with.
user_specified_systemstrings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.This field is a member of oneof
system.- Type
- gcs_fileset_spec¶
Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
This field is a member of oneof
type_spec.
- bigquery_table_spec¶
Specification that applies to a BigQuery table. This is only valid on entries of type
TABLE.This field is a member of oneof
type_spec.
- bigquery_date_sharded_spec¶
Specification for a group of BigQuery tables with name pattern
[prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.This field is a member of oneof
type_spec.
- display_name¶
Display information such as title and description. A short name to identify the entry, for example, “Analytics Data - Jan 2011”. Default value is an empty string.
- Type
- description¶
Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
- Type
- schema¶
Schema of the entry. An entry might not have any schema attached to it.
- source_system_timestamps¶
Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.
- usage_signal¶
Output only. Statistics on the usage level of the resource.
- class google.cloud.datacatalog_v1beta1.types.EntryGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog [Entry][google.cloud.datacatalog.v1beta1.Entry] resources.
- name¶
The resource name of the entry group in URL format. Example:
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
Note that this EntryGroup and its child resources may not actually be stored in the location in this name.
- Type
- display_name¶
A short name to identify the entry group, for example, “analytics data - jan 2011”. Default value is an empty string.
- Type
- description¶
Entry group description, which can consist of several sentences or paragraphs that describe entry group contents. Default value is an empty string.
- Type
- data_catalog_timestamps¶
Output only. Timestamps about this EntryGroup. Default value is empty timestamps.
- class google.cloud.datacatalog_v1beta1.types.EntryType(value)[source]¶
Bases:
proto.enums.EnumEntry resources in Data Catalog can be of different types e.g. a BigQuery Table entry is of type
TABLE. This enum describes all the possible types Data Catalog contains.- Values:
- ENTRY_TYPE_UNSPECIFIED (0):
Default unknown type.
- TABLE (2):
Output only. The type of entry that has a GoogleSQL schema, including logical views.
- MODEL (5):
Output only. The type of models. https://cloud.google.com/bigquery-ml/docs/bigqueryml-intro
- DATA_STREAM (3):
Output only. An entry type which is used for streaming entries. Example: Pub/Sub topic.
- FILESET (4):
An entry type which is a set of files or objects. Example: Cloud Storage fileset.
- class google.cloud.datacatalog_v1beta1.types.ExportTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ExportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies].
- class google.cloud.datacatalog_v1beta1.types.ExportTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ExportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies].
- taxonomies¶
List of taxonomies and policy tags in a tree structure.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.SerializedTaxonomy]
- class google.cloud.datacatalog_v1beta1.types.FieldType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- primitive_type¶
Represents primitive types - string, bool etc.
This field is a member of oneof
type_decl.
- class EnumType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- allowed_values¶
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.FieldType.EnumType.EnumValue]
- class EnumValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
- class PrimitiveType(value)[source]¶
Bases:
proto.enums.Enum- Values:
- PRIMITIVE_TYPE_UNSPECIFIED (0):
This is the default invalid value for a type.
- DOUBLE (1):
A double precision number.
- STRING (2):
An UTF-8 string.
- BOOL (3):
A boolean value.
- TIMESTAMP (4):
A timestamp.
- class google.cloud.datacatalog_v1beta1.types.GcsFileSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifications of a single file in Cloud Storage.
- gcs_timestamps¶
Output only. Timestamps about the Cloud Storage file.
- class google.cloud.datacatalog_v1beta1.types.GcsFilesetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a Cloud Storage fileset entry.
- file_patterns¶
Required. Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported.
Examples of valid file_patterns:
gs://bucket_name/dir/*: matches all files withinbucket_name/dirdirectory.gs://bucket_name/dir/**: matches all files inbucket_name/dirspanning all subdirectories.gs://bucket_name/file*: matches files prefixed byfileinbucket_namegs://bucket_name/??.txt: matches files with two characters followed by.txtinbucket_namegs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by.txtinbucket_namegs://bucket_name/[a-m].txt: matches files that containa,b, … ormfollowed by.txtinbucket_namegs://bucket_name/a/*/b: matches all files inbucket_namethat matcha/*/bpattern, such asa/c/b,a/d/bgs://another_bucket/a.txt: matchesgs://another_bucket/a.txt
You can combine wildcards to provide more powerful matches, for example:
gs://bucket_name/[a-m]??.j*g
- Type
MutableSequence[str]
- sample_gcs_file_specs¶
Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.GcsFileSpec]
- class google.cloud.datacatalog_v1beta1.types.GetEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.GetEntryGroup].
- name¶
Required. The name of the entry group. For example,
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}.- Type
- read_mask¶
The fields to return. If not set or empty, all fields are returned.
- class google.cloud.datacatalog_v1beta1.types.GetEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetEntry][google.cloud.datacatalog.v1beta1.DataCatalog.GetEntry].
- class google.cloud.datacatalog_v1beta1.types.GetPolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetPolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.GetPolicyTag].
- class google.cloud.datacatalog_v1beta1.types.GetTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.GetTagTemplate].
- class google.cloud.datacatalog_v1beta1.types.GetTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.GetTaxonomy].
- class google.cloud.datacatalog_v1beta1.types.ImportTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ImportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies].
- class google.cloud.datacatalog_v1beta1.types.ImportTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ImportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies].
- taxonomies¶
Taxonomies that were imported.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.Taxonomy]
- class google.cloud.datacatalog_v1beta1.types.InlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInline source used for taxonomies import.
- taxonomies¶
Required. Taxonomies to be imported.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.SerializedTaxonomy]
- class google.cloud.datacatalog_v1beta1.types.ListEntriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListEntries][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntries].
- parent¶
Required. The name of the entry group that contains the entries, which can be provided in URL format. Example:
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
- Type
- page_size¶
The maximum number of items to return. Default is 10. Max limit is 1000. Throws an invalid argument for
page_size > 1000.- Type
- page_token¶
Token that specifies which page is requested. If empty, the first page is returned.
- Type
- read_mask¶
The fields to return for each Entry. If not set or empty, all fields are returned. For example, setting read_mask to contain only one path “name” will cause ListEntries to return a list of Entries with only “name” field.
- class google.cloud.datacatalog_v1beta1.types.ListEntriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListEntries][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntries].
- entries¶
Entry details.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.Entry]
- class google.cloud.datacatalog_v1beta1.types.ListEntryGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListEntryGroups][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntryGroups].
- parent¶
Required. The name of the location that contains the entry groups, which can be provided in URL format. Example:
projects/{project_id}/locations/{location}
- Type
- page_size¶
Optional. The maximum number of items to return. Default is 10. Max limit is 1000. Throws an invalid argument for
page_size > 1000.- Type
- class google.cloud.datacatalog_v1beta1.types.ListEntryGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListEntryGroups][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntryGroups].
- entry_groups¶
EntryGroup details.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.EntryGroup]
- class google.cloud.datacatalog_v1beta1.types.ListPolicyTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListPolicyTags][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags].
- page_size¶
The maximum number of items to return. Must be a value between 1 and 1000. If not set, defaults to 50.
- Type
- class google.cloud.datacatalog_v1beta1.types.ListPolicyTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListPolicyTags][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags].
- policy_tags¶
The policy tags that are in the requested taxonomy.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.PolicyTag]
- class google.cloud.datacatalog_v1beta1.types.ListTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListTags][google.cloud.datacatalog.v1beta1.DataCatalog.ListTags].
- parent¶
Required. The name of the Data Catalog resource to list the tags of. The resource could be an [Entry][google.cloud.datacatalog.v1beta1.Entry] or an [EntryGroup][google.cloud.datacatalog.v1beta1.EntryGroup].
Examples:
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
- Type
- class google.cloud.datacatalog_v1beta1.types.ListTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListTags][google.cloud.datacatalog.v1beta1.DataCatalog.ListTags].
- tags¶
[Tag][google.cloud.datacatalog.v1beta1.Tag] details.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.Tag]
- class google.cloud.datacatalog_v1beta1.types.ListTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListTaxonomies].
- page_size¶
The maximum number of items to return. Must be a value between 1 and 1000. If not set, defaults to 50.
- Type
- page_token¶
The next_page_token value returned from a previous list request, if any. If not set, defaults to an empty string.
- Type
- class google.cloud.datacatalog_v1beta1.types.ListTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListTaxonomies].
- taxonomies¶
Taxonomies that the project contains.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.Taxonomy]
- class google.cloud.datacatalog_v1beta1.types.LookupEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [LookupEntry][google.cloud.datacatalog.v1beta1.DataCatalog.LookupEntry].
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- linked_resource¶
The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Full names are case-sensitive.
Examples:
//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
//pubsub.googleapis.com/projects/projectId/topics/topicId
This field is a member of oneof
target_name.- Type
- sql_resource¶
The SQL name of the entry. SQL names are case-sensitive.
Examples:
pubsub.project_id.topic_idpubsub.project_id.`topic.id.with.dots`bigquery.table.project_id.dataset_id.table_idbigquery.dataset.project_id.dataset_iddatacatalog.entry.project_id.location_id.entry_group_id.entry_id
*_ids should satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.This field is a member of oneof
target_name.- Type
- class google.cloud.datacatalog_v1beta1.types.PolicyTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDenotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy:
Geolocation -> (LatLong, City, ZipCode). PolicyTag “Geolocation” contains three child policy tags: “LatLong”, “City”, and “ZipCode”.
- name¶
Output only. Resource name of this policy tag, whose format is: “projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{id}”.
- Type
- display_name¶
Required. User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
- Type
- description¶
Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
- Type
- parent_policy_tag¶
Resource name of this policy tag’s parent policy tag (e.g. for the “LatLong” policy tag in the example above, this field contains the resource name of the “Geolocation” policy tag). If empty, it means this policy tag is a top level policy tag (e.g. this field is empty for the “Geolocation” policy tag in the example above). If not set, defaults to an empty string.
- Type
- class google.cloud.datacatalog_v1beta1.types.RenameTagTemplateFieldEnumValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [RenameTagTemplateFieldEnumValue][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue].
- name¶
Required. The name of the enum field value. Example:
projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}
- Type
- class google.cloud.datacatalog_v1beta1.types.RenameTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [RenameTagTemplateField][google.cloud.datacatalog.v1beta1.DataCatalog.RenameTagTemplateField].
- name¶
Required. The name of the tag template. Example:
projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
- Type
- class google.cloud.datacatalog_v1beta1.types.Schema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
- columns¶
Required. Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.ColumnSchema]
- class google.cloud.datacatalog_v1beta1.types.SearchCatalogRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
- scope¶
Required. The scope of this search request. A
scopethat has emptyinclude_org_ids,include_project_idsAND falseinclude_gcp_public_datasetsis considered invalid. Data Catalog will return an error in such a case.
- query¶
Optional. The query string in search query syntax. An empty query string will result in all data assets (in the specified scope) that the user has access to. Query strings can be simple as “x” or more qualified as:
name:x
column:x
description:y
Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See Data Catalog Search Syntax for more information.
- Type
- page_size¶
Number of results in the search page. If <=0 then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.
- Type
- page_token¶
Optional. Pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token], which indicates that this is a continuation of a prior [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data. If empty, the first page is returned.
- Type
- order_by¶
Specifies the ordering of results, currently supported case-sensitive choices are:
relevance, only supports descendinglast_modified_timestamp [asc|desc], defaults to descending if not specifieddefaultthat can only be descending
If not specified, defaults to
relevancedescending.- Type
- class Scope(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe criteria that select the subspace used for query matching.
- include_org_ids¶
The list of organization IDs to search within. To find your organization ID, follow instructions in https://cloud.google.com/resource-manager/docs/creating-managing-organization.
- Type
MutableSequence[str]
- include_project_ids¶
The list of project IDs to search within. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects.
- Type
MutableSequence[str]
- include_gcp_public_datasets¶
If
true, include Google Cloud public datasets in the search results. Info on Google Cloud public datasets is available at https://cloud.google.com/public-datasets/. By default, Google Cloud public datasets are excluded.- Type
- restricted_locations¶
Optional. The list of locations to search within.
If empty, search will be performed in all locations;
If any of the locations are NOT in the valid locations list, error will be returned;
Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the
SearchCatalogResponse.unreachablefield, users can repeat the search request with this parameter set to get additional information on the error.
Valid locations:
asia-east1
asia-east2
asia-northeast1
asia-northeast2
asia-northeast3
asia-south1
asia-southeast1
australia-southeast1
eu
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
europe-west6
global
northamerica-northeast1
southamerica-east1
us
us-central1
us-east1
us-east4
us-west1
us-west2
- Type
MutableSequence[str]
- class google.cloud.datacatalog_v1beta1.types.SearchCatalogResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
- results¶
Search results.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.SearchCatalogResult]
- unreachable¶
Unreachable locations. Search result does not include data from those locations. Users can get additional information on the error by repeating the search request with a more restrictive parameter – setting the value for
SearchDataCatalogRequest.scope.restricted_locations.- Type
MutableSequence[str]
- class google.cloud.datacatalog_v1beta1.types.SearchCatalogResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA result that appears in the response of a search request. Each result captures details of one entry that matches the search.
- search_result_type¶
Type of the search result. This field can be used to determine which Get method to call to fetch the full resource.
- search_result_subtype¶
Sub-type of the search result. This is a dot-delimited description of the resource’s full type, and is the same as the value callers would provide in the “type” search facet. Examples:
entry.table,entry.dataStream,tagTemplate.- Type
- relative_resource_name¶
The relative resource name of the resource in URL format. Examples:
projects/{project_id}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}projects/{project_id}/tagTemplates/{tag_template_id}
- Type
- linked_resource¶
The full name of the cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example:
//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
- Type
- modify_time¶
Last-modified timestamp of the entry from the managing system.
- class google.cloud.datacatalog_v1beta1.types.SearchResultType(value)[source]¶
Bases:
proto.enums.EnumThe different types of resources that can be returned in search.
- Values:
- SEARCH_RESULT_TYPE_UNSPECIFIED (0):
Default unknown type.
- ENTRY (1):
An [Entry][google.cloud.datacatalog.v1beta1.Entry].
- TAG_TEMPLATE (2):
A [TagTemplate][google.cloud.datacatalog.v1beta1.TagTemplate].
- ENTRY_GROUP (3):
An [EntryGroup][google.cloud.datacatalog.v1beta1.EntryGroup].
- class google.cloud.datacatalog_v1beta1.types.SerializedPolicyTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage representing one policy tag when exported as a nested proto.
- policy_tag¶
Resource name of the policy tag.
This field will be ignored when calling ImportTaxonomies.
- Type
- display_name¶
Required. Display name of the policy tag. Max 200 bytes when encoded in UTF-8.
- Type
- description¶
Description of the serialized policy tag. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
- Type
- child_policy_tags¶
Children of the policy tag if any.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.SerializedPolicyTag]
- class google.cloud.datacatalog_v1beta1.types.SerializedTaxonomy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.
- description¶
Description of the serialized taxonomy. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
- Type
- policy_tags¶
Top level policy tags associated with the taxonomy if any.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.SerializedPolicyTag]
- activated_policy_types¶
A list of policy types that are activated for a taxonomy.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.Taxonomy.PolicyType]
- class google.cloud.datacatalog_v1beta1.types.SystemTimestamps(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTimestamps about this resource according to a particular system.
- create_time¶
The creation time of the resource within the given system.
- update_time¶
The last-modified time of the resource within the given system.
- expire_time¶
Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
- class google.cloud.datacatalog_v1beta1.types.TableSourceType(value)[source]¶
Bases:
proto.enums.EnumTable source type.
- Values:
- TABLE_SOURCE_TYPE_UNSPECIFIED (0):
Default unknown type.
- BIGQUERY_VIEW (2):
Table view.
- BIGQUERY_TABLE (5):
BigQuery native table.
- BIGQUERY_MATERIALIZED_VIEW (7):
BigQuery materialized view.
- class google.cloud.datacatalog_v1beta1.types.TableSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNormal BigQuery table spec.
- grouped_entry¶
Output only. If the table is a dated shard, i.e., with name pattern
[prefix]YYYYMMDD,grouped_entryis the Data Catalog resource name of the date sharded grouped entry, for example,projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}. Otherwise,grouped_entryis empty.- Type
- class google.cloud.datacatalog_v1beta1.types.Tag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template.
See Data Catalog IAM for information on the permissions needed to create or view tags.
- name¶
The resource name of the tag in URL format. Example:
projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
where
tag_idis a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.- Type
- template¶
Required. The resource name of the tag template that this tag uses. Example:
projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
This field cannot be modified after creation.
- Type
- column¶
Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema.
For attaching a tag to a nested column, use
.to separate the column names. Example:outer_column.inner_column
This field is a member of oneof
scope.- Type
- fields¶
Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields.
- Type
MutableMapping[str, google.cloud.datacatalog_v1beta1.types.TagField]
- class FieldsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datacatalog_v1beta1.types.TagField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains the value and supporting information for a field within a [Tag][google.cloud.datacatalog.v1beta1.Tag].
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- double_value¶
Holds the value for a tag field with double type.
This field is a member of oneof
kind.- Type
- string_value¶
Holds the value for a tag field with string type.
This field is a member of oneof
kind.- Type
- bool_value¶
Holds the value for a tag field with boolean type.
This field is a member of oneof
kind.- Type
- timestamp_value¶
Holds the value for a tag field with timestamp type.
This field is a member of oneof
kind.
- enum_value¶
Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum.
This field is a member of oneof
kind.
- order¶
Output only. The order of this field with respect to other fields in this tag. It can be set in [Tag][google.cloud.datacatalog.v1beta1.TagTemplateField.order]. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
- Type
- class EnumValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHolds an enum value.
- class google.cloud.datacatalog_v1beta1.types.TagTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. See, for example, the TagTemplate User role, which includes permission to use the tag template to tag resources.
- name¶
The resource name of the tag template in URL format. Example:
projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
Note that this TagTemplate and its child resources may not actually be stored in the location in this name.
- Type
- fields¶
Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.
The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
- Type
MutableMapping[str, google.cloud.datacatalog_v1beta1.types.TagTemplateField]
- class FieldsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datacatalog_v1beta1.types.TagTemplateField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe template for an individual field within a tag template.
- name¶
Output only. The resource name of the tag template field in URL format. Example:
projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}
Note that this TagTemplateField may not actually be stored in the location in this name.
- Type
- type_¶
Required. The type of value this tag field can contain.
- class google.cloud.datacatalog_v1beta1.types.Taxonomy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA taxonomy is a collection of policy tags that classify data along a common axis. For instance a data sensitivity taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data origin taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.
- name¶
Output only. Resource name of this taxonomy, whose format is: “projects/{project_number}/locations/{location_id}/taxonomies/{id}”.
- Type
- display_name¶
Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
The taxonomy display name must be unique within an organization.
- Type
- description¶
Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.
- Type
- taxonomy_timestamps¶
Output only. Timestamps about this taxonomy. Only create_time and update_time are used.
- activated_policy_types¶
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
- Type
MutableSequence[google.cloud.datacatalog_v1beta1.types.Taxonomy.PolicyType]
- service¶
Output only. Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only ‘DATAPLEX’ is supported.
- class PolicyType(value)[source]¶
Bases:
proto.enums.EnumDefines policy types where policy tag can be used for.
- Values:
- POLICY_TYPE_UNSPECIFIED (0):
Unspecified policy type.
- FINE_GRAINED_ACCESS_CONTROL (1):
Fine grained access control policy, which enables access control on tagged resources.
- class google.cloud.datacatalog_v1beta1.types.UpdateEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntryGroup].
- entry_group¶
Required. The updated entry group. “name” field must be set.
- update_mask¶
Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
- class google.cloud.datacatalog_v1beta1.types.UpdateEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntry].
- entry¶
Required. The updated entry. The “name” field must be set.
- update_mask¶
Names of fields whose values to overwrite on an entry.
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
The following fields are modifiable:
For entries with type
DATA_STREAM:schema
For entries with type
FILESET:schemadisplay_namedescriptiongcs_fileset_specgcs_fileset_spec.file_patterns
For entries with
user_specified_type:schemadisplay_namedescriptionuser_specified_typeuser_specified_systemlinked_resourcesource_system_timestamps
- class google.cloud.datacatalog_v1beta1.types.UpdatePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdatePolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdatePolicyTag].
- policy_tag¶
The policy tag to update. Only the description, display_name, and parent_policy_tag fields can be updated.
- update_mask¶
The update mask applies to the resource. Only display_name, description and parent_policy_tag can be updated and thus can be listed in the mask. If update_mask is not provided, all allowed fields (i.e. display_name, description and parent) will be updated. For more information including the
FieldMaskdefinition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
- class google.cloud.datacatalog_v1beta1.types.UpdateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateTag][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTag].
- tag¶
Required. The updated tag. The “name” field must be set.
- update_mask¶
Note: Currently, this parameter can only take
"fields"as value.Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name
fields.In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
- class google.cloud.datacatalog_v1beta1.types.UpdateTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateTagTemplateField][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplateField].
- name¶
Required. The name of the tag template field. Example:
projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
- Type
- tag_template_field¶
Required. The template to update.
- update_mask¶
Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
display_nametype.enum_typeis_required
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.
Additionally, updating a template field from optional to required is not allowed.
- class google.cloud.datacatalog_v1beta1.types.UpdateTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplate].
- tag_template¶
Required. The template to update. The “name” field must be set.
- update_mask¶
Names of fields whose values to overwrite on a tag template. Currently, only
display_namecan be overwritten.In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
- class google.cloud.datacatalog_v1beta1.types.UpdateTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdateTaxonomy].
- taxonomy¶
The taxonomy to update. Only description, display_name, and activated policy types can be updated.
- update_mask¶
The update mask applies to the resource. For the
FieldMaskdefinition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
- class google.cloud.datacatalog_v1beta1.types.UsageSignal(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe set of all usage signals that we store in Data Catalog.
- update_time¶
The timestamp of the end of the usage statistics duration.
- usage_within_time_range¶
Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {“24H”, “7D”, “30D”}.
- Type
MutableMapping[str, google.cloud.datacatalog_v1beta1.types.UsageStats]
- class UsageWithinTimeRangeEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datacatalog_v1beta1.types.UsageStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetailed counts on the entry’s usage. Caveats:
Only BigQuery tables have usage stats
The usage stats only include BigQuery query jobs
The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables
- total_failures¶
The number of times that the underlying entry was attempted to be used but failed.
- Type
- total_cancellations¶
The number of times that the underlying entry was attempted to be used but was cancelled by the user.
- Type
- class google.cloud.datacatalog_v1beta1.types.ViewSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTable view specification.
