Types for Google Cloud Datacatalog v1 API¶
- class google.cloud.datacatalog_v1.types.BigQueryConnectionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification for the BigQuery connection.
- connection_type¶
The type of the BigQuery connection.
- cloud_sql¶
Specification for the BigQuery connection to a Cloud SQL instance.
This field is a member of oneof
connection_spec.
- has_credential¶
True if there are credentials attached to the BigQuery connection; false otherwise.
- Type
- class ConnectionType(value)[source]¶
Bases:
proto.enums.EnumThe type of the BigQuery connection.
- Values:
- CONNECTION_TYPE_UNSPECIFIED (0):
Unspecified type.
- CLOUD_SQL (1):
Cloud SQL connection.
- class google.cloud.datacatalog_v1.types.BigQueryDateShardedSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification for a group of BigQuery tables with the
[prefix]YYYYMMDDname pattern.For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
- dataset¶
Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example:
projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}.- Type
- table_prefix¶
Output only. The table name prefix of the shards.
The name of any given shard is
[table_prefix]YYYYMMDD. For example, for theMyTable20180101shard, thetable_prefixisMyTable.- Type
- class google.cloud.datacatalog_v1.types.BigQueryRoutineSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFields specific for BigQuery routines.
- class google.cloud.datacatalog_v1.types.BigQueryTableSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes 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.
- table_source_type¶
Output only. The table source type.
- view_spec¶
Table view specification. Populated only if the
table_source_typeisBIGQUERY_VIEW.This field is a member of oneof
type_spec.
- class google.cloud.datacatalog_v1.types.BusinessContext(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBusiness Context of the entry.
- entry_overview¶
Entry overview fields for rich text descriptions of entries.
- contacts¶
Contact people for the entry.
- class google.cloud.datacatalog_v1.types.CloudBigtableInstanceSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to Instance entries that are part of
CLOUD_BIGTABLEsystem. (user_specified_type)- cloud_bigtable_cluster_specs¶
The list of clusters for the Instance.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.CloudBigtableInstanceSpec.CloudBigtableClusterSpec]
- class CloudBigtableClusterSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpec that applies to clusters of an Instance of Cloud Bigtable.
- class google.cloud.datacatalog_v1.types.CloudBigtableSystemSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to all entries that are part of
CLOUD_BIGTABLEsystem (user_specified_type)
- class google.cloud.datacatalog_v1.types.CloudSqlBigQueryConnectionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification for the BigQuery connection to a Cloud SQL instance.
- type_¶
Type of the Cloud SQL database.
- class DatabaseType(value)[source]¶
Bases:
proto.enums.EnumSupported Cloud SQL database types.
- Values:
- DATABASE_TYPE_UNSPECIFIED (0):
Unspecified database type.
- POSTGRES (1):
Cloud SQL for PostgreSQL.
- MYSQL (2):
Cloud SQL for MySQL.
- class google.cloud.datacatalog_v1.types.ColumnSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA column within a schema. Columns can be nested inside other columns.
- column¶
Required. Name of the column.
Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.
- Type
- type_¶
Required. Type of the column.
Must be a UTF-8 string with the maximum size of 128 bytes.
- Type
- description¶
Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes.
- Type
- mode¶
Optional. A column’s mode indicates whether values in this column are required, nullable, or repeated.
Only
NULLABLE,REQUIRED, andREPEATEDvalues are supported. Default mode isNULLABLE.- Type
- highest_indexing_type¶
Optional. Most important inclusion of this column.
- subcolumns¶
Optional. Schema of sub-columns. A column can have zero or more sub-columns.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.ColumnSchema]
- looker_column_spec¶
Looker specific column info of this column.
This field is a member of oneof
system_spec.
- gc_rule¶
Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.
- Type
- class IndexingType(value)[source]¶
Bases:
proto.enums.EnumSpecifies inclusion of the column in an index
- Values:
- INDEXING_TYPE_UNSPECIFIED (0):
Unspecified.
- INDEXING_TYPE_NONE (1):
Column not a part of an index.
- INDEXING_TYPE_NON_UNIQUE (2):
Column Part of non unique index.
- INDEXING_TYPE_UNIQUE (3):
Column part of unique index.
- INDEXING_TYPE_PRIMARY_KEY (4):
Column part of the primary key.
- class LookerColumnSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageColumn info specific to Looker System.
- type_¶
Looker specific column type of this column.
- class LookerColumnType(value)[source]¶
Bases:
proto.enums.EnumColumn type in Looker.
- Values:
- LOOKER_COLUMN_TYPE_UNSPECIFIED (0):
Unspecified.
- DIMENSION (1):
Dimension.
- DIMENSION_GROUP (2):
Dimension group - parent for Dimension.
- FILTER (3):
Filter.
- MEASURE (4):
Measure.
- PARAMETER (5):
Parameter.
- class google.cloud.datacatalog_v1.types.CommonUsageStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCommon statistics on the entry’s usage.
They can be set on any system.
- class google.cloud.datacatalog_v1.types.Contacts(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContact people for the entry.
- people¶
The list of contact people for the entry.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Contacts.Person]
- class Person(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA contact person for the entry.
- class google.cloud.datacatalog_v1.types.CreateEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup].
- parent¶
Required. The names of the project and location that the new entry group belongs to.
Note: The entry group itself and its child resources might not be stored in the location specified in its name.
- Type
- entry_group_id¶
Required. The ID of the entry group to create.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
- Type
- entry_group¶
The entry group to create. Defaults to empty.
- class google.cloud.datacatalog_v1.types.CreateEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry].
- parent¶
Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name.
- Type
- entry_id¶
Required. The ID of the entry to create.
The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8.
- Type
- entry¶
Required. The entry to create.
- class google.cloud.datacatalog_v1.types.CreatePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag].
- policy_tag¶
The policy tag to create.
- class google.cloud.datacatalog_v1.types.CreateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateTag][google.cloud.datacatalog.v1.DataCatalog.CreateTag].
- parent¶
Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags.
Note: The tag and its child resources might not be stored in the location specified in its name.
- Type
- tag¶
Required. The tag to create.
- class google.cloud.datacatalog_v1.types.CreateTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField].
- tag_template_field_id¶
Required. The ID of the tag template field to create.
Note: Adding a required field to an existing template is not allowed.
Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
- Type
- tag_template_field¶
Required. The tag template field to create.
- class google.cloud.datacatalog_v1.types.CreateTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate].
- tag_template_id¶
Required. The ID of the tag template to create.
The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
- Type
- tag_template¶
Required. The tag template to create.
- class google.cloud.datacatalog_v1.types.CreateTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CreateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy].
- taxonomy¶
The taxonomy to create.
- class google.cloud.datacatalog_v1.types.CrossRegionalSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCross-regional source used to import an existing taxonomy into a different region.
- class google.cloud.datacatalog_v1.types.DataSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePhysical location of an entry.
- service¶
Service that physically stores the data.
- resource¶
Full name of a resource as defined by the service. For example:
//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}- Type
- storage_properties¶
Detailed properties of the underlying storage.
This field is a member of oneof
properties.
- class Service(value)[source]¶
Bases:
proto.enums.EnumName of a service that stores the data.
- Values:
- SERVICE_UNSPECIFIED (0):
Default unknown service.
- CLOUD_STORAGE (1):
Google Cloud Storage service.
- BIGQUERY (2):
BigQuery service.
- class google.cloud.datacatalog_v1.types.DataSourceConnectionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to a data source connection. Valid only for entries with the
DATA_SOURCE_CONNECTIONtype. Only one of internal specs can be set at the time, and cannot be changed later.- bigquery_connection_spec¶
Output only. Fields specific to BigQuery connections.
- class google.cloud.datacatalog_v1.types.DatabaseTableSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to a table resource. Valid only for entries with the
TABLEtype.- type_¶
Type of this table.
- dataplex_table¶
Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries.
- database_view_spec¶
Spec what aplies to tables that are actually views. Not set for “real” tables.
- class DatabaseViewSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification 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.
- view_type¶
Type of this view.
- base_table¶
Name of a singular table this view reflects one to one.
This field is a member of oneof
source_definition.- Type
- sql_query¶
SQL query used to generate this view.
This field is a member of oneof
source_definition.- Type
- class ViewType(value)[source]¶
Bases:
proto.enums.EnumConcrete type of the view.
- Values:
- VIEW_TYPE_UNSPECIFIED (0):
Default unknown view type.
- STANDARD_VIEW (1):
Standard view.
- MATERIALIZED_VIEW (2):
Materialized view.
- class TableType(value)[source]¶
Bases:
proto.enums.EnumType of the table.
- Values:
- TABLE_TYPE_UNSPECIFIED (0):
Default unknown table type.
- NATIVE (1):
Native table.
- EXTERNAL (2):
External table.
- class google.cloud.datacatalog_v1.types.DataplexExternalTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExternal 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.
- system¶
Service in which the external table is registered.
- class google.cloud.datacatalog_v1.types.DataplexFilesetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntry specyfication for a Dataplex fileset.
- dataplex_spec¶
Common Dataplex fields.
- class google.cloud.datacatalog_v1.types.DataplexSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCommon Dataplex fields.
- asset¶
Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.
- Type
- data_format¶
Format of the data.
- class google.cloud.datacatalog_v1.types.DataplexTableSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntry specification for a Dataplex table.
- external_tables¶
List of external tables registered by Dataplex in other systems based on the same underlying data.
External tables allow to query this data in those systems.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.DataplexExternalTable]
- dataplex_spec¶
Common Dataplex fields.
- class google.cloud.datacatalog_v1.types.DatasetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to a dataset. Valid only for entries with the
DATASETtype.
- class google.cloud.datacatalog_v1.types.DeleteEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteEntryGroup][google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup].
- class google.cloud.datacatalog_v1.types.DeleteEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteEntry][google.cloud.datacatalog.v1.DataCatalog.DeleteEntry].
- class google.cloud.datacatalog_v1.types.DeletePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeletePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag].
- class google.cloud.datacatalog_v1.types.DeleteTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteTag][google.cloud.datacatalog.v1.DataCatalog.DeleteTag].
- class google.cloud.datacatalog_v1.types.DeleteTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField].
- class google.cloud.datacatalog_v1.types.DeleteTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteTagTemplate][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate].
- class google.cloud.datacatalog_v1.types.DeleteTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [DeleteTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy].
- class google.cloud.datacatalog_v1.types.DumpItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWrapper for any item that can be contained in the dump.
- class google.cloud.datacatalog_v1.types.Entry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntry 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_resourcefield 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][google.cloud.datacatalog.v1.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.
- name¶
Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.
- Type
- linked_resource¶
The resource this metadata entry refers to.
For Google Cloud Platform resources,
linked_resourceis the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, thelinked_resourcefor a table resource from BigQuery is://bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}Output only when the entry is one of the types in the
EntryTypeenum.For entries with a
user_specified_type, this field is optional and defaults to an empty string.The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.
- Type
- fully_qualified_name¶
Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.
- Type
- type_¶
The type of the entry.
For details, see
`EntryType<#entrytype>`__.This field is a member of oneof
entry_type.
- user_specified_type¶
Custom entry type that doesn’t match any of the values allowed for input and listed in the
EntryTypeenum.When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example,
my_special_type.The
user_specified_typestring has the following limitations:Is case insensitive.
Must begin with a letter or underscore.
Can only contain letters, numbers, and underscores.
Must be at least 1 character and at most 64 characters long.
This field is a member of oneof
entry_type.- Type
- integrated_system¶
Output only. Indicates the entry’s source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
This field is a member of oneof
system.
- user_specified_system¶
Indicates the entry’s source system that Data Catalog doesn’t automatically integrate with.
The
user_specified_systemstring has the following limitations:Is case insensitive.
Must begin with a letter or underscore.
Can only contain letters, numbers, and underscores.
Must be at least 1 character and at most 64 characters long.
This field is a member of oneof
system.- Type
- sql_database_system_spec¶
Specification that applies to a relational database system. Only settable when
user_specified_systemis equal toSQL_DATABASEThis field is a member of oneof
system_spec.
- looker_system_spec¶
Specification that applies to Looker sysstem. Only settable when
user_specified_systemis equal toLOOKERThis field is a member of oneof
system_spec.
- cloud_bigtable_system_spec¶
Specification that applies to Cloud Bigtable system. Only settable when
integrated_systemis equal toCLOUD_BIGTABLEThis field is a member of oneof
system_spec.
- gcs_fileset_spec¶
Specification that applies to a Cloud Storage fileset. Valid only for entries with the
FILESETtype.This field is a member of oneof
type_spec.
- bigquery_table_spec¶
Output only. Specification that applies to a BigQuery table. Valid only for entries with the
TABLEtype.This field is a member of oneof
type_spec.
- bigquery_date_sharded_spec¶
Output only. Specification for a group of BigQuery tables with the
[prefix]YYYYMMDDname pattern.For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
This field is a member of oneof
type_spec.
- database_table_spec¶
Specification that applies to a table resource. Valid only for entries with the
TABLEorEXPLOREtype.This field is a member of oneof
spec.
- data_source_connection_spec¶
Specification that applies to a data source connection. Valid only for entries with the
DATA_SOURCE_CONNECTIONtype.This field is a member of oneof
spec.
- routine_spec¶
Specification that applies to a user-defined function or procedure. Valid only for entries with the
ROUTINEtype.This field is a member of oneof
spec.
- fileset_spec¶
Specification that applies to a fileset resource. Valid only for entries with the
FILESETtype.This field is a member of oneof
spec.
- service_spec¶
Specification that applies to a Service resource.
This field is a member of oneof
spec.
- display_name¶
Display name of an entry.
The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
- Type
- description¶
Entry description that can consist of several sentences or paragraphs that describe entry contents.
The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.
- Type
- business_context¶
Business Context of the entry. Not supported for BigQuery datasets
- schema¶
Schema of the entry. An entry might not have any schema attached to it.
- source_system_timestamps¶
Timestamps from the underlying resource, not from the Data Catalog entry.
Output only when the entry has a system listed in the
IntegratedSystemenum. For entries withuser_specified_system, this field is optional and defaults to an empty timestamp.
- usage_signal¶
Resource usage statistics.
- labels¶
Cloud labels attached to the entry.
In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.
- data_source¶
Output only. Physical location of the entry.
- personal_details¶
Output only. Additional information related to the entry. Private to the current user.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datacatalog_v1.types.EntryGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntry group metadata.
An
EntryGroupresource represents a logical grouping of zero or more Data Catalog [Entry][google.cloud.datacatalog.v1.Entry] resources.- name¶
The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
- Type
- display_name¶
A short name to identify the entry group, for example, “analytics data - jan 2011”. Default value is an empty string.
- Type
- description¶
Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
- Type
- data_catalog_timestamps¶
Output only. Timestamps of the entry group. Default value is empty.
- class google.cloud.datacatalog_v1.types.EntryOverview(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntry overview fields for rich text descriptions of entries.
- class google.cloud.datacatalog_v1.types.EntryType(value)[source]¶
Bases:
proto.enums.EnumMetadata automatically ingested from Google Cloud resources like BigQuery tables or Pub/Sub topics always uses enum values from
EntryTypeas 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,FILESETfor a Cloud Storage fileset) or specifying a custom value using the`Entry<#resource:-entry>`__ fielduser_specified_type. For more information, see Surface files from Cloud Storage with fileset entries or Create custom entries for your data sources.- Values:
- ENTRY_TYPE_UNSPECIFIED (0):
Default unknown type.
- TABLE (2):
The entry type that has a GoogleSQL schema, including logical views.
- MODEL (5):
The type of models.
For more information, see Supported models in BigQuery ML.
- 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).
- class google.cloud.datacatalog_v1.types.ExportTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].
- class google.cloud.datacatalog_v1.types.ExportTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].
- taxonomies¶
List of taxonomies and policy tags as nested protocol buffers.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.SerializedTaxonomy]
- class google.cloud.datacatalog_v1.types.FieldType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis 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.
- primitive_type¶
Primitive types, such as string, boolean, etc.
This field is a member of oneof
type_decl.
- class EnumType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- allowed_values¶
The set of allowed values for this enum.
This set must not be empty and can include up to 100 allowed values. The display names of the values in this set must not be empty and must be case-insensitively unique within this set.
The order of items in this set is preserved. This field can be used to create, remove, and reorder enum values. To rename enum values, use the
RenameTagTemplateFieldEnumValuemethod.- Type
MutableSequence[google.cloud.datacatalog_v1.types.FieldType.EnumType.EnumValue]
- class EnumValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
- class PrimitiveType(value)[source]¶
Bases:
proto.enums.Enum- Values:
- PRIMITIVE_TYPE_UNSPECIFIED (0):
The default invalid value for a type.
- DOUBLE (1):
A double precision number.
- STRING (2):
An UTF-8 string.
- BOOL (3):
A boolean value.
- TIMESTAMP (4):
A timestamp.
- RICHTEXT (5):
A Richtext description.
- class google.cloud.datacatalog_v1.types.FilesetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to a fileset. Valid only for entries with the ‘FILESET’ type.
- dataplex_fileset¶
Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries.
- class google.cloud.datacatalog_v1.types.GcsFileSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification of a single file in Cloud Storage.
- gcs_timestamps¶
Output only. Creation, modification, and expiration timestamps of a Cloud Storage file.
- class google.cloud.datacatalog_v1.types.GcsFilesetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a Cloud Storage fileset entry.
- file_patterns¶
Required. Patterns to identify a set of files in Google Cloud Storage.
For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).
Note: Currently, bucket wildcards are not supported.
Examples of valid
file_patterns:gs://bucket_name/dir/*: matches all files inbucket_name/dirdirectorygs://bucket_name/dir/**: matches all files inbucket_name/dirand all subdirectoriesgs://bucket_name/file*: matches files prefixed byfileinbucket_namegs://bucket_name/??.txt: matches files with two characters followed by.txtinbucket_namegs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by.txtinbucket_namegs://bucket_name/[a-m].txt: matches files that containa,b, … ormfollowed by.txtinbucket_namegs://bucket_name/a/*/b: matches all files inbucket_namethat match thea/*/bpattern, such asa/c/b,a/d/bgs://another_bucket/a.txt: matchesgs://another_bucket/a.txt
You can combine wildcards to match complex sets of files, for example:
gs://bucket_name/[a-m]??.j*g- Type
MutableSequence[str]
- sample_gcs_file_specs¶
Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.GcsFileSpec]
- class google.cloud.datacatalog_v1.types.GetEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetEntryGroup][google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup].
- read_mask¶
The fields to return. If empty or omitted, all fields are returned.
- class google.cloud.datacatalog_v1.types.GetEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetEntry][google.cloud.datacatalog.v1.DataCatalog.GetEntry].
- class google.cloud.datacatalog_v1.types.GetPolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetPolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag].
- class google.cloud.datacatalog_v1.types.GetTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetTagTemplate][google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate].
- class google.cloud.datacatalog_v1.types.GetTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [GetTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy].
- class google.cloud.datacatalog_v1.types.ImportEntriesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata message for [long-running operation][google.longrunning.Operation] returned by the [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries].
- state¶
State of the import operation.
- errors¶
Partial errors that are encountered during the ImportEntries operation. There is no guarantee that all the encountered errors are reported. However, if no errors are reported, it means that no errors were encountered.
- Type
MutableSequence[google.rpc.status_pb2.Status]
- class ImportState(value)[source]¶
Bases:
proto.enums.EnumEnum holding possible states of the import operation.
- Values:
- IMPORT_STATE_UNSPECIFIED (0):
Default value. This value is unused.
- IMPORT_QUEUED (1):
The dump with entries has been queued for import.
- IMPORT_IN_PROGRESS (2):
The import of entries is in progress.
- IMPORT_DONE (3):
The import of entries has been finished.
- IMPORT_OBSOLETE (4):
The import of entries has been abandoned in favor of a newer request.
- class google.cloud.datacatalog_v1.types.ImportEntriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries] method.
- class google.cloud.datacatalog_v1.types.ImportEntriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [long-running operation][google.longrunning.Operation] returned by the [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries].
- class google.cloud.datacatalog_v1.types.ImportTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.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.
- class google.cloud.datacatalog_v1.types.ImportTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].
- taxonomies¶
Imported taxonomies.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Taxonomy]
- class google.cloud.datacatalog_v1.types.InlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInline source containing taxonomies to import.
- taxonomies¶
Required. Taxonomies to import.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.SerializedTaxonomy]
- class google.cloud.datacatalog_v1.types.IntegratedSystem(value)[source]¶
Bases:
proto.enums.EnumThis enum lists all the systems that Data Catalog integrates with.
- Values:
- INTEGRATED_SYSTEM_UNSPECIFIED (0):
Default unknown system.
- BIGQUERY (1):
BigQuery.
- CLOUD_PUBSUB (2):
Cloud Pub/Sub.
- DATAPROC_METASTORE (3):
Dataproc Metastore.
- DATAPLEX (4):
Dataplex.
- CLOUD_SPANNER (6):
Cloud Spanner
- CLOUD_BIGTABLE (7):
Cloud Bigtable
- CLOUD_SQL (8):
Cloud Sql
- LOOKER (9):
Looker
- VERTEX_AI (10):
Vertex AI
- class google.cloud.datacatalog_v1.types.ListEntriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].
- parent¶
Required. The name of the entry group that contains the entries to list. Can be provided in URL format.
- Type
- page_size¶
The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if
page_sizeis more than 1000.- Type
- page_token¶
Pagination token that specifies the next page to return. If empty, the first page is returned.
- Type
- read_mask¶
The fields to return for each entry. If empty or omitted, all fields are returned.
For example, to return a list of entries with only the
namefield, setread_maskto only one path with thenamevalue.
- class google.cloud.datacatalog_v1.types.ListEntriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].
- entries¶
Entry details.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Entry]
- class google.cloud.datacatalog_v1.types.ListEntryGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
- parent¶
Required. The name of the location that contains the entry groups to list. Can be provided as a URL.
- Type
- page_size¶
Optional. The maximum number of items to return.
Default is 10. Maximum limit is 1000. Throws an invalid argument if
page_sizeis greater than 1000.- Type
- class google.cloud.datacatalog_v1.types.ListEntryGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
- entry_groups¶
Entry group details.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.EntryGroup]
- class google.cloud.datacatalog_v1.types.ListPolicyTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].
- page_size¶
The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.
- Type
- class google.cloud.datacatalog_v1.types.ListPolicyTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].
- policy_tags¶
The policy tags that belong to the taxonomy.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.PolicyTag]
- class google.cloud.datacatalog_v1.types.ListTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
- parent¶
Required. The name of the Data Catalog resource to list the tags of.
The resource can be an [Entry][google.cloud.datacatalog.v1.Entry] or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup] (without
/entries/{entries}at the end).- Type
- class google.cloud.datacatalog_v1.types.ListTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
- tags¶
[Tag][google.cloud.datacatalog.v1.Tag] details.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Tag]
- class google.cloud.datacatalog_v1.types.ListTaxonomiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].
- page_size¶
The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.
- Type
- page_token¶
The pagination token of the next results page. If not set, the first page is returned.
The token is returned in the response to a previous list request.
- Type
- class google.cloud.datacatalog_v1.types.ListTaxonomiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].
- taxonomies¶
Taxonomies that the project contains.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Taxonomy]
- class google.cloud.datacatalog_v1.types.LookerSystemSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to entries that are part
LOOKERsystem (user_specified_type)- parent_instance_id¶
ID of the parent Looker Instance. Empty if it does not exist. Example value:
someinstance.looker.com- Type
- parent_instance_display_name¶
Name of the parent Looker Instance. Empty if it does not exist.
- Type
- class google.cloud.datacatalog_v1.types.LookupEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [LookupEntry][google.cloud.datacatalog.v1.DataCatalog.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.
- linked_resource¶
The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name).
Full names are case-sensitive. For example:
//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}
This field is a member of oneof
target_name.- Type
- sql_resource¶
The SQL name of the entry. SQL names are case-sensitive.
Examples:
pubsub.topic.{PROJECT_ID}.{TOPIC_ID}pubsub.topic.{PROJECT_ID}.`{TOPIC.ID.SEPARATED.WITH.DOTS}`bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}bigquery.dataset.{PROJECT_ID}.{DATASET_ID}datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}
Identifiers (
*_ID) should comply with the [Lexical structure in Standard SQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).This field is a member of oneof
target_name.- Type
- fully_qualified_name¶
Fully Qualified Name (FQN) of the resource.
FQNs take two forms:
For non-regionalized resources:
{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}For regionalized resources:
{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
Example for a DPMS table:
dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}This field is a member of oneof
target_name.- Type
- project¶
Project where the lookup should be performed. Required to lookup entry that is not a part of
DPMSorDATAPLEXintegrated_systemusing itsfully_qualified_name. Ignored in other cases.- Type
- class google.cloud.datacatalog_v1.types.ManagingSystem(value)[source]¶
Bases:
proto.enums.EnumThis enum describes all the systems that manage Taxonomy and PolicyTag resources in DataCatalog.
- Values:
- MANAGING_SYSTEM_UNSPECIFIED (0):
Default value
- MANAGING_SYSTEM_DATAPLEX (1):
Dataplex.
- MANAGING_SYSTEM_OTHER (2):
Other
- class google.cloud.datacatalog_v1.types.ModelSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to a model. Valid only for entries with the
MODELtype.
- class google.cloud.datacatalog_v1.types.ModifyEntryContactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ModifyEntryContacts][google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContacts].
- contacts¶
Required. The new value for the Contacts.
- class google.cloud.datacatalog_v1.types.ModifyEntryOverviewRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ModifyEntryOverview][google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverview].
- entry_overview¶
Required. The new value for the Entry Overview.
- class google.cloud.datacatalog_v1.types.PersonalDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEntry metadata relevant only to the user and private to them.
- star_time¶
Set if the entry is starred; unset otherwise.
- class google.cloud.datacatalog_v1.types.PhysicalSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNative 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.
- class AvroSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSchema in Avro JSON format.
- class CsvSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMarks a CSV-encoded data source.
- class OrcSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMarks an ORC-encoded data source.
- class ParquetSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMarks a Parquet-encoded data source.
- class ProtobufSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSchema in protocol buffer format.
- class ThriftSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSchema in Thrift format.
- class google.cloud.datacatalog_v1.types.PolicyTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDenotes 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.
- name¶
Output only. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
- Type
- display_name¶
Required. User-defined name of this policy tag. The name can’t start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
- Type
- description¶
Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
- Type
- parent_policy_tag¶
Resource name of this policy tag’s parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.
For example, for the “LatLong” policy tag in the example above, this field contains the resource name of the “Geolocation” policy tag, and, for “Geolocation”, this field is empty.
- Type
- class google.cloud.datacatalog_v1.types.ReconcileTagsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[Long-running operation][google.longrunning.Operation] metadata message returned by the [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
- state¶
State of the reconciliation operation.
- errors¶
Maps the name of each tagged column (or empty string for a sole entry) to tagging operation [status][google.rpc.Status].
- Type
MutableMapping[str, google.rpc.status_pb2.Status]
- class ErrorsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class ReconciliationState(value)[source]¶
Bases:
proto.enums.EnumEnum holding possible states of the reconciliation operation.
- Values:
- RECONCILIATION_STATE_UNSPECIFIED (0):
Default value. This value is unused.
- RECONCILIATION_QUEUED (1):
The reconciliation has been queued and awaits for execution.
- RECONCILIATION_IN_PROGRESS (2):
The reconciliation is in progress.
- RECONCILIATION_DONE (3):
The reconciliation has been finished.
- class google.cloud.datacatalog_v1.types.ReconcileTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
- force_delete_missing¶
If set to
true, deletes entry tags related to a tag template not listed in the tags source from an entry. If set tofalse, unlisted tags are retained.- Type
- tags¶
A list of tags to apply to an entry. A tag can specify a tag template, which must be the template specified in the
ReconcileTagsRequest. The sole entry and each of its columns must be mentioned at most once.- Type
MutableSequence[google.cloud.datacatalog_v1.types.Tag]
- class google.cloud.datacatalog_v1.types.ReconcileTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[Long-running operation][google.longrunning.Operation] response message returned by [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
- class google.cloud.datacatalog_v1.types.RenameTagTemplateFieldEnumValueRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [RenameTagTemplateFieldEnumValue][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue].
- class google.cloud.datacatalog_v1.types.RenameTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [RenameTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField].
- class google.cloud.datacatalog_v1.types.ReplaceTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [ReplaceTaxonomy][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy].
- serialized_taxonomy¶
Required. Taxonomy to update along with its child policy tags.
- class google.cloud.datacatalog_v1.types.RoutineSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to a routine. Valid only for entries with the
ROUTINEtype.- routine_type¶
The type of the routine.
- language¶
The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are:
SQLJAVASCRIPT
- Type
- routine_arguments¶
Arguments of the routine.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.RoutineSpec.Argument]
- return_type¶
Return type of the argument. The exact value depends on the source system and the language.
- Type
- bigquery_routine_spec¶
Fields specific for BigQuery routines.
This field is a member of oneof
system_spec.
- class Argument(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInput or output argument of a function or stored procedure.
- mode¶
Specifies whether the argument is input or output.
- type_¶
Type of the argument. The exact value depends on the source system and the language.
- Type
- class Mode(value)[source]¶
Bases:
proto.enums.EnumThe input or output mode of the argument.
- Values:
- MODE_UNSPECIFIED (0):
Unspecified mode.
- IN (1):
The argument is input-only.
- OUT (2):
The argument is output-only.
- INOUT (3):
The argument is both an input and an output.
- class RoutineType(value)[source]¶
Bases:
proto.enums.EnumThe fine-grained type of the routine.
- Values:
- ROUTINE_TYPE_UNSPECIFIED (0):
Unspecified type.
- SCALAR_FUNCTION (1):
Non-builtin permanent scalar function.
- PROCEDURE (2):
Stored procedure.
- class google.cloud.datacatalog_v1.types.Schema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
- columns¶
The unified GoogleSQL-like schema of columns.
The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.ColumnSchema]
- class google.cloud.datacatalog_v1.types.SearchCatalogRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
- scope¶
Required. The scope of this search request.
The
scopeis invalid ifinclude_org_ids,include_project_idsare empty ANDinclude_gcp_public_datasetsis set tofalse. In this case, the request returns an error.
- query¶
Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.
An empty query string returns all data assets (in the specified scope) that you have access to.
A query string can be a simple
xyzor qualified by predicates:name:xcolumn:ydescription:z
- Type
- page_size¶
Upper bound on the number of results you can get in a single response. Can’t be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an “invalid argument” exception.
- Type
- page_token¶
Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page.
This token is returned in the [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token] field of the response to a previous [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog] call.
- Type
- order_by¶
Specifies the order of results.
Currently supported case-sensitive values are:
relevancethat can only be descendinglast_modified_timestamp [asc|desc]with descending (desc) as defaultdefaultthat can only be descending
Search queries don’t guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don’t have to fetch the results in any specific order, consider setting this parameter to
default.If this parameter is omitted, it defaults to the descending
relevance.- Type
- admin_search¶
Optional. If set, use searchAll permission granted on organizations from
include_org_idsand projects frominclude_project_idsinstead of the fine grained per resource permissions when filtering the search results. The only allowedorder_bycriteria for admin_search mode isdefault. Using this flags guarantees a full recall of the search results.- Type
- class Scope(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe criteria that select the subspace used for query matching.
- include_org_ids¶
The list of organization IDs to search within.
To find your organization ID, follow the steps from [Creating and managing organizations] (/resource-manager/docs/creating-managing-organization).
- Type
MutableSequence[str]
- include_project_ids¶
The list of project IDs to search within.
For more information on the distinction between project names, IDs, and numbers, see Projects.
- Type
MutableSequence[str]
- include_gcp_public_datasets¶
If
true, include Google Cloud public datasets in search results. By default, they are excluded.See Google Cloud Public Datasets for more information.
- Type
- restricted_locations¶
Optional. The list of locations to search within. If empty, all locations are searched.
Returns an error if any location in the list isn’t one of the Supported regions.
If a location is unreachable, its name is returned in the
SearchCatalogResponse.unreachablefield. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.- Type
MutableSequence[str]
- starred_only¶
Optional. If
true, search only among starred entries.By default, all results are returned, starred or not.
- Type
- class google.cloud.datacatalog_v1.types.SearchCatalogResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
- results¶
Search results.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.SearchCatalogResult]
- next_page_token¶
Pagination token that can be used in subsequent calls to retrieve the next page of results.
- Type
- class google.cloud.datacatalog_v1.types.SearchCatalogResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResult 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.
- search_result_type¶
Type of the search result.
You can use this field to determine which get method to call to fetch the full resource.
- search_result_subtype¶
Sub-type of the search result.
A dot-delimited full type of the resource. The same type you specify in the
typesearch predicate.Examples:
entry.table,entry.dataStream,tagTemplate.- Type
- relative_resource_name¶
The relative name of the resource in URL format.
Examples:
projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}
- Type
- linked_resource¶
The full name of the Google Cloud resource the entry belongs to.
For more information, see [Full Resource Name] (/apis/design/resource_names#full_resource_name).
Example:
//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID- Type
- modify_time¶
The last modification timestamp of the entry in the source system.
- integrated_system¶
Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
This field is a member of oneof
system.
- user_specified_system¶
Custom source system that you can manually integrate Data Catalog with.
This field is a member of oneof
system.- Type
- fully_qualified_name¶
Fully qualified name (FQN) of the resource.
FQNs take two forms:
For non-regionalized resources:
{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}For regionalized resources:
{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
Example for a DPMS table:
dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID- Type
- class google.cloud.datacatalog_v1.types.SearchResultType(value)[source]¶
Bases:
proto.enums.EnumThe resource types that can be returned in search results.
- Values:
- SEARCH_RESULT_TYPE_UNSPECIFIED (0):
Default unknown type.
- ENTRY (1):
An [Entry][google.cloud.datacatalog.v1.Entry].
- TAG_TEMPLATE (2):
A [TagTemplate][google.cloud.datacatalog.v1.TagTemplate].
- ENTRY_GROUP (3):
An [EntryGroup][google.cloud.datacatalog.v1.EntryGroup].
- class google.cloud.datacatalog_v1.types.SerializedPolicyTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA nested protocol buffer that represents a policy tag and all its descendants.
- policy_tag¶
Resource name of the policy tag.
This field is ignored when calling
ImportTaxonomies.- Type
- display_name¶
Required. Display name of the policy tag. At most 200 bytes when encoded in UTF-8.
- Type
- description¶
Description of the serialized policy tag. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
- Type
- child_policy_tags¶
Children of the policy tag, if any.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.SerializedPolicyTag]
- class google.cloud.datacatalog_v1.types.SerializedTaxonomy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.
- display_name¶
Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.
- Type
- description¶
Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
- Type
- policy_tags¶
Top level policy tags associated with the taxonomy, if any.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.SerializedPolicyTag]
- activated_policy_types¶
A list of policy types that are activated per taxonomy.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Taxonomy.PolicyType]
- class google.cloud.datacatalog_v1.types.ServiceSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to a Service resource. Valid only for entries with the
SERVICEtype.
- class google.cloud.datacatalog_v1.types.SqlDatabaseSystemSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification that applies to entries that are part
SQL_DATABASEsystem (user_specified_type)- sql_engine¶
SQL Database Engine. enum SqlEngine { UNDEFINED = 0; MY_SQL = 1; POSTGRE_SQL = 2; SQL_SERVER = 3; } Engine of the enclosing database instance.
- Type
- class google.cloud.datacatalog_v1.types.StarEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [StarEntry][google.cloud.datacatalog.v1.DataCatalog.StarEntry].
- class google.cloud.datacatalog_v1.types.StarEntryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [StarEntry][google.cloud.datacatalog.v1.DataCatalog.StarEntry]. Empty for now
- class google.cloud.datacatalog_v1.types.StorageProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetails the properties of the underlying storage.
- file_pattern¶
Patterns to identify a set of files for this fileset.
Examples of a valid
file_pattern:gs://bucket_name/dir/*: matches all files in thebucket_name/dirdirectorygs://bucket_name/dir/**: matches all files in thebucket_name/dirand all subdirectories recursivelygs://bucket_name/file*: matches files prefixed byfileinbucket_namegs://bucket_name/??.txt: matches files with two characters followed by.txtinbucket_namegs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by.txtinbucket_namegs://bucket_name/[a-m].txt: matches files that containa,b, … ormfollowed by.txtinbucket_namegs://bucket_name/a/*/b: matches all files inbucket_namethat match thea/*/bpattern, such asa/c/b,a/d/bgs://another_bucket/a.txt: matchesgs://another_bucket/a.txt
- Type
MutableSequence[str]
- class google.cloud.datacatalog_v1.types.SystemTimestamps(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTimestamps associated with this resource in a particular system.
- create_time¶
Creation timestamp of the resource within the given system.
- update_time¶
Timestamp of the last modification of the resource or its metadata within a given system.
Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
- expire_time¶
Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
- class google.cloud.datacatalog_v1.types.TableSourceType(value)[source]¶
Bases:
proto.enums.EnumTable source type.
- Values:
- TABLE_SOURCE_TYPE_UNSPECIFIED (0):
Default unknown type.
- BIGQUERY_VIEW (2):
Table view.
- BIGQUERY_TABLE (5):
BigQuery native table.
- BIGQUERY_MATERIALIZED_VIEW (7):
BigQuery materialized view.
- class google.cloud.datacatalog_v1.types.TableSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNormal BigQuery table specification.
- grouped_entry¶
Output only. If the table is date-sharded, that is, it matches the
[prefix]YYYYMMDDname pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example:projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}.Otherwise,
grouped_entryis empty.- Type
- class google.cloud.datacatalog_v1.types.Tag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template.
See Data Catalog IAM for information on the permissions needed to create or view tags.
- name¶
The resource name of the tag in URL format where tag ID is a system-generated identifier.
Note: The tag itself might not be stored in the location specified in its name.
- Type
- template¶
Required. The resource name of the tag template this tag uses. Example:
projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}This field cannot be modified after creation.
- Type
- column¶
Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.
To attach a tag to a nested column, separate column names with a dot (
.). Example:column.nested_column.This field is a member of oneof
scope.- Type
- fields¶
Required. Maps the ID of a tag field to its value and additional information about that field.
Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
- Type
MutableMapping[str, google.cloud.datacatalog_v1.types.TagField]
- class FieldsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datacatalog_v1.types.TagField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains the value and additional information on a field within a [Tag][google.cloud.datacatalog.v1.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.
- double_value¶
The value of a tag field with a double type.
This field is a member of oneof
kind.- Type
- string_value¶
The value of a tag field with a string type.
The maximum length is 2000 UTF-8 characters.
This field is a member of oneof
kind.- Type
- bool_value¶
The value of a tag field with a boolean type.
This field is a member of oneof
kind.- Type
- timestamp_value¶
The value of a tag field with a timestamp type.
This field is a member of oneof
kind.
- enum_value¶
The value of a tag field with an enum type.
This value must be one of the allowed values listed in this enum.
This field is a member of oneof
kind.
- richtext_value¶
The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
This field is a member of oneof
kind.- Type
- order¶
Output only. The order of this field with respect to other fields in this tag. Can be set by [Tag][google.cloud.datacatalog.v1.TagTemplateField.order].
For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don’t have to be sequential.
- Type
- class EnumValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn enum value.
- class google.cloud.datacatalog_v1.types.TagTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
- name¶
The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
- Type
- display_name¶
Display name for this template. Defaults to an empty string.
The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can’t start or end with spaces. The maximum length is 200 characters.
- Type
- is_publicly_readable¶
Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in [ListTags][google.cloud.datacatalog.v1.ListTags] API response.
Additionally, you can search for a public tag by value with a simple search query in addition to using a
tag:predicate.- Type
- fields¶
Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields.
The keys to this map are tag template field IDs. The IDs have the following limitations:
Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_).
Must be at least 1 character and at most 64 characters long.
Must start with a letter or underscore.
- Type
MutableMapping[str, google.cloud.datacatalog_v1.types.TagTemplateField]
- class FieldsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datacatalog_v1.types.TagTemplateField(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe template for an individual field within a tag template.
- name¶
Output only. The resource name of the tag template field in URL format. Example:
projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}Note: The tag template field itself might not be stored in the location specified in its name.
The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters.
- Type
- display_name¶
The display name for this field. Defaults to an empty string.
The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can’t start or end with spaces. The maximum length is 200 characters.
- Type
- type_¶
Required. The type of value this tag field can contain.
- class google.cloud.datacatalog_v1.types.TaggedEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWrapper containing Entry and information about Tags that should and should not be attached to it.
- present_tags¶
Optional. Tags that should be ingested into the Data Catalog. Caller should populate template name, column and fields.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Tag]
- absent_tags¶
Optional. Tags that should be deleted from the Data Catalog. Caller should populate template name and column only.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Tag]
- class google.cloud.datacatalog_v1.types.Taxonomy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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
- name¶
Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
- Type
- display_name¶
Required. User-defined name of this taxonomy.
The name can’t start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8.
The taxonomy display name must be unique within an organization.
- Type
- description¶
Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
- Type
- taxonomy_timestamps¶
Output only. Creation and modification timestamps of this taxonomy.
- activated_policy_types¶
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
- Type
MutableSequence[google.cloud.datacatalog_v1.types.Taxonomy.PolicyType]
- service¶
Output only. Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only ‘DATAPLEX’ is supported.
- class PolicyType(value)[source]¶
Bases:
proto.enums.EnumDefines policy types where the policy tags can be used for.
- Values:
- POLICY_TYPE_UNSPECIFIED (0):
Unspecified policy type.
- FINE_GRAINED_ACCESS_CONTROL (1):
Fine-grained access control policy that enables access control on tagged sub-resources.
- class Service(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe source system of the Taxonomy.
- name¶
The Google Cloud service name.
- class google.cloud.datacatalog_v1.types.UnstarEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UnstarEntry][google.cloud.datacatalog.v1.DataCatalog.UnstarEntry].
- class google.cloud.datacatalog_v1.types.UnstarEntryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [UnstarEntry][google.cloud.datacatalog.v1.DataCatalog.UnstarEntry]. Empty for now
- class google.cloud.datacatalog_v1.types.UpdateEntryGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup].
- entry_group¶
Required. Updates for the entry group. The
namefield must be set.
- update_mask¶
Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
- class google.cloud.datacatalog_v1.types.UpdateEntryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateEntry][google.cloud.datacatalog.v1.DataCatalog.UpdateEntry].
- entry¶
Required. Updates for the entry. The
namefield must be set.
- update_mask¶
Names of fields whose values to overwrite on an entry.
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
You can modify only the fields listed below.
For entries with type
DATA_STREAM:schema
For entries with type
FILESET:schemadisplay_namedescriptiongcs_fileset_specgcs_fileset_spec.file_patterns
For entries with
user_specified_type:schemadisplay_namedescriptionuser_specified_typeuser_specified_systemlinked_resourcesource_system_timestamps
- class google.cloud.datacatalog_v1.types.UpdatePolicyTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag].
- policy_tag¶
The policy tag to update. You can update only its description, display name, and parent policy tag fields.
- update_mask¶
Specifies the fields to update.
You can update only display name, description, and parent policy tag. If not set, defaults to all updatable fields. For more information, see [FieldMask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
- class google.cloud.datacatalog_v1.types.UpdateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateTag][google.cloud.datacatalog.v1.DataCatalog.UpdateTag].
- tag¶
Required. The updated tag. The “name” field must be set.
- update_mask¶
Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name
fields.In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
- class google.cloud.datacatalog_v1.types.UpdateTagTemplateFieldRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField].
- tag_template_field¶
Required. The template to update.
- update_mask¶
Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
display_nametype.enum_typeis_required
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.
Additionally, updating a template field from optional to required is not allowed.
- class google.cloud.datacatalog_v1.types.UpdateTagTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate].
- tag_template¶
Required. The template to update. The
namefield must be set.
- update_mask¶
Names of fields whose values to overwrite on a tag template. Currently, only
display_nameandis_publicly_readablecan be overwritten.If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
Note: Updating the
is_publicly_readablefield may require up to 12 hours to take effect in search results.
- class google.cloud.datacatalog_v1.types.UpdateTaxonomyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [UpdateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy].
- taxonomy¶
The taxonomy to update. You can update only its description, display name, and activated policy types.
- update_mask¶
Specifies fields to update. If not set, defaults to all fields you can update.
For more information, see [FieldMask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
- class google.cloud.datacatalog_v1.types.UsageSignal(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe 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.
- update_time¶
The end timestamp of the duration of usage statistics.
- usage_within_time_range¶
Output only. BigQuery usage statistics over each of the predefined time ranges.
Supported time ranges are
{"24H", "7D", "30D"}.- Type
MutableMapping[str, google.cloud.datacatalog_v1.types.UsageStats]
- common_usage_within_time_range¶
Common usage statistics over each of the predefined time ranges.
Supported time ranges are
{"24H", "7D", "30D", "Lifetime"}.- Type
MutableMapping[str, google.cloud.datacatalog_v1.types.CommonUsageStats]
- favorite_count¶
Favorite count in the source system.
This field is a member of oneof
_favorite_count.- Type
- class CommonUsageWithinTimeRangeEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class UsageWithinTimeRangeEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datacatalog_v1.types.UsageStats(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetailed 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] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables)
- class google.cloud.datacatalog_v1.types.VertexDatasetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification for vertex dataset resources.
- data_item_count¶
The number of DataItems in this Dataset. Only apply for non-structured Dataset.
- Type
- data_type¶
Type of the dataset.
- class DataType(value)[source]¶
Bases:
proto.enums.EnumType of data stored in the dataset.
- Values:
- DATA_TYPE_UNSPECIFIED (0):
Should not be used.
- TABLE (1):
Structured data dataset.
- IMAGE (2):
Image dataset which supports ImageClassification, ImageObjectDetection and ImageSegmentation problems.
- TEXT (3):
Document dataset which supports TextClassification, TextExtraction and TextSentiment problems.
- VIDEO (4):
Video dataset which supports VideoClassification, VideoObjectTracking and VideoActionRecognition problems.
- CONVERSATION (5):
Conversation dataset which supports conversation problems.
- TIME_SERIES (6):
TimeSeries dataset.
- DOCUMENT (7):
Document dataset which supports DocumentAnnotation problems.
- TEXT_TO_SPEECH (8):
TextToSpeech dataset which supports TextToSpeech problems.
- TRANSLATION (9):
Translation dataset which supports Translation problems.
- STORE_VISION (10):
Store Vision dataset which is used for HITL integration.
- ENTERPRISE_KNOWLEDGE_GRAPH (11):
Enterprise Knowledge Graph dataset which is used for HITL labeling integration.
- TEXT_PROMPT (12):
Text prompt dataset which supports Large Language Models.
- class google.cloud.datacatalog_v1.types.VertexModelSourceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetail description of the source information of a Vertex model.
- source_type¶
Type of the model source.
- copy¶
If this Model is copy of another Model. If true then [source_type][google.cloud.datacatalog.v1.VertexModelSourceInfo.source_type] pertains to the original.
- Type
- class ModelSourceType(value)[source]¶
Bases:
proto.enums.EnumSource of the model.
- Values:
- MODEL_SOURCE_TYPE_UNSPECIFIED (0):
Should not be used.
- AUTOML (1):
The Model is uploaded by automl training pipeline.
- CUSTOM (2):
The Model is uploaded by user or custom training pipeline.
- BQML (3):
The Model is registered and sync’ed from BigQuery ML.
- MODEL_GARDEN (4):
The Model is saved or tuned from Model Garden.
- class google.cloud.datacatalog_v1.types.VertexModelSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecification for vertex model resources.
- version_aliases¶
User provided version aliases so that a model version can be referenced via alias
- Type
MutableSequence[str]
- vertex_model_source_info¶
Source of a Vertex model.
- class google.cloud.datacatalog_v1.types.ViewSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTable view specification.
