As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

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.Message

Spec 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

str

table_prefix

Output only. The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD, for example, for shard MyTable20180101, the table_prefix is MyTable.

Type

str

shard_count

Output only. Total number of shards.

Type

int

class google.cloud.datacatalog_v1beta1.types.BigQueryTableSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Describes a BigQuery table. .. attribute:: table_source_type

Output only. The table source type.

type

google.cloud.datacatalog_v1beta1.types.TableSourceType

view_spec

Table view specification. This field should only be populated if table_source_type is BIGQUERY_VIEW.

Type

google.cloud.datacatalog_v1beta1.types.ViewSpec

table_spec

Spec of a BigQuery table. This field should only be populated if table_source_type is BIGQUERY_TABLE.

Type

google.cloud.datacatalog_v1beta1.types.TableSpec

class google.cloud.datacatalog_v1beta1.types.ColumnSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Representation of a column within a schema. Columns could be nested inside other columns.

column

Required. Name of the column.

Type

str

type_

Required. Type of the column.

Type

str

description

Optional. Description of the column. Default value is an empty string.

Type

str

mode

Optional. A column’s mode indicates whether the values in this column are required, nullable, etc. Only NULLABLE, REQUIRED and REPEATED are supported. Default mode is NULLABLE.

Type

str

subcolumns

Optional. Schema of sub-columns. A column can have zero or more sub-columns.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.ColumnSchema]

class google.cloud.datacatalog_v1beta1.types.CreateEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

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

str

entry_group

The entry group to create. Defaults to an empty entry group.

Type

google.cloud.datacatalog_v1beta1.types.EntryGroup

class google.cloud.datacatalog_v1beta1.types.CreateEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

entry_id

Required. The id of the entry to create.

Type

str

entry

Required. The entry to create.

Type

google.cloud.datacatalog_v1beta1.types.Entry

class google.cloud.datacatalog_v1beta1.types.CreatePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CreatePolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.CreatePolicyTag].

parent

Required. Resource name of the taxonomy that the policy tag will belong to.

Type

str

policy_tag

The policy tag to be created.

Type

google.cloud.datacatalog_v1beta1.types.PolicyTag

class google.cloud.datacatalog_v1beta1.types.CreateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

tag

Required. The tag to create.

Type

google.cloud.datacatalog_v1beta1.types.Tag

class google.cloud.datacatalog_v1beta1.types.CreateTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

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

str

tag_template_field

Required. The tag template field to create.

Type

google.cloud.datacatalog_v1beta1.types.TagTemplateField

class google.cloud.datacatalog_v1beta1.types.CreateTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

tag_template_id

Required. The id of the tag template to create.

Type

str

tag_template

Required. The tag template to create.

Type

google.cloud.datacatalog_v1beta1.types.TagTemplate

class google.cloud.datacatalog_v1beta1.types.CreateTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [CreateTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.CreateTaxonomy].

parent

Required. Resource name of the project that the taxonomy will belong to.

Type

str

taxonomy

The taxonomy to be created.

Type

google.cloud.datacatalog_v1beta1.types.Taxonomy

class google.cloud.datacatalog_v1beta1.types.DeleteEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

force

Optional. If true, deletes all entries in the entry group.

Type

bool

class google.cloud.datacatalog_v1beta1.types.DeleteEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DeleteEntry][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntry].

name

Required. The name of the entry. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

Type

str

class google.cloud.datacatalog_v1beta1.types.DeletePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DeletePolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.DeletePolicyTag].

name

Required. Resource name of the policy tag to be deleted. All of its descendant policy tags will also be deleted.

Type

str

class google.cloud.datacatalog_v1beta1.types.DeleteTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DeleteTag][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTag].

name

Required. The name of the tag to delete. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

Type

str

class google.cloud.datacatalog_v1beta1.types.DeleteTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

force

Required. Currently, this field must always be set to true. This confirms the deletion of this field from any tags using this field. force = false will be supported in the future.

Type

bool

class google.cloud.datacatalog_v1beta1.types.DeleteTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

force

Required. Currently, this field must always be set to true. This confirms the deletion of any possible tags using this template. force = false will be supported in the future.

Type

bool

class google.cloud.datacatalog_v1beta1.types.DeleteTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [DeleteTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.DeleteTaxonomy].

name

Required. Resource name of the taxonomy to be deleted. All policy tags in this taxonomy will also be deleted.

Type

str

class google.cloud.datacatalog_v1beta1.types.Entry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Entry 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_resource field 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].

