Package Classes (3.23.0)

Data Catalog API service allows you to discover, understand, and manage your data.

Data Catalog API service allows you to discover, understand, and manage your data.

A pager for iterating through list_entries requests.

This class thinly wraps an initial ListEntriesResponse object, and provides an __aiter__ method to iterate through its entries field.

If there are more pages, the __aiter__ method will make additional ListEntries requests and continue to iterate through the entries field on the corresponding responses.

All the usual ListEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_entries requests.

This class thinly wraps an initial ListEntriesResponse object, and provides an __iter__ method to iterate through its entries field.

If there are more pages, the __iter__ method will make additional ListEntries requests and continue to iterate through the entries field on the corresponding responses.

All the usual ListEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_entry_groups requests.

This class thinly wraps an initial ListEntryGroupsResponse object, and provides an __aiter__ method to iterate through its entry_groups field.

If there are more pages, the __aiter__ method will make additional ListEntryGroups requests and continue to iterate through the entry_groups field on the corresponding responses.

All the usual ListEntryGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_entry_groups requests.

This class thinly wraps an initial ListEntryGroupsResponse object, and provides an __iter__ method to iterate through its entry_groups field.

If there are more pages, the __iter__ method will make additional ListEntryGroups requests and continue to iterate through the entry_groups field on the corresponding responses.

All the usual ListEntryGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tags requests.

This class thinly wraps an initial ListTagsResponse object, and provides an __aiter__ method to iterate through its tags field.

If there are more pages, the __aiter__ method will make additional ListTags requests and continue to iterate through the tags field on the corresponding responses.

All the usual ListTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tags requests.

This class thinly wraps an initial ListTagsResponse object, and provides an __iter__ method to iterate through its tags field.

If there are more pages, the __iter__ method will make additional ListTags requests and continue to iterate through the tags field on the corresponding responses.

All the usual ListTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_catalog requests.

This class thinly wraps an initial SearchCatalogResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional SearchCatalog requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchCatalogResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_catalog requests.

This class thinly wraps an initial SearchCatalogResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional SearchCatalog requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchCatalogResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Policy Tag Manager API service allows you to manage your policy tags and taxonomies.

Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.

Policy Tag Manager API service allows you to manage your policy tags and taxonomies.

Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.

A pager for iterating through list_policy_tags requests.

This class thinly wraps an initial ListPolicyTagsResponse object, and provides an __aiter__ method to iterate through its policy_tags field.

If there are more pages, the __aiter__ method will make additional ListPolicyTags requests and continue to iterate through the policy_tags field on the corresponding responses.

All the usual ListPolicyTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_policy_tags requests.

This class thinly wraps an initial ListPolicyTagsResponse object, and provides an __iter__ method to iterate through its policy_tags field.

If there are more pages, the __iter__ method will make additional ListPolicyTags requests and continue to iterate through the policy_tags field on the corresponding responses.

All the usual ListPolicyTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_taxonomies requests.

This class thinly wraps an initial ListTaxonomiesResponse object, and provides an __aiter__ method to iterate through its taxonomies field.

If there are more pages, the __aiter__ method will make additional ListTaxonomies requests and continue to iterate through the taxonomies field on the corresponding responses.

All the usual ListTaxonomiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_taxonomies requests.

This class thinly wraps an initial ListTaxonomiesResponse object, and provides an __iter__ method to iterate through its taxonomies field.

If there are more pages, the __iter__ method will make additional ListTaxonomies requests and continue to iterate through the taxonomies field on the corresponding responses.

All the usual ListTaxonomiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

Specification for the BigQuery connection.

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

The type of the BigQuery connection.

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

For more information, see Introduction to partitioned tables.

Fields specific for BigQuery routines.

Describes a BigQuery table.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

Business Context of the entry.

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

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

Spec that applies to clusters of an Instance of Cloud Bigtable.

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

Specification for the BigQuery connection to a Cloud SQL instance.

Supported Cloud SQL database types.

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

Represents the type of a field element.

Specifies inclusion of the column in an index

Column info specific to Looker System.

Column type in Looker.

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

Contact people for the entry.

A contact person for the entry.

Request message for CreateEntryGroup.

Request message for CreateEntry.

Request message for CreatePolicyTag.

Request message for CreateTag.

Request message for CreateTagTemplateField.

Request message for CreateTagTemplate.

Request message for CreateTaxonomy.

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

Physical location of an entry.

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

Name of a service that stores the data.

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.

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

Specification that applies to database view.

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

Concrete type of the view.

Type of the table.

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.

Entry specyfication for a Dataplex fileset.

Common Dataplex fields.

Entry specification for a Dataplex table.

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

Request message for DeleteEntryGroup.

Request message for DeleteEntry.

Request message for DeletePolicyTag.

Request message for DeleteTag.

Request message for DeleteTagTemplateField.

Request message for DeleteTagTemplate.

Request message for DeleteTaxonomy.

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

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

The abstract base class for a message.

