Package types (3.23.0)

API documentation for datacatalog_v1.types package.

Classes

BigQueryConnectionSpec

Specification for the BigQuery connection.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BigQueryDateShardedSpec

Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BusinessContext

Business Context of the entry.

CatalogUIExperience

Configuration related to the opt-in status for the UI switch to Dataplex.

CloudBigtableInstanceSpec

Specification that applies to Instance entries that are part of CLOUD_BIGTABLE system. (user_specified_type)

CloudBigtableSystemSpec

Specification that applies to all entries that are part of CLOUD_BIGTABLE system (user_specified_type)

CloudSqlBigQueryConnectionSpec

Specification for the BigQuery connection to a Cloud SQL instance.

ColumnSchema

A column within a schema. Columns can be nested inside other columns.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CommonUsageStats

Common statistics on the entry's usage.

They can be set on any system.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Contacts

Contact people for the entry.

CreateEntryGroupRequest

Request message for CreateEntryGroup.

CreateEntryRequest

Request message for CreateEntry.

CreatePolicyTagRequest

Request message for CreatePolicyTag.

CreateTagRequest

Request message for CreateTag.

CreateTagTemplateFieldRequest

Request message for CreateTagTemplateField.

CreateTagTemplateRequest

Request message for CreateTagTemplate.

CreateTaxonomyRequest

Request message for CreateTaxonomy.

CrossRegionalSource

Cross-regional source used to import an existing taxonomy into a different region.

DataSource

Physical location of an entry.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DataSourceConnectionSpec

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type. Only one of internal specs can be set at the time, and cannot be changed later.

DatabaseTableSpec

Specification that applies to a table resource. Valid only for entries with the TABLE type.

DataplexExternalTable

External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.

DataplexFilesetSpec

Entry specyfication for a Dataplex fileset.

DataplexSpec

Common Dataplex fields.

DataplexTableSpec

Entry specification for a Dataplex table.

DatasetSpec

Specification that applies to a dataset. Valid only for entries with the DATASET type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteEntryGroupRequest

Request message for DeleteEntryGroup.

DeleteEntryRequest

Request message for DeleteEntry.

DeletePolicyTagRequest

Request message for DeletePolicyTag.

DeleteTagRequest

Request message for DeleteTag.

DeleteTagTemplateFieldRequest

Request message for DeleteTagTemplateField.

DeleteTagTemplateRequest

Request message for DeleteTagTemplate.

DeleteTaxonomyRequest

Request message for DeleteTaxonomy.

DumpItem

Wrapper for any item that can be contained in the dump.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Entry

Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You 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, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EntryGroup

Entry group metadata.

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

EntryOverview

Entry overview fields for rich text descriptions of entries.

EntryType

Metadata automatically ingested from Google Cloud resources like BigQuery tables or Pub/Sub topics always uses enum values from EntryType as the type of entry.

Other sources of metadata like Hive or Oracle databases can identify the type by either using one of the enum values from EntryType (for example, FILESET for a Cloud Storage fileset) or specifying a custom value using the `Entry <#resource:-entry>__ fielduser_specified_type. For more information, seeSurface files from Cloud Storage with fileset entries </data-catalog/docs/how-to/filesets>__ orCreate custom entries for your data sources </data-catalog/docs/how-to/custom-entries>`__.

    For more information, see `Supported models in BigQuery
    ML </bigquery/docs/bqml-introduction#supported_models>`__.
DATA_STREAM (3):
    An entry type for streaming entries. For
    example, a Pub/Sub topic.
FILESET (4):
    An entry type for a set of files or objects.
    For example, a Cloud Storage fileset.
CLUSTER (6):
    A group of servers that work together. For
    example, a Kafka cluster.
DATABASE (7):
    A database.
DATA_SOURCE_CONNECTION (8):
    Connection to a data source. For example, a
    BigQuery connection.
ROUTINE (9):
    Routine, for example, a BigQuery routine.
LAKE (10):
    A Dataplex lake.
ZONE (11):
    A Dataplex zone.
SERVICE (14):
    A service, for example, a Dataproc Metastore
    service.
DATABASE_SCHEMA (15):
    Schema within a relational database.
DASHBOARD (16):
    A Dashboard, for example from Looker.