name

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

str

linked_resource

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for 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

str

type_

The type of the entry. Only used for Entries with types in the EntryType enum.

Type

google.cloud.datacatalog_v1beta1.types.EntryType

user_specified_type

Entry type if it does not fit any of the input-allowed values listed in EntryType enum 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_type strings 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.

Type

str

integrated_system

Output only. This field indicates the entry’s source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

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_system strings 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.

Type

str

gcs_fileset_spec

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.

Type

google.cloud.datacatalog_v1beta1.types.GcsFilesetSpec

bigquery_table_spec

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

Type

google.cloud.datacatalog_v1beta1.types.BigQueryTableSpec

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.

Type

google.cloud.datacatalog_v1beta1.types.BigQueryDateShardedSpec

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

str

description

Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.

Type

str

schema

Schema of the entry. An entry might not have any schema attached to it.

Type

google.cloud.datacatalog_v1beta1.types.Schema

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.

Type

google.cloud.datacatalog_v1beta1.types.SystemTimestamps

class google.cloud.datacatalog_v1beta1.types.EntryGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

EntryGroup 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

str

display_name

A short name to identify the entry group, for example, “analytics data - jan 2011”. Default value is an empty string.

Type

str

description

Entry group description, which can consist of several sentences or paragraphs that describe entry group contents. Default value is an empty string.

Type

str

data_catalog_timestamps

Output only. Timestamps about this EntryGroup. Default value is empty timestamps.

Type

google.cloud.datacatalog_v1beta1.types.SystemTimestamps

class google.cloud.datacatalog_v1beta1.types.EntryType(value)[source]

Bases: proto.enums.Enum

Entry 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.

DATA_STREAM = 3
ENTRY_TYPE_UNSPECIFIED = 0
FILESET = 4
MODEL = 5
TABLE = 2
class google.cloud.datacatalog_v1beta1.types.ExportTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [ExportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies].

parent

Required. Resource name of the project that taxonomies to be exported will share.

Type

str

taxonomies

Required. Resource names of the taxonomies to be exported.

Type

Sequence[str]

serialized_taxonomies

Export taxonomies as serialized taxonomies.

Type

bool

class google.cloud.datacatalog_v1beta1.types.ExportTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [ExportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies].

taxonomies

List of taxonomies and policy tags in a tree structure.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.SerializedTaxonomy]

class google.cloud.datacatalog_v1beta1.types.FieldType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

primitive_type

Represents primitive types - string, bool etc.

Type

google.cloud.datacatalog_v1beta1.types.FieldType.PrimitiveType

enum_type

Represents an enum type.

Type

google.cloud.datacatalog_v1beta1.types.FieldType.EnumType

class EnumType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

allowed_values

Required on create; optional on update. The set of allowed values for this enum. This set must not be empty, the display names of the values in this set must not be empty and the display names of the values must be case- insensitively unique within this set. Currently, enum values can only be added to the list of allowed values. Deletion and renaming of enum values are not supported. Can have up to 500 allowed values.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.FieldType.EnumType.EnumValue]

class EnumValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

display_name

Required. The display name of the enum value. Must not be an empty string.

Type

str

class PrimitiveType(value)[source]

Bases: proto.enums.Enum

BOOL = 3
DOUBLE = 1
PRIMITIVE_TYPE_UNSPECIFIED = 0
STRING = 2
TIMESTAMP = 4
class google.cloud.datacatalog_v1beta1.types.GcsFileSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifications of a single file in Cloud Storage. .. attribute:: file_path

Required. The full file path. Example: gs://bucket_name/a/b.txt.

type

str

gcs_timestamps

Output only. Timestamps about the Cloud Storage file.

Type

google.cloud.datacatalog_v1beta1.types.SystemTimestamps

size_bytes

Output only. The size of the file, in bytes.

Type

int

class google.cloud.datacatalog_v1beta1.types.GcsFilesetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Describes a Cloud Storage fileset entry. .. attribute:: 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 within bucket_name/dir directory.

  • gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.

  • gs://bucket_name/file*: matches files prefixed by file in bucket_name

  • gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name

  • gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name

  • gs://bucket_name/[a-m].txt: matches files that contain a, b, … or m followed by .txt in bucket_name

  • gs://bucket_name/a/*/b: matches all files in bucket_name that match a/*/b pattern, such as a/c/b, a/d/b

  • gs://another_bucket/a.txt: matches gs://another_bucket/a.txt