Entry group metadata.

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

Entry overview fields for rich text descriptions of entries.

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.

Request message for ExportTaxonomies.

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

Response message for ExportTaxonomies.

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

Type of underlaying storage type.

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

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

Specification of a single file in Cloud Storage.

Describes a Cloud Storage fileset entry.

Request message for GetEntryGroup.

Request message for GetEntry.

Request message for GetPolicyTag.

Request message for GetTagTemplate.

Request message for GetTaxonomy.

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

Enum holding possible states of the import operation.

Request message for ImportEntries method.

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

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

Request message for ImportTaxonomies.

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

Response message for ImportTaxonomies.

Inline source containing taxonomies to import.

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

Request message for ListEntries.

Response message for ListEntries.

Request message for ListEntryGroups.

Response message for ListEntryGroups.

Request message for ListPolicyTags.

Response message for ListPolicyTags.

Request message for ListTags.

Response message for ListTags.

Request message for ListTaxonomies.

Response message for ListTaxonomies.

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

Request message for LookupEntry.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

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

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

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

Request message for ModifyEntryContacts.

Request message for ModifyEntryOverview.

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.

The abstract base class for a message.

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

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

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

Schema in Avro JSON format.

Marks a CSV-encoded data source.

Marks an ORC-encoded data source.

Marks a Parquet-encoded data source.

Schema in protocol buffer format.

Schema in Thrift format.

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.

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

The abstract base class for a message.

Enum holding possible states of the reconciliation operation.

Request message for ReconcileTags.

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

Request message for RenameTagTemplateFieldEnumValue.

Request message for RenameTagTemplateField.

Request message for ReplaceTaxonomy.

Request message for RetrieveConfig.

Request message for RetrieveEffectiveConfig.

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

Input or output argument of a function or stored procedure.

The input or output mode of the argument.

The fine-grained type of the routine.

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

Request message for SearchCatalog.

The criteria that select the subspace used for query matching.

Response message for SearchCatalog.

Result in the response to a search request.

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

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

The resource types that can be returned in search results.

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

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

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

Request message for SetConfig.

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

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

Request message for StarEntry.

Response message for StarEntry. Empty for now

Details the properties of the underlying storage.

Timestamps associated with this resource in a particular system.

Table source type.

Normal BigQuery table specification.

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

The abstract base class for a message.

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

An enum value.

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.

This enum describes TagTemplate transfer status to Dataplex service.

The abstract base class for a message.

The template for an individual field within a tag template.

Configuration related to the opt-in status for the migration of TagTemplates to Dataplex.

Wrapper containing Entry and information about Tags that should and should not be attached to it.

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

A taxonomy is a collection of hierarchical policy tags that classify data along a common axis.

For example, a "data sensitivity" taxonomy might contain the following policy tags:

::

• 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

Defines policy types where the policy tags can be used for.

The source system of the Taxonomy.

Request message for UnstarEntry.

Response message for UnstarEntry. Empty for now

Request message for UpdateEntryGroup.

Request message for UpdateEntry.

Request message for UpdatePolicyTag.

Request message for UpdateTag.

Request message for UpdateTagTemplateField.

Request message for UpdateTagTemplate.

Request message for UpdateTaxonomy.

The set of all usage signals that Data Catalog stores.

Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.

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

The abstract base class for a message.

The abstract base class for a message.

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

Specification for vertex dataset resources.

Type of data stored in the dataset.

Detail description of the source information of a Vertex model.

Source of the model.

Specification for vertex model resources.

Table view specification.

Data Catalog API service allows clients to discover, understand, and manage their data.

Data Catalog API service allows clients to discover, understand, and manage their data.

A pager for iterating through list_entries requests.

This class thinly wraps an initial ListEntriesResponse object, and provides an __aiter__ method to iterate through its entries field.

If there are more pages, the __aiter__ method will make additional ListEntries requests and continue to iterate through the entries field on the corresponding responses.

All the usual ListEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_entries requests.

This class thinly wraps an initial ListEntriesResponse object, and provides an __iter__ method to iterate through its entries field.

If there are more pages, the __iter__ method will make additional ListEntries requests and continue to iterate through the entries field on the corresponding responses.

All the usual ListEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_entry_groups requests.

This class thinly wraps an initial ListEntryGroupsResponse object, and provides an __aiter__ method to iterate through its entry_groups field.

If there are more pages, the __aiter__ method will make additional ListEntryGroups requests and continue to iterate through the entry_groups field on the corresponding responses.

All the usual ListEntryGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_entry_groups requests.

This class thinly wraps an initial ListEntryGroupsResponse object, and provides an __iter__ method to iterate through its entry_groups field.

If there are more pages, the __iter__ method will make additional ListEntryGroups requests and continue to iterate through the entry_groups field on the corresponding responses.

All the usual ListEntryGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tags requests.

This class thinly wraps an initial ListTagsResponse object, and provides an __aiter__ method to iterate through its tags field.