EXPLORE (17):
    A Looker Explore.

    For more information, see [Looker Explore API]
    (https://developers.looker.com/api/explorer/4.0/methods/LookmlModel/lookml_model_explore).
LOOK (18):
    A Looker Look.

    For more information, see [Looker Look API]
    (https://developers.looker.com/api/explorer/4.0/methods/Look).
FEATURE_ONLINE_STORE (19):
    Feature Online Store resource in Vertex AI
    Feature Store.
FEATURE_VIEW (20):
    Feature View resource in Vertex AI Feature
    Store.
FEATURE_GROUP (21):
    Feature Group resource in Vertex AI Feature
    Store.

ExportTaxonomiesRequest

Request message for ExportTaxonomies.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportTaxonomiesResponse

Response message for ExportTaxonomies.

FeatureOnlineStoreSpec

Detail description of the source information of a Vertex Feature Online Store.

FieldType

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FilesetSpec

Specification that applies to a fileset. Valid only for entries with the 'FILESET' type.

GcsFileSpec

Specification of a single file in Cloud Storage.

GcsFilesetSpec

Describes a Cloud Storage fileset entry.

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.

ImportEntriesMetadata

Metadata message for [long-running operation][google.longrunning.Operation] returned by the ImportEntries.

ImportEntriesRequest

Request message for ImportEntries method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportEntriesResponse

Response message for [long-running operation][google.longrunning.Operation] returned by the ImportEntries.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportTaxonomiesRequest

Request message for ImportTaxonomies.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportTaxonomiesResponse

Response message for ImportTaxonomies.

InlineSource

Inline source containing taxonomies to import.

IntegratedSystem

This enum lists all the systems that Data Catalog integrates with.

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.

LookerSystemSpec

Specification that applies to entries that are part LOOKER system (user_specified_type)

LookupEntryRequest

Request message for LookupEntry.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ManagingSystem

This enum describes all the systems that manage Taxonomy and PolicyTag resources in DataCatalog.

MigrationConfig

The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.

ModelSpec

Specification that applies to a model. Valid only for entries with the MODEL type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ModifyEntryContactsRequest

Request message for ModifyEntryContacts.

ModifyEntryOverviewRequest

Request message for ModifyEntryOverview.

OrganizationConfig

The configuration related to the migration from Data Catalog to Dataplex that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig.

PersonalDetails

Entry metadata relevant only to the user and private to them.

PhysicalSchema

Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PolicyTag

Denotes one policy tag in a taxonomy, for example, SSN.

Policy tags can be defined in a hierarchy. For example:

Geolocation
- LatLong
- City
- ZipCode

Where the "Geolocation" policy tag contains three children.

ReconcileTagsMetadata

Long-running operation][google.longrunning.Operation] metadata message returned by the ReconcileTags.

ReconcileTagsRequest

Request message for ReconcileTags.

ReconcileTagsResponse

Long-running operation][google.longrunning.Operation] response message returned by ReconcileTags.

RenameTagTemplateFieldEnumValueRequest

Request message for RenameTagTemplateFieldEnumValue.

RenameTagTemplateFieldRequest

Request message for RenameTagTemplateField.

ReplaceTaxonomyRequest

Request message for ReplaceTaxonomy.

RetrieveConfigRequest

Request message for RetrieveConfig.

RetrieveEffectiveConfigRequest

Request message for RetrieveEffectiveConfig.

RoutineSpec

Specification that applies to a routine. Valid only for entries with the ROUTINE type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Schema

Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.

SearchCatalogRequest

Request message for SearchCatalog.

SearchCatalogResponse

Response message for SearchCatalog.

SearchCatalogResult

Result in the response to a search request.

Each result captures details of one entry that matches the search.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SearchResultType

The resource types that can be returned in search results.

SerializedPolicyTag

A nested protocol buffer that represents a policy tag and all its descendants.

SerializedTaxonomy

A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.

ServiceSpec

Specification that applies to a Service resource. Valid only for entries with the SERVICE type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SetConfigRequest

Request message for SetConfig.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SqlDatabaseSystemSpec

Specification that applies to entries that are part SQL_DATABASE system (user_specified_type)

StarEntryRequest

Request message for StarEntry.

StarEntryResponse

Response message for StarEntry. Empty for now

StorageProperties

Details the properties of the underlying storage.

SystemTimestamps

Timestamps associated with this resource in a particular system.

TableSourceType

Table source type.

TableSpec

Normal BigQuery table specification.

Tag

Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TagField

Contains the value and additional information on a field within a Tag.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TagTemplate

A tag template defines a tag that can have one or more typed fields.

The template is used to create tags that are attached to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. For example, see the TagTemplate User role that includes a permission to use the tag template to tag resources.

PII
- Account number
- Age
- SSN
- Zipcode
Financials
- Revenue

A "data origin" taxonomy might contain the following policy tags:

User data
Employee data
Partner data
Public data

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UsageStats

Detailed statistics on the entry's usage.

Usage statistics have the following limitations:

Only BigQuery tables have them.
They only include BigQuery query jobs.
They might be underestimated because wildcard table references are not yet counted. For more information, see Querying multiple tables using a wildcard table