Module types (1.0.2)

API documentation for datacatalog_v1beta1.types module.

Classes

AuditConfig

API documentation for datacatalog_v1beta1.types.AuditConfig class.

AuditConfigDelta

API documentation for datacatalog_v1beta1.types.AuditConfigDelta class.

AuditLogConfig

API documentation for datacatalog_v1beta1.types.AuditLogConfig class.

BigQueryDateShardedSpec

Spec for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned- tables#partitioning_versus_sharding .. attribute:: dataset

Output only. The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{p roject_id}/locations/{location}/entrygroups/{entry_group_id}/e ntries/{entry_id}.

Output only. Total number of shards.

BigQueryTableSpec

Describes a BigQuery table. .. attribute:: table_source_type

Output only. The table source type.

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

Binding

API documentation for datacatalog_v1beta1.types.Binding class.

BindingDelta

API documentation for datacatalog_v1beta1.types.BindingDelta class.

ColumnSchema

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

Required. Name of the column.

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

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

CreateEntryGroupRequest

Request message for [CreateEntryGroup][google.cloud.datacatalog.v1beta 1.DataCatalog.CreateEntryGroup]. .. attribute:: 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.

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

CreateEntryRequest

Request message for [CreateEntry][google.cloud.datacatalog.v1beta1.Dat aCatalog.CreateEntry]. .. attribute:: parent

Required. The name of the entry group this entry is in. Example: - projects/{project_id}/locations/{location}/entryG roups/{entry_group_id} Note that this Entry and its child resources may not actually be stored in the location in this name.

Required. The entry to create.

CreatePolicyTagRequest

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

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

CreateTagRequest

Request message for CreateTag. .. attribute:: 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/{en try_id} Note that this Tag and its child resources may not actually be stored in the location in this name.

CreateTagTemplateFieldRequest

Request message for [CreateTagTemplateField][google.cloud.datacatalog. v1beta1.DataCatalog.CreateTagTemplateField]. .. attribute:: 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/tagTemplates/{tag_template_id}

Required. The tag template field to create.

CreateTagTemplateRequest

Request message for [CreateTagTemplate][google.cloud.datacatalog.v1bet a1.DataCatalog.CreateTagTemplate]. .. attribute:: 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

Required. The tag template to create.

CreateTaxonomyRequest

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

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

DeleteEntryGroupRequest

Request message for [DeleteEntryGroup][google.cloud.datacatalog.v1beta 1.DataCatalog.DeleteEntryGroup]. .. attribute:: name

Required. The name of the entry group. For example, projects /{project_id}/locations/{location}/entryGroups/{entry_group_id }.

DeleteEntryRequest

Request message for [DeleteEntry][google.cloud.datacatalog.v1beta1.Dat aCatalog.DeleteEntry]. .. attribute:: name

Required. The name of the entry. Example: - projects/{projec t_id}/locations/{location}/entryGroups/{entry_group_id}/entrie s/{entry_id}

DeletePolicyTagRequest

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

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

DeleteTagRequest

Request message for DeleteTag. .. attribute:: 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}

DeleteTagTemplateFieldRequest

Request message for [DeleteTagTemplateField][google.cloud.datacatalog. v1beta1.DataCatalog.DeleteTagTemplateField]. .. attribute:: name

Required. The name of the tag template field to delete. Example: - projects/{project_id}/locations/{location}/tagTem plates/{tag_template_id}/fields/{tag_template_field_id}

DeleteTagTemplateRequest

Request message for [DeleteTagTemplate][google.cloud.datacatalog.v1bet a1.DataCatalog.DeleteTagTemplate]. .. attribute:: name

Required. The name of the tag template to delete. Example: - projects/{project_id}/locations/{location}/tagTemplates/{tag_t emplate_id}

DeleteTaxonomyRequest

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

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

Empty

API documentation for datacatalog_v1beta1.types.Empty class.

Entry

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. .. attribute:: name