If there are more pages, the __aiter__ method will make additional ListTags requests and continue to iterate through the tags field on the corresponding responses.

All the usual ListTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tags requests.

This class thinly wraps an initial ListTagsResponse object, and provides an __iter__ method to iterate through its tags field.

If there are more pages, the __iter__ method will make additional ListTags requests and continue to iterate through the tags field on the corresponding responses.

All the usual ListTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_catalog requests.

This class thinly wraps an initial SearchCatalogResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional SearchCatalog requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchCatalogResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_catalog requests.

This class thinly wraps an initial SearchCatalogResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional SearchCatalog requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchCatalogResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

The policy tag manager API service allows clients to manage their taxonomies and policy tags.

The policy tag manager API service allows clients to manage their taxonomies and policy tags.

A pager for iterating through list_policy_tags requests.

This class thinly wraps an initial ListPolicyTagsResponse object, and provides an __aiter__ method to iterate through its policy_tags field.

If there are more pages, the __aiter__ method will make additional ListPolicyTags requests and continue to iterate through the policy_tags field on the corresponding responses.

All the usual ListPolicyTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_policy_tags requests.

This class thinly wraps an initial ListPolicyTagsResponse object, and provides an __iter__ method to iterate through its policy_tags field.

If there are more pages, the __iter__ method will make additional ListPolicyTags requests and continue to iterate through the policy_tags field on the corresponding responses.

All the usual ListPolicyTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_taxonomies requests.

This class thinly wraps an initial ListTaxonomiesResponse object, and provides an __aiter__ method to iterate through its taxonomies field.

If there are more pages, the __aiter__ method will make additional ListTaxonomies requests and continue to iterate through the taxonomies field on the corresponding responses.

All the usual ListTaxonomiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_taxonomies requests.

This class thinly wraps an initial ListTaxonomiesResponse object, and provides an __iter__ method to iterate through its taxonomies field.

If there are more pages, the __iter__ method will make additional ListTaxonomies requests and continue to iterate through the taxonomies field on the corresponding responses.

All the usual ListTaxonomiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.

Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.

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

Describes a BigQuery table.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

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

Request message for CreateEntryGroup.

Request message for CreateEntry.

Request message for CreatePolicyTag.

Request message for CreateTag.

Request message for CreateTagTemplateField.

Request message for CreateTagTemplate.

Request message for CreateTaxonomy.

Request message for DeleteEntryGroup.

Request message for DeleteEntry.

Request message for DeletePolicyTag.

Request message for DeleteTag.

Request message for DeleteTagTemplateField.

Request message for DeleteTagTemplate.

Request message for DeleteTaxonomy.

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.

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

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

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.

Request message for ExportTaxonomies.

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

Response message for ExportTaxonomies.

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

Specifications of a single file in Cloud Storage.

Describes a Cloud Storage fileset entry.

Request message for GetEntryGroup.

Request message for GetEntry.

Request message for GetPolicyTag.

Request message for GetTagTemplate.

Request message for GetTaxonomy.

Request message for ImportTaxonomies.

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

Response message for ImportTaxonomies.

Inline source used for taxonomies import.

This enum describes all the possible systems that Data Catalog integrates with.

Request message for ListEntries.

Response message for ListEntries.

Request message for ListEntryGroups.

Response message for ListEntryGroups.

Request message for ListPolicyTags.

Response message for ListPolicyTags.

Request message for ListTags.

Response message for ListTags.

Request message for ListTaxonomies.

Response message for ListTaxonomies.

Request message for LookupEntry.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

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

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

Request message for RenameTagTemplateFieldEnumValue.

Request message for RenameTagTemplateField.

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

Request message for SearchCatalog.

The criteria that select the subspace used for query matching.

Response message for SearchCatalog.

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

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

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

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

Timestamps about this resource according to a particular system.

Table source type.

Normal BigQuery table spec.

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.

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

The abstract base class for a message.

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

Holds an enum value.

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 Google Cloud 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.

This enum describes TagTemplate transfer status to Dataplex service.

The abstract base class for a message.

The template for an individual field within a tag template.

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.

Defines policy types where policy tag can be used for.

The source system of the Taxonomy.

Request message for UpdateEntryGroup.

Request message for UpdateEntry.

Request message for UpdatePolicyTag.

Request message for UpdateTag.

Request message for UpdateTagTemplateField.

Request message for UpdateTagTemplate.

Request message for UpdateTaxonomy.

The set of all usage signals that we store in Data Catalog.

The abstract base class for a message.

Detailed counts on the entry's usage. Caveats:

• Only BigQuery tables have usage stats
• The usage stats only include BigQuery query jobs
• The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables

Table view specification.

API documentation for datacatalog_v1.services.data_catalog.pagers module.

API documentation for datacatalog_v1.services.policy_tag_manager.pagers module.

API documentation for datacatalog_v1beta1.services.data_catalog.pagers module.

API documentation for datacatalog_v1beta1.services.policy_tag_manager.pagers module.