You can combine wildcards to provide more powerful matches, for example:

  • gs://bucket_name/[a-m]??.j*g

type

Sequence[str]

sample_gcs_file_specs

Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.GcsFileSpec]

class google.cloud.datacatalog_v1beta1.types.GetEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

read_mask

The fields to return. If not set or empty, all fields are returned.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.GetEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [GetEntry][google.cloud.datacatalog.v1beta1.DataCatalog.GetEntry].

name

Required. The name of the entry. Example:

  • projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}

Type

str

class google.cloud.datacatalog_v1beta1.types.GetPolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [GetPolicyTag][google.cloud.datacatalog.v1beta1.PolicyTagManager.GetPolicyTag].

name

Required. Resource name of the requested policy tag.

Type

str

class google.cloud.datacatalog_v1beta1.types.GetTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [GetTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.GetTagTemplate].

name

Required. The name of the tag template. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

Type

str

class google.cloud.datacatalog_v1beta1.types.GetTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [GetTaxonomy][google.cloud.datacatalog.v1beta1.PolicyTagManager.GetTaxonomy].

name

Required. Resource name of the requested taxonomy.

Type

str

class google.cloud.datacatalog_v1beta1.types.ImportTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [ImportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies].

parent

Required. Resource name of project that the newly created taxonomies will belong to.

Type

str

inline_source

Inline source used for taxonomies import

Type

google.cloud.datacatalog_v1beta1.types.InlineSource

class google.cloud.datacatalog_v1beta1.types.ImportTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [ImportTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies].

taxonomies

Taxonomies that were imported.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.Taxonomy]

class google.cloud.datacatalog_v1beta1.types.InlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Inline source used for taxonomies import. .. attribute:: taxonomies

Required. Taxonomies to be imported.

type

Sequence[google.cloud.datacatalog_v1beta1.types.SerializedTaxonomy]

class google.cloud.datacatalog_v1beta1.types.ListEntriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

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

int

page_token

Token that specifies which page is requested. If empty, the first page is returned.

Type

str

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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.ListEntriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [ListEntries][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntries].

entries

Entry details.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.Entry]

next_page_token

Token to retrieve the next page of results. It is set to empty if no items remain in results.

Type

str

property raw_page
class google.cloud.datacatalog_v1beta1.types.ListEntryGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

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

int

page_token

Optional. Token that specifies which page is requested. If empty, the first page is returned.

Type

str

class google.cloud.datacatalog_v1beta1.types.ListEntryGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [ListEntryGroups][google.cloud.datacatalog.v1beta1.DataCatalog.ListEntryGroups].

entry_groups

EntryGroup details.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.EntryGroup]

next_page_token

Token to retrieve the next page of results. It is set to empty if no items remain in results.

Type

str

property raw_page
class google.cloud.datacatalog_v1beta1.types.ListPolicyTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [ListPolicyTags][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags].

parent

Required. Resource name of the taxonomy to list the policy tags of.

Type

str

page_size

The maximum number of items to return. Must be a value between 1 and 1000. If not set, defaults to 50.

Type

int

page_token

The next_page_token value returned from a previous List request, if any. If not set, defaults to an empty string.

Type

str

class google.cloud.datacatalog_v1beta1.types.ListPolicyTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [ListPolicyTags][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags].

policy_tags

The policy tags that are in the requested taxonomy.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.PolicyTag]

next_page_token

Token used to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.datacatalog_v1beta1.types.ListTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

page_size

The maximum number of tags to return. Default is 10. Max limit is 1000.

Type

int

page_token

Token that specifies which page is requested. If empty, the first page is returned.

Type

str

class google.cloud.datacatalog_v1beta1.types.ListTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [ListTags][google.cloud.datacatalog.v1beta1.DataCatalog.ListTags].

tags

[Tag][google.cloud.datacatalog.v1beta1.Tag] details.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.Tag]

next_page_token

Token to retrieve the next page of results. It is set to empty if no items remain in results.

Type

str

property raw_page
class google.cloud.datacatalog_v1beta1.types.ListTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [ListTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListTaxonomies].

parent

Required. Resource name of the project to list the taxonomies of.

Type

str

page_size

The maximum number of items to return. Must be a value between 1 and 1000. If not set, defaults to 50.

Type

int

page_token

The next_page_token value returned from a previous list request, if any. If not set, defaults to an empty string.

Type

str

class google.cloud.datacatalog_v1beta1.types.ListTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [ListTaxonomies][google.cloud.datacatalog.v1beta1.PolicyTagManager.ListTaxonomies].

taxonomies

Taxonomies that the project contains.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.Taxonomy]

next_page_token

Token used to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.datacatalog_v1beta1.types.LookupEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [LookupEntry][google.cloud.datacatalog.v1beta1.DataCatalog.LookupEntry].

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

Type

str

sql_resource

The SQL name of the entry. SQL names are case-sensitive.

Examples:

  • pubsub.project_id.topic_id

  • pubsub.project_id.`topic.id.with.dots`

  • bigquery.table.project_id.dataset_id.table_id

  • bigquery.dataset.project_id.dataset_id

  • datacatalog.entry.project_id.location_id.entry_group_id.entry_id

*_ids shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.

Type

str

class google.cloud.datacatalog_v1beta1.types.PolicyTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Denotes 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

str

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

str

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

str

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

str

child_policy_tags

Output only. Resource names of child policy tags of this policy tag.

Type

Sequence[str]

class google.cloud.datacatalog_v1beta1.types.RenameTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

new_tag_template_field_id

Required. The new ID of this tag template field. For example, my_new_field.

Type

str

class google.cloud.datacatalog_v1beta1.types.Schema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema). .. attribute:: columns

Required. Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.

type

Sequence[google.cloud.datacatalog_v1beta1.types.ColumnSchema]

class google.cloud.datacatalog_v1beta1.types.SearchCatalogRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].

scope

Required. The scope of this search request. A scope that has empty include_org_ids, include_project_ids AND false include_gcp_public_datasets is considered invalid. Data Catalog will return an error in such a case.

Type

google.cloud.datacatalog_v1beta1.types.SearchCatalogRequest.Scope

query

Required. The query string in search query syntax. The query must be non-empty.

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

str

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

int

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

str

order_by

Specifies the ordering of results, currently supported case-sensitive choices are:

  • relevance, only supports descending

  • last_modified_timestamp [asc|desc], defaults to descending if not specified

If not specified, defaults to relevance descending.

Type

str

class Scope(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The 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

Sequence[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

Sequence[str]

include_gcp_public_datasets

If true, include Google Cloud Platform (GCP) public datasets in the search results. Info on GCP public datasets is available at https://cloud.google.com/public-datasets/. By default, GCP public datasets are excluded.

Type

bool

class google.cloud.datacatalog_v1beta1.types.SearchCatalogResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response message for [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].

results

Search results.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.SearchCatalogResult]

next_page_token

The token that can be used to retrieve the next page of results.

Type

str

property raw_page
class google.cloud.datacatalog_v1beta1.types.SearchCatalogResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A 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.

Type

google.cloud.datacatalog_v1beta1.types.SearchResultType

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

str

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

str

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

str

class google.cloud.datacatalog_v1beta1.types.SearchResultType(value)[source]

Bases: proto.enums.Enum

The different types of resources that can be returned in search.

ENTRY = 1
ENTRY_GROUP = 3
SEARCH_RESULT_TYPE_UNSPECIFIED = 0
TAG_TEMPLATE = 2
class google.cloud.datacatalog_v1beta1.types.SerializedPolicyTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Message representing one policy tag when exported as a nested proto.

display_name

Required. Display name of the policy tag. Max 200 bytes when encoded in UTF-8.

Type

str

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

str

child_policy_tags

Children of the policy tag if any.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.SerializedPolicyTag]

class google.cloud.datacatalog_v1beta1.types.SerializedTaxonomy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.

display_name

Required. Display name of the taxonomy. Max 200 bytes when encoded in UTF-8.

Type

str

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

str

policy_tags

Top level policy tags associated with the taxonomy if any.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.SerializedPolicyTag]

class google.cloud.datacatalog_v1beta1.types.SystemTimestamps(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Timestamps about this resource according to a particular system.

create_time

The creation time of the resource within the given system.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

The last-modified time of the resource within the given system.

Type

google.protobuf.timestamp_pb2.Timestamp

expire_time

Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.datacatalog_v1beta1.types.TableSourceType(value)[source]

Bases: proto.enums.Enum

Table source type.

BIGQUERY_TABLE = 5
BIGQUERY_VIEW = 2
TABLE_SOURCE_TYPE_UNSPECIFIED = 0
class google.cloud.datacatalog_v1beta1.types.TableSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Normal BigQuery table spec. .. attribute:: grouped_entry

Output only. If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, grouped_entry is 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_entry is empty.

type

str

class google.cloud.datacatalog_v1beta1.types.Tag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Tags 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_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

Type

str

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

str

template_display_name

Output only. The display name of the tag template.

Type

str

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

Type

str

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

Sequence[google.cloud.datacatalog_v1beta1.types.Tag.FieldsEntry]

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.Message

Contains the value and supporting information for a field within a [Tag][google.cloud.datacatalog.v1beta1.Tag].

display_name

Output only. The display name of this field.

Type

str

double_value

Holds the value for a tag field with double type.

Type

float

string_value

Holds the value for a tag field with string type.

Type

str

bool_value

Holds the value for a tag field with boolean type.

Type

bool

timestamp_value

Holds the value for a tag field with timestamp type.

Type

google.protobuf.timestamp_pb2.Timestamp

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.

Type

google.cloud.datacatalog_v1beta1.types.TagField.EnumValue

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

int

class EnumValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Holds an enum value. .. attribute:: display_name

The display name of the enum value.

type

str

class google.cloud.datacatalog_v1beta1.types.TagTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP 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

str

display_name

The display name for this template. Defaults to an empty string.

Type

str

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

Sequence[google.cloud.datacatalog_v1beta1.types.TagTemplate.FieldsEntry]

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.Message

The template for an individual field within a tag template. .. attribute:: 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

str

display_name

The display name for this field. Defaults to an empty string.

Type

str

type_

Required. The type of value this tag field can contain.

Type

google.cloud.datacatalog_v1beta1.types.FieldType

is_required

Whether this is a required field. Defaults to false.

Type

bool

order

The order of this field with respect to other fields in this tag template. A higher value indicates 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

int

class google.cloud.datacatalog_v1beta1.types.Taxonomy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A 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

str

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.

Type

str

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

str

activated_policy_types

Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

Type

Sequence[google.cloud.datacatalog_v1beta1.types.Taxonomy.PolicyType]

class PolicyType(value)[source]

Bases: proto.enums.Enum

Defines policy types where policy tag can be used for.

FINE_GRAINED_ACCESS_CONTROL = 1
POLICY_TYPE_UNSPECIFIED = 0
class google.cloud.datacatalog_v1beta1.types.UpdateEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [UpdateEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntryGroup].

entry_group

Required. The updated entry group. “name” field must be set.

Type

google.cloud.datacatalog_v1beta1.types.EntryGroup

update_mask

The fields to update on the entry group. If absent or empty, all modifiable fields are updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.UpdateEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [UpdateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntry].

entry

Required. The updated entry. The “name” field must be set.

Type

google.cloud.datacatalog_v1beta1.types.Entry

update_mask

The fields to update on the entry. If absent or empty, all modifiable fields are updated.

The following fields are modifiable:

  • For entries with type DATA_STREAM:

    • schema

  • For entries with type FILESET

    • schema

    • display_name

    • description

    • gcs_fileset_spec

    • gcs_fileset_spec.file_patterns

  • For entries with user_specified_type

    • schema

    • display_name

    • description

    • user_specified_type

    • user_specified_system

    • linked_resource

    • source_system_timestamps

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.UpdatePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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.

Type

google.cloud.datacatalog_v1beta1.types.PolicyTag

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 FieldMask definition, 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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.UpdateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [UpdateTag][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTag].

tag

Required. The updated tag. The “name” field must be set.

Type

google.cloud.datacatalog_v1beta1.types.Tag

update_mask

The fields to update on the Tag. If absent or empty, all modifiable fields are updated. Currently the only modifiable field is the field fields.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.UpdateTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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

str

tag_template_field

Required. The template to update.

Type

google.cloud.datacatalog_v1beta1.types.TagTemplateField

update_mask

Optional. The field mask specifies the parts of the template to be updated. Allowed fields:

  • display_name

  • type.enum_type

  • is_required

If update_mask is not set or empty, all of the allowed fields above will be updated.

When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.UpdateTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request message for [UpdateTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplate].

tag_template

Required. The template to update. The “name” field must be set.

Type

google.cloud.datacatalog_v1beta1.types.TagTemplate

update_mask

The field mask specifies the parts of the template to overwrite.

Allowed fields:

  • display_name

If absent or empty, all of the allowed fields above will be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.UpdateTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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.

Type

google.cloud.datacatalog_v1beta1.types.Taxonomy

update_mask

The update mask applies to the resource. For the FieldMask definition, 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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.datacatalog_v1beta1.types.ViewSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Table view specification. .. attribute:: view_query

Output only. The query that defines the table view.

type

str