Summary of entries of Classes for datacatalog .
Classes
DataCatalogAsyncClient
Data Catalog API service allows you to discover, understand, and manage your data.
DataCatalogClient
Data Catalog API service allows you to discover, understand, and manage your data.
ListEntriesAsyncPager
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.
ListEntriesPager
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.
ListEntryGroupsAsyncPager
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.
ListEntryGroupsPager
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.
ListTagsAsyncPager
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.
ListTagsPager
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.
SearchCatalogAsyncPager
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.
SearchCatalogPager
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.
PolicyTagManagerAsyncClient
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.
PolicyTagManagerClient
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.
ListPolicyTagsAsyncPager
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.
ListPolicyTagsPager
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.
ListTaxonomiesAsyncPager
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.
ListTaxonomiesPager
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.
PolicyTagManagerSerializationAsyncClient
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.
PolicyTagManagerSerializationClient
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.
BigQueryConnectionSpec
Specification for the BigQuery connection.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ConnectionType
The type of the BigQuery connection.
BigQueryDateShardedSpec
Specification for a group of BigQuery tables with the
[prefix]YYYYMMDD
name pattern.
For more information, see Introduction to partitioned tables.
BigQueryRoutineSpec
Fields specific for BigQuery routines.
BigQueryTableSpec
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
BusinessContext
Business Context of the entry.
CloudBigtableInstanceSpec
Specification that applies to Instance entries that are part of
CLOUD_BIGTABLE
system. (user_specified_type)
CloudBigtableClusterSpec
Spec that applies to clusters of an Instance of Cloud Bigtable.
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.
DatabaseType
Supported Cloud SQL database types.
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
FieldElementType
Represents the type of a field element.
IndexingType
Specifies inclusion of the column in an index
LookerColumnSpec
Column info specific to Looker System.
LookerColumnType
Column type in Looker.
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.
Person
A contact person 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
Service
Name of a service that stores the data.
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.
DatabaseViewSpec
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
ViewType
Concrete type of the view.
TableType
Type of the table.
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.
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
LabelsEntry
The abstract base class for a message.
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>__ field
user_specified_type. For more information, see
Surface files
from Cloud Storage with fileset
entries </data-catalog/docs/how-to/filesets>__ or
Create 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).
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.
FieldType
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
EnumType
EnumValue
PrimitiveType
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.
ImportState
Enum holding possible states of the import operation.
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.
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
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.
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
ManagingSystem
This enum describes all the systems that manage Taxonomy and PolicyTag resources in DataCatalog.
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.
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.
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
AvroSchema
Schema in Avro JSON format.
CsvSchema
Marks a CSV-encoded data source.
OrcSchema
Marks an ORC-encoded data source.
ParquetSchema
Marks a Parquet-encoded data source.
ProtobufSchema
Schema in protocol buffer format.
ThriftSchema
Schema in Thrift format.
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.
ErrorsEntry
The abstract base class for a message.
ReconciliationState
Enum holding possible states of the reconciliation operation.
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.
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
Argument
Input or output argument of a function or stored procedure.
Mode
The input or output mode of the argument.
RoutineType
The fine-grained type of the routine.
Schema
Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
SearchCatalogRequest
Request message for SearchCatalog.
Scope
The criteria that select the subspace used for query matching.
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.
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
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
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
FieldsEntry
The abstract base class for a message.
TagField
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
EnumValue
An enum value.
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.
FieldsEntry
The abstract base class for a message.
TagTemplateField
The template for an individual field within a tag template.
TaggedEntry
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
Taxonomy
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
PolicyType
Defines policy types where the policy tags can be used for.
Service
The source system of the Taxonomy.
UnstarEntryRequest
Request message for UnstarEntry.
UnstarEntryResponse
Response message for UnstarEntry. Empty for now
UpdateEntryGroupRequest
Request message for UpdateEntryGroup.
UpdateEntryRequest
Request message for UpdateEntry.
UpdatePolicyTagRequest
Request message for UpdatePolicyTag.
UpdateTagRequest
Request message for UpdateTag.
UpdateTagTemplateFieldRequest
Request message for UpdateTagTemplateField.
UpdateTagTemplateRequest
Request message for UpdateTagTemplate.
UpdateTaxonomyRequest
Request message for UpdateTaxonomy.
UsageSignal
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
CommonUsageWithinTimeRangeEntry
The abstract base class for a message.
UsageWithinTimeRangeEntry
The abstract base class for a message.
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
VertexDatasetSpec
Specification for vertex dataset resources.
DataType
Type of data stored in the dataset.
VertexModelSourceInfo
Detail description of the source information of a Vertex model.
ModelSourceType
Source of the model.
VertexModelSpec
Specification for vertex model resources.
ViewSpec
Table view specification.
DataCatalogAsyncClient
Data Catalog API service allows clients to discover, understand, and manage their data.
DataCatalogClient
Data Catalog API service allows clients to discover, understand, and manage their data.
ListEntriesAsyncPager
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.
ListEntriesPager
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.
ListEntryGroupsAsyncPager
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.
ListEntryGroupsPager
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.
ListTagsAsyncPager
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.
ListTagsPager
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.
SearchCatalogAsyncPager
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.
SearchCatalogPager
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.
PolicyTagManagerAsyncClient
The policy tag manager API service allows clients to manage their taxonomies and policy tags.
PolicyTagManagerClient
The policy tag manager API service allows clients to manage their taxonomies and policy tags.
ListPolicyTagsAsyncPager
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.
ListPolicyTagsPager
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.
ListTaxonomiesAsyncPager
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.
ListTaxonomiesPager
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.
PolicyTagManagerSerializationAsyncClient
Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.
PolicyTagManagerSerializationClient
Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.
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.
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
ColumnSchema
Representation of a column within a schema. Columns could be nested inside other columns.
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.
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.
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.
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
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExportTaxonomiesResponse
Response message for ExportTaxonomies.
FieldType
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
EnumType
EnumValue
PrimitiveType
GcsFileSpec
Specifications 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.
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 used for taxonomies import.
IntegratedSystem
This enum describes all the possible 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.
LookupEntryRequest
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
ManagingSystem
This enum describes all the systems that manage Taxonomy and PolicyTag resources in DataCatalog.
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".
RenameTagTemplateFieldEnumValueRequest
Request message for RenameTagTemplateFieldEnumValue.
RenameTagTemplateFieldRequest
Request message for RenameTagTemplateField.
Schema
Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
SearchCatalogRequest
Request message for SearchCatalog.
Scope
The criteria that select the subspace used for query matching.
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.
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FieldsEntry
The abstract base class for a message.
TagField
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
EnumValue
Holds an enum value.
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 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.
FieldsEntry
The abstract base class for a message.
TagTemplateField
The template for an individual field within a tag template.
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.
PolicyType
Defines policy types where policy tag can be used for.
Service
The source system of the Taxonomy.
UpdateEntryGroupRequest
Request message for UpdateEntryGroup.
UpdateEntryRequest
Request message for UpdateEntry.
UpdatePolicyTagRequest
Request message for UpdatePolicyTag.
UpdateTagRequest
Request message for UpdateTag.
UpdateTagTemplateFieldRequest
Request message for UpdateTagTemplateField.
UpdateTagTemplateRequest
Request message for UpdateTagTemplate.
UpdateTaxonomyRequest
Request message for UpdateTaxonomy.
UsageSignal
The set of all usage signals that we store in Data Catalog.
UsageWithinTimeRangeEntry
The abstract base class for a message.
UsageStats
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
ViewSpec
Table view specification.
Modules
pagers
API documentation for datacatalog_v1.services.data_catalog.pagers
module.
pagers
API documentation for datacatalog_v1.services.policy_tag_manager.pagers
module.
pagers
API documentation for datacatalog_v1beta1.services.data_catalog.pagers
module.
pagers
API documentation for datacatalog_v1beta1.services.policy_tag_manager.pagers
module.