The Data Catalog resource name of the entry in URL format. Example: - projects/{project_id}/locations/{location}/entryG roups/{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.

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

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

Type specification information.

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

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.

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

EntryGroup

EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources. .. attribute:: name

The resource name of the entry group in URL format. Example:

projects/{project_id}/locations/{location}/entryGroups/{ent ry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.

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

ExportTaxonomiesRequest

Request message for [ExportTaxonomies][google.cloud.datacatalog.v1beta 1.PolicyTagManagerSerialization.ExportTaxonomies]. .. attribute:: parent

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

Required. Taxonomies export destination.

ExportTaxonomiesResponse

Response message for [ExportTaxonomies][google.cloud.datacatalog.v1bet a1.PolicyTagManagerSerialization.ExportTaxonomies]. .. attribute:: taxonomies

List of taxonomies and policy tags in a tree structure.

Expr

API documentation for datacatalog_v1beta1.types.Expr class.

FieldMask

API documentation for datacatalog_v1beta1.types.FieldMask class.

FieldType

Represents primitive types - string, bool etc.

GcsFileSpec

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

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

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

GcsFilesetSpec

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 </storage/docs/gsutil/addlhelp/WildcardNames>__ 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

GetEntryGroupRequest

Request message for [GetEntryGroup][google.cloud.datacatalog.v1beta1.D ataCatalog.GetEntryGroup]. .. attribute:: name

Required. The name of the entry group. For example, projects /{project_id}/locations/{location}/entryGroups/{entry_group_id }.

GetEntryRequest

Request message for GetEntry. .. attribute:: name

Required. The name of the entry. Example: - projects/{projec t_id}/locations/{location}/entryGroups/{entry_group_id}/entrie s/{entry_id}

GetIamPolicyRequest

API documentation for datacatalog_v1beta1.types.GetIamPolicyRequest class.

GetPolicyOptions

API documentation for datacatalog_v1beta1.types.GetPolicyOptions class.

GetPolicyTagRequest

Request message for [GetPolicyTag][google.cloud.datacatalog.v1beta1.Po licyTagManager.GetPolicyTag]. .. attribute:: name

Required. Resource name of the requested policy tag.

GetTagTemplateRequest

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

Required. The name of the tag template. Example: - projects/ {project_id}/locations/{location}/tagTemplates/{tag_template_i d}

GetTaxonomyRequest

Request message for [GetTaxonomy][google.cloud.datacatalog.v1beta1.Pol icyTagManager.GetTaxonomy]. .. attribute:: name

Required. Resource name of the requested taxonomy.

ImportTaxonomiesRequest

Request message for [ImportTaxonomies][google.cloud.datacatalog.v1beta 1.PolicyTagManagerSerialization.ImportTaxonomies]. .. attribute:: parent

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

Inline source used for taxonomies import

ImportTaxonomiesResponse

Response message for [ImportTaxonomies][google.cloud.datacatalog.v1bet a1.PolicyTagManagerSerialization.ImportTaxonomies]. .. attribute:: taxonomies

Taxonomies that were imported.

InlineSource

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

Required. Taxonomies to be imported.

ListEntriesRequest

Request message for [ListEntries][google.cloud.datacatalog.v1beta1.Dat aCatalog.ListEntries]. .. attribute:: parent

Required. The name of the entry group that contains the entries, which can be provided in URL format. Example: - pro jects/{project_id}/locations/{location}/entryGroups/{entry_gro up_id}

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

ListEntriesResponse

Response message for [ListEntries][google.cloud.datacatalog.v1beta1.Da taCatalog.ListEntries]. .. attribute:: entries

Entry details.

ListEntryGroupsRequest

Request message for [ListEntryGroups][google.cloud.datacatalog.v1beta1 .DataCatalog.ListEntryGroups]. .. attribute:: 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}

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

ListEntryGroupsResponse

Response message for [ListEntryGroups][google.cloud.datacatalog.v1beta 1.DataCatalog.ListEntryGroups]. .. attribute:: entry_groups

EntryGroup details.

ListPolicyTagsRequest

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

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

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

ListPolicyTagsResponse

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

The policy tags that are in the requested taxonomy.

ListTagsRequest

Request message for ListTags. .. attribute:: parent

Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: - projects/{project_id}/locations/{location}/entry Groups/{entry_group_id} - projects/{project_id}/locations/{lo cation}/entryGroups/{entry_group_id}/entries/{entry_id}

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

ListTagsResponse

Response message for ListTags. .. attribute:: tags

Tag details.

ListTaxonomiesRequest

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

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

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

ListTaxonomiesResponse

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

Taxonomies that the project contains.

LookupEntryRequest

Request message for [LookupEntry][google.cloud.datacatalog.v1beta1.Dat aCatalog.LookupEntry]. .. attribute:: target_name

Required. Represents either the Google Cloud Platform resource or SQL name for a Google Cloud Platform resource.

The SQL name of the entry. SQL names are case-sensitive. Examples: - pubsub.project_id.topic_id - :literal:pubsub.project_id.topic.id.with.dots` - bigquery.table.project_id.dataset_id.table_id - bigquery.dataset.project_id.dataset_id - datacatalog.en try.project_id.location_id.entry_group_id.entry_id *_id\ s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard- sql/lexical.

Policy

API documentation for datacatalog_v1beta1.types.Policy class.

PolicyDelta

API documentation for datacatalog_v1beta1.types.PolicyDelta class.

PolicyTag

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”. .. attribute:: name

Output only. Resource name of this policy tag, whose format is: “projects/{project_number}/locations/{location_id}/taxonom ies/{taxonomy_id}/policyTags/{id}”.

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.

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

RenameTagTemplateFieldRequest

Request message for [RenameTagTemplateField][google.cloud.datacatalog. v1beta1.DataCatalog.RenameTagTemplateField]. .. attribute:: name

Required. The name of the tag template. Example: - projects/ {project_id}/locations/{location}/tagTemplates/{tag_template_i d}/fields/{tag_template_field_id}

Schema

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.

SearchCatalogRequest

Request message for [SearchCatalog][google.cloud.datacatalog.v1beta1.D ataCatalog.SearchCatalog]. .. attribute:: 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.

Number of results in the search page. If <=0 then defaults to

Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.

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.

SearchCatalogResponse

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

Search results.

SearchCatalogResult

A result that appears in the response of a search request. Each result captures details of one entry that matches the search. .. attribute:: 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.

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}

SerializedPolicyTag

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

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

Children of the policy tag if any.

SerializedTaxonomy

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

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

Top level policy tags associated with the taxonomy if any.

SetIamPolicyRequest

API documentation for datacatalog_v1beta1.types.SetIamPolicyRequest class.

SystemTimestamps

Timestamps about this resource according to a particular system. .. attribute:: create_time

The creation time of the resource within the given system.

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

TableSpec

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}/entrygro ups/{entry_group_id}/entries/{entry_id}. Otherwise, grouped_entry is empty.

Tag

Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See Data Catalog IAM <https://cloud.google.com/data- catalog/docs/concepts/iam>__ for information on the permissions needed to create or view tags. .. attribute:: name

The resource name of the tag in URL format. Example: - proje cts/{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.

Output only. The display name of the tag template.

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

TagField

Contains the value and supporting information for a field within a Tag. .. attribute:: display_name

Output only. The display name of this field.

Holds the value for a tag field with double type.

Holds the value for a tag field with boolean type.

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.

TagTemplate

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 <https://cloud.google.com/iam/docs/understanding- roles#data-catalog-roles> provide permissions to create, edit, and use the template. See, for example, the TagTemplate User <https://cloud.google.com/data-catalog/docs/how-to/template-user> role, which includes permission to use the tag template to tag resources. .. attribute:: name

The resource name of the tag template in URL format. Example:

projects/{project_id}/locations/{location}/tagTemplates/{ta g_template_id} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

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.

TagTemplateField

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/{loca tion}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.

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

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.

Taxonomy

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. .. attribute:: name

Output only. Resource name of this taxonomy, whose format is: “projects/{project_number}/locations/{location_id}/taxonomies/ {id}”.

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.

TestIamPermissionsRequest

API documentation for datacatalog_v1beta1.types.TestIamPermissionsRequest class.

TestIamPermissionsResponse

API documentation for datacatalog_v1beta1.types.TestIamPermissionsResponse class.

Timestamp

API documentation for datacatalog_v1beta1.types.Timestamp class.

UpdateEntryGroupRequest

Request message for [UpdateEntryGroup][google.cloud.datacatalog.v1beta 1.DataCatalog.UpdateEntryGroup]. .. attribute:: entry_group

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

UpdateEntryRequest

Request message for [UpdateEntry][google.cloud.datacatalog.v1beta1.Dat aCatalog.UpdateEntry]. .. attribute:: entry

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

UpdatePolicyTagRequest

Request message for [UpdatePolicyTag][google.cloud.datacatalog.v1beta1 .PolicyTagManager.UpdatePolicyTag]. .. attribute:: policy_tag

The policy tag to update. Only the description, display_name, and parent_policy_tag fields can be updated.

UpdateTagRequest

Request message for UpdateTag. .. attribute:: tag

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

UpdateTagTemplateFieldRequest

Request message for [UpdateTagTemplateField][google.cloud.datacatalog. v1beta1.DataCatalog.UpdateTagTemplateField]. .. attribute:: name

Required. The name of the tag template field. Example: - pro jects/{project_id}/locations/{location}/tagTemplates/{tag_temp late_id}/fields/{tag_template_field_id}

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.