Package types (3.2.1)

API documentation for datacatalog_v1beta1.types package.

Classes

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

BigQueryTableSpec

Describes a BigQuery table. .. attribute:: table_source_type

Output only. The table source type.

:type: google.cloud.datacatalog_v1beta1.types.TableSourceType

ColumnSchema

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

CreateTagTemplateFieldRequest

Request message for CreateTagTemplateField.

DeleteTagTemplateFieldRequest

Request message for DeleteTagTemplateField.

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.

EntryGroup

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

EntryType

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.

ExportTaxonomiesRequest

Request message for ExportTaxonomies.

ExportTaxonomiesResponse

Response message for ExportTaxonomies.

FieldType

GcsFileSpec

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

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 <https://cloud.google.com/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

:type: Sequence[str]

GetEntryGroupRequest

Request message for GetEntryGroup.

GetEntryRequest

Request message for GetEntry.

GetPolicyTagRequest

Request message for GetPolicyTag.

GetTagTemplateRequest

Request message for GetTagTemplate.

GetTaxonomyRequest

Request message for GetTaxonomy.

ImportTaxonomiesRequest

Request message for ImportTaxonomies.

ImportTaxonomiesResponse

Response message for ImportTaxonomies.

InlineSource

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

Required. Taxonomies to be imported.

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

ListEntriesRequest

Request message for ListEntries.

ListEntriesResponse

Response message for ListEntries.

ListEntryGroupsRequest

Request message for ListEntryGroups.

ListEntryGroupsResponse

Response message for ListEntryGroups.

ListPolicyTagsRequest

Request message for ListPolicyTags.

ListPolicyTagsResponse

Response message for ListPolicyTags.

ListTagsRequest

Request message for ListTags.

ListTagsResponse

Response message for ListTags.

ListTaxonomiesRequest

Request message for ListTaxonomies.

ListTaxonomiesResponse

Response message for ListTaxonomies.

LookupEntryRequest

Request message for LookupEntry.

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

RenameTagTemplateFieldRequest

Request message for RenameTagTemplateField.

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.

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

SearchCatalogRequest

Request message for SearchCatalog.

SearchCatalogResponse

Response message for SearchCatalog.

SearchCatalogResult

A result that appears in the response of a search request. Each result captures details of one entry that matches the search.

SearchResultType

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

SerializedPolicyTag

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

SerializedTaxonomy

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

SystemTimestamps

Timestamps about this resource according to a particular system.

TableSourceType

Table source type.

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

:type: str

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.

TagField

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

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.

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/{location}/tagTemplates/{tag_template}/fields/{field}

Note that this TagTemplateField may not actually be stored in the location in this name.

:type: str

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.

:type: str