Index
DataCatalog
(interface)PolicyTagManager
(interface)PolicyTagManagerSerialization
(interface)BigQueryConnectionSpec
(message)BigQueryConnectionSpec.ConnectionType
(enum)BigQueryDateShardedSpec
(message)BigQueryRoutineSpec
(message)BigQueryTableSpec
(message)BusinessContext
(message)CloudSqlBigQueryConnectionSpec
(message)CloudSqlBigQueryConnectionSpec.DatabaseType
(enum)ColumnSchema
(message)ColumnSchema.IndexingType
(enum)ColumnSchema.LookerColumnSpec
(message)ColumnSchema.LookerColumnSpec.LookerColumnType
(enum)CommonUsageStats
(message)Contacts
(message)Contacts.Person
(message)CreateEntryGroupRequest
(message)CreateEntryRequest
(message)CreatePolicyTagRequest
(message)CreateTagRequest
(message)CreateTagTemplateFieldRequest
(message)CreateTagTemplateRequest
(message)CreateTaxonomyRequest
(message)CrossRegionalSource
(message)DataSource
(message)DataSource.Service
(enum)DataSourceConnectionSpec
(message)DatabaseTableSpec
(message)DatabaseTableSpec.DatabaseViewSpec
(message)DatabaseTableSpec.DatabaseViewSpec.ViewType
(enum)DatabaseTableSpec.TableType
(enum)DataplexExternalTable
(message)DataplexFilesetSpec
(message)DataplexSpec
(message)DataplexTableSpec
(message)DeleteEntryGroupRequest
(message)DeleteEntryRequest
(message)DeletePolicyTagRequest
(message)DeleteTagRequest
(message)DeleteTagTemplateFieldRequest
(message)DeleteTagTemplateRequest
(message)DeleteTaxonomyRequest
(message)Entry
(message)EntryGroup
(message)EntryOverview
(message)EntryType
(enum)ExportTaxonomiesRequest
(message)ExportTaxonomiesResponse
(message)FieldType
(message)FieldType.EnumType
(message)FieldType.EnumType.EnumValue
(message)FieldType.PrimitiveType
(enum)FilesetSpec
(message)GcsFileSpec
(message)GcsFilesetSpec
(message)GetEntryGroupRequest
(message)GetEntryRequest
(message)GetPolicyTagRequest
(message)GetTagTemplateRequest
(message)GetTaxonomyRequest
(message)ImportTaxonomiesRequest
(message)ImportTaxonomiesResponse
(message)InlineSource
(message)IntegratedSystem
(enum)ListEntriesRequest
(message)ListEntriesResponse
(message)ListEntryGroupsRequest
(message)ListEntryGroupsResponse
(message)ListPolicyTagsRequest
(message)ListPolicyTagsResponse
(message)ListTagsRequest
(message)ListTagsResponse
(message)ListTaxonomiesRequest
(message)ListTaxonomiesResponse
(message)LookerSystemSpec
(message)LookupEntryRequest
(message)ManagingSystem
(enum)ModifyEntryContactsRequest
(message)ModifyEntryOverviewRequest
(message)PersonalDetails
(message)PhysicalSchema
(message)PhysicalSchema.AvroSchema
(message)PhysicalSchema.CsvSchema
(message)PhysicalSchema.OrcSchema
(message)PhysicalSchema.ParquetSchema
(message)PhysicalSchema.ProtobufSchema
(message)PhysicalSchema.ThriftSchema
(message)PolicyTag
(message)ReconcileTagsMetadata
(message)ReconcileTagsMetadata.ReconciliationState
(enum)ReconcileTagsRequest
(message)ReconcileTagsResponse
(message)RenameTagTemplateFieldEnumValueRequest
(message)RenameTagTemplateFieldRequest
(message)ReplaceTaxonomyRequest
(message)RoutineSpec
(message)RoutineSpec.Argument
(message)RoutineSpec.Argument.Mode
(enum)RoutineSpec.RoutineType
(enum)Schema
(message)SearchCatalogRequest
(message)SearchCatalogRequest.Scope
(message)SearchCatalogResponse
(message)SearchCatalogResult
(message)SearchResultType
(enum)SerializedPolicyTag
(message)SerializedTaxonomy
(message)SqlDatabaseSystemSpec
(message)StarEntryRequest
(message)StarEntryResponse
(message)StorageProperties
(message)SystemTimestamps
(message)TableSourceType
(enum)TableSpec
(message)Tag
(message)TagField
(message)TagField.EnumValue
(message)TagTemplate
(message)TagTemplateField
(message)Taxonomy
(message)Taxonomy.PolicyType
(enum)Taxonomy.Service
(message)UnstarEntryRequest
(message)UnstarEntryResponse
(message)UpdateEntryGroupRequest
(message)UpdateEntryRequest
(message)UpdatePolicyTagRequest
(message)UpdateTagRequest
(message)UpdateTagTemplateFieldRequest
(message)UpdateTagTemplateRequest
(message)UpdateTaxonomyRequest
(message)UsageSignal
(message)UsageStats
(message)ViewSpec
(message)
DataCatalog
Data Catalog API service allows you to discover, understand, and manage your data.
CreateEntry |
---|
Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the An entry group can have a maximum of 100,000 entries.
|
CreateEntryGroup |
---|
Creates an entry group. An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the
You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the
|
CreateTag |
---|
Creates a tag and assigns it to:
Note: The project identified by the
|
CreateTagTemplate |
---|
Creates a tag template. You must enable the Data Catalog API in the project identified by the
|
CreateTagTemplateField |
---|
Creates a field in a tag template. You must enable the Data Catalog API in the project identified by the
|
DeleteEntry |
---|
Deletes an existing entry. You can delete only the entries created by the You must enable the Data Catalog API in the project identified by the
|
DeleteEntryGroup |
---|
Deletes an entry group. You must enable the Data Catalog API in the project identified by the
|
DeleteTag |
---|
Deletes a tag.
|
DeleteTagTemplate |
---|
Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the
|
DeleteTagTemplateField |
---|
Deletes a field in a tag template and all uses of this field from the tags based on this template. You must enable the Data Catalog API in the project identified by the
|
GetEntry |
---|
Gets an entry.
|
GetEntryGroup |
---|
Gets an entry group.
|
GetIamPolicy |
---|
Gets the access control policy for a resource. May return:
Supported resources are:
Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions:
|
GetTagTemplate |
---|
Gets a tag template.
|
ListEntries |
---|
Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use
|
ListEntryGroups |
---|
Lists entry groups.
|
ListTags |
---|
Lists tags assigned to an
|
LookupEntry |
---|
Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.
|
ModifyEntryContacts |
---|
Modifies contacts, part of the business context of an To call this method, you must have the
|
ModifyEntryOverview |
---|
Modifies entry overview, part of the business context of an To call this method, you must have the
|
ReconcileTags |
---|
|
RenameTagTemplateField |
---|
Renames a field in a tag template. You must enable the Data Catalog API in the project identified by the
|
RenameTagTemplateFieldEnumValue |
---|
Renames an enum value in a tag template. Within a single enum field, enum values must be unique.
|
SearchCatalog |
---|
Searches Data Catalog for multiple resources like entries and tags that match a query. This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods. Note: Data Catalog 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. For more information, see Data Catalog search syntax.
|
SetIamPolicy |
---|
Sets an access control policy for a resource. Replaces any existing policy. Supported resources are:
Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions:
|
StarEntry |
---|
Marks an
|
TestIamPermissions |
---|
Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are:
Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.
|
UnstarEntry |
---|
Marks an
|
UpdateEntry |
---|
Updates an existing entry. You must enable the Data Catalog API in the project identified by the
|
UpdateEntryGroup |
---|
Updates an entry group. You must enable the Data Catalog API in the project identified by the
|
UpdateTag |
---|
Updates an existing tag.
|
UpdateTagTemplate |
---|
Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the
|
UpdateTagTemplateField |
---|
Updates a field in a tag template. You can't update the field type with this method. You must enable the Data Catalog API in the project identified by the
|
PolicyTagManager
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.
CreatePolicyTag |
---|
Creates a policy tag in a taxonomy.
|
CreateTaxonomy |
---|
Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.
|
DeletePolicyTag |
---|
Deletes a policy tag together with the following:
|
DeleteTaxonomy |
---|
Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.
|
GetIamPolicy |
---|
Gets the IAM policy for a policy tag or a taxonomy.
|
GetPolicyTag |
---|
Gets a policy tag.
|
GetTaxonomy |
---|
Gets a taxonomy.
|
ListPolicyTags |
---|
Lists all policy tags in a taxonomy.
|
ListTaxonomies |
---|
Lists all taxonomies in a project in a particular location that you have a permission to view.
|
SetIamPolicy |
---|
Sets the IAM policy for a policy tag or a taxonomy.
|
TestIamPermissions |
---|
Returns your permissions on a specified policy tag or taxonomy.
|
UpdatePolicyTag |
---|
Updates a policy tag, including its display name, description, and parent policy tag.
|
UpdateTaxonomy |
---|
Updates a taxonomy, including its display name, description, and activated policy types.
|
PolicyTagManagerSerialization
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.
ExportTaxonomies |
---|
Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates
|
ImportTaxonomies |
---|
Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.
|
ReplaceTaxonomy |
---|
Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by This operation automatically does the following:
|
BigQueryConnectionSpec
Specification for the BigQuery connection.
Fields | |
---|---|
connection_type |
The type of the BigQuery connection. |
has_credential |
True if there are credentials attached to the BigQuery connection; false otherwise. |
Union field
|
|
cloud_sql |
Specification for the BigQuery connection to a Cloud SQL instance. |
ConnectionType
The type of the BigQuery connection.
Enums | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
Unspecified type. |
CLOUD_SQL |
Cloud SQL connection. |
BigQueryDateShardedSpec
Specification for a group of BigQuery tables with the [prefix]YYYYMMDD
name pattern.
For more information, see Introduction to partitioned tables.
Fields | |
---|---|
dataset |
Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example:
|
table_prefix |
Output only. The table name prefix of the shards. The name of any given shard is |
shard_count |
Output only. Total number of shards. |
latest_shard_resource |
Output only. BigQuery resource name of the latest shard. |
BigQueryRoutineSpec
Fields specific for BigQuery routines.
Fields | |
---|---|
imported_libraries[] |
Paths of the imported libraries. |
BigQueryTableSpec
Describes a BigQuery table.
Fields | |
---|---|
table_source_type |
Output only. The table source type. |
Union field type_spec . Output only. type_spec can be only one of the following: |
|
view_spec |
Table view specification. Populated only if the |
table_spec |
Specification of a BigQuery table. Populated only if the |
BusinessContext
Business Context of the entry.
Fields | |
---|---|
entry_overview |
Entry overview fields for rich text descriptions of entries. |
contacts |
Contact people for the entry. |
CloudSqlBigQueryConnectionSpec
Specification for the BigQuery connection to a Cloud SQL instance.
Fields | |
---|---|
instance_id |
Cloud SQL instance ID in the format of |
database |
Database name. |
type |
Type of the Cloud SQL database. |
DatabaseType
Supported Cloud SQL database types.
Enums | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
Unspecified database type. |
POSTGRES |
Cloud SQL for PostgreSQL. |
MYSQL |
Cloud SQL for MySQL. |
ColumnSchema
A column within a schema. Columns can be nested inside other columns.
Fields | |
---|---|
column |
Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. |
type |
Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. |
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. |
mode |
Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only |
default_value |
Optional. Default value for the column. |
ordinal_position |
Optional. Ordinal position |
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. |
gc_rule |
Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable. |
Union field system_spec . Information only applying for columns in Entries from a specific system. system_spec can be only one of the following: |
|
looker_column_spec |
Looker specific column info of this column. |
IndexingType
Specifies inclusion of the column in an index
Enums | |
---|---|
INDEXING_TYPE_UNSPECIFIED |
Unspecified. |
INDEXING_TYPE_NONE |
Column not a part of an index. |
INDEXING_TYPE_NON_UNIQUE |
Column Part of non unique index. |
INDEXING_TYPE_UNIQUE |
Column part of unique index. |
INDEXING_TYPE_PRIMARY_KEY |
Column part of the primary key. |
LookerColumnSpec
Column info specific to Looker System.
Fields | |
---|---|
type |
Looker specific column type of this column. |
LookerColumnType
Column type in Looker.
Enums | |
---|---|
LOOKER_COLUMN_TYPE_UNSPECIFIED |
Unspecified. |
DIMENSION |
Dimension. |
DIMENSION_GROUP |
Dimension group - parent for Dimension. |
FILTER |
Filter. |
MEASURE |
Measure. |
PAREMETER |
Parameter. |
CommonUsageStats
Common statistics on the entry's usage.
They can be set on any system.
Fields | |
---|---|
Union field
|
|
view_count |
View count in source system. |
Contacts
Contact people for the entry.
Fields | |
---|---|
people[] |
The list of contact people for the entry. |
Person
A contact person for the entry.
Fields | |
---|---|
designation |
Designation of the person, for example, Data Steward. |
email |
Email of the person in the format of |
CreateEntryGroupRequest
Request message for CreateEntryGroup
.
Fields | |
---|---|
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. |
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. |
entry_group |
The entry group to create. Defaults to empty. |
CreateEntryRequest
Request message for CreateEntry
.
Fields | |
---|---|
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. |
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. |
entry |
Required. The entry to create. |
CreatePolicyTagRequest
Request message for CreatePolicyTag
.
Fields | |
---|---|
parent |
Required. Resource name of the taxonomy that the policy tag will belong to. Authorization requires the following IAM permission on the specified resource
|
policy_tag |
The policy tag to create. |
CreateTagRequest
Request message for CreateTag
.
Fields | |
---|---|
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. |
tag |
Required. The tag to create. |
CreateTagTemplateFieldRequest
Request message for CreateTagTemplateField
.
Fields | |
---|---|
parent |
Required. The name of the project and the template location region. |
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. |
tag_template_field |
Required. The tag template field to create. |
CreateTagTemplateRequest
Request message for CreateTagTemplate
.
Fields | |
---|---|
parent |
Required. The name of the project and the template location region. |
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. |
tag_template |
Required. The tag template to create. |
CreateTaxonomyRequest
Request message for CreateTaxonomy
.
Fields | |
---|---|
parent |
Required. Resource name of the project that the taxonomy will belong to. Authorization requires the following IAM permission on the specified resource
|
taxonomy |
The taxonomy to create. |
CrossRegionalSource
Cross-regional source used to import an existing taxonomy into a different region.
Fields | |
---|---|
taxonomy |
Required. The resource name of the source taxonomy to import. |
DataSource
Physical location of an entry.
Fields | |
---|---|
service |
Service that physically stores the data. |
resource |
Full name of a resource as defined by the service. For example:
|
source_entry |
Output only. Data Catalog entry name, if applicable. |
Union field
|
|
storage_properties |
Detailed properties of the underlying storage. |
Service
Name of a service that stores the data.
Enums | |
---|---|
SERVICE_UNSPECIFIED |
Default unknown service. |
CLOUD_STORAGE |
Google Cloud Storage service. |
BIGQUERY |
BigQuery service. |
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.
Fields | |
---|---|
bigquery_connection_spec |
Output only. Fields specific to BigQuery connections. |
DatabaseTableSpec
Specification that applies to a table resource. Valid only for entries with the TABLE
type.
Fields | |
---|---|
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. |
DatabaseViewSpec
Specification that applies to database view.
Fields | |
---|---|
view_type |
Type of this view. |
Union field source_definition . Definition of the view. source_definition can be only one of the following: |
|
base_table |
Name of a singular table this view reflects one to one. |
sql_query |
SQL query used to generate this view. |
ViewType
Concrete type of the view.
Enums | |
---|---|
VIEW_TYPE_UNSPECIFIED |
Default unknown view type. |
STANDARD_VIEW |
Standard view. |
MATERIALIZED_VIEW |
Materialized view. |
TableType
Type of the table.
Enums | |
---|---|
TABLE_TYPE_UNSPECIFIED |
Default unknown table type. |
NATIVE |
Native table. |
EXTERNAL |
External 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.
Fields | |
---|---|
system |
Service in which the external table is registered. |
fully_qualified_name |
Fully qualified name (FQN) of the external table. |
google_cloud_resource |
Google Cloud resource name of the external table. |
data_catalog_entry |
Name of the Data Catalog entry representing the external table. |
DataplexFilesetSpec
Entry specyfication for a Dataplex fileset.
Fields | |
---|---|
dataplex_spec |
Common Dataplex fields. |
DataplexSpec
Common Dataplex fields.
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. |
data_format |
Format of the data. |
compression_format |
Compression format of the data, e.g., zip, gzip etc. |
project_id |
Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. |
DataplexTableSpec
Entry specification for a Dataplex table.
Fields | |
---|---|
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. |
dataplex_spec |
Common Dataplex fields. |
user_managed |
Indicates if the table schema is managed by the user or not. |
DeleteEntryGroupRequest
Request message for DeleteEntryGroup
.
Fields | |
---|---|
name |
Required. The name of the entry group to delete. |
force |
Optional. If true, deletes all entries in the entry group. |
DeleteEntryRequest
Request message for DeleteEntry
.
Fields | |
---|---|
name |
Required. The name of the entry to delete. |
DeletePolicyTagRequest
Request message for DeletePolicyTag
.
Fields | |
---|---|
name |
Required. Resource name of the policy tag to delete. Note: All of its descendant policy tags are also deleted. Authorization requires the following IAM permission on the specified resource
|
DeleteTagRequest
Request message for DeleteTag
.
Fields | |
---|---|
name |
Required. The name of the tag to delete. |
DeleteTagTemplateFieldRequest
Request message for DeleteTagTemplateField
.
Fields | |
---|---|
name |
Required. The name of the tag template field to delete. |
force |
Required. If true, deletes this field from any tags that use it. Currently, |
DeleteTagTemplateRequest
Request message for DeleteTagTemplate
.
Fields | |
---|---|
name |
Required. The name of the tag template to delete. |
force |
Required. If true, deletes all tags that use this template. Currently, |
DeleteTaxonomyRequest
Request message for DeleteTaxonomy
.
Fields | |
---|---|
name |
Required. Resource name of the taxonomy to delete. Note: All policy tags in this taxonomy are also deleted. Authorization requires the following IAM permission on the specified resource
|
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
.
Fields | |
---|---|
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. |
linked_resource |
The resource this metadata entry refers to. For Google Cloud Platform resources,
Output only when the entry is one of the types in the For entries with a 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. |
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 afterwards. Can be used for search and lookup of the entries. FQNs take two forms:
Example for a DPMS table:
|
display_name |
Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. |
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. |
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 |
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. |
Union field entry_type . Required. Entry type. entry_type can be only one of the following: |
|
type |
The type of the entry. Only used for entries with types listed in the Currently, only |
user_specified_type |
Custom entry type that doesn't match any of the values allowed for input and listed in the 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, The
|
Union field system . The source system of the entry. system can be only one of the following: |
|
integrated_system |
Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. |
user_specified_system |
Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The
|
Union field system_spec . System specification. Can be used as a complement for spec , when some metadata is relevant for all entries existing within given system system_spec can be only one of the following: |
|
sql_database_system_spec |
Specification that applies to a relational database system. Only settable when |
looker_system_spec |
Specification that applies to Looker sysstem. Only settable when |
Union field type_spec . Type specification. type_spec can be only one of the following: |
|
gcs_fileset_spec |
Specification that applies to a Cloud Storage fileset. Valid only for entries with the |
bigquery_table_spec |
Output only. Specification that applies to a BigQuery table. Valid only for entries with the |
bigquery_date_sharded_spec |
Output only. Specification for a group of BigQuery tables with the For more information, see Introduction to partitioned tables. |
Union field When extending the API with new types and systems, use this field instead of the legacy |
|
database_table_spec |
Specification that applies to a table resource. Valid only for entries with the |
data_source_connection_spec |
Specification that applies to a data source connection. Valid only for entries with the |
routine_spec |
Specification that applies to a user-defined function or procedure. Valid only for entries with the |
fileset_spec |
Specification that applies to a fileset resource. Valid only for entries with the |
EntryGroup
Entry group metadata.
An EntryGroup
resource represents a logical grouping of zero or more Data Catalog Entry
resources.
Fields | |
---|---|
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. |
display_name |
A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. |
description |
Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. |
data_catalog_timestamps |
Output only. Timestamps of the entry group. Default value is empty. |
EntryOverview
Entry overview fields for rich text descriptions of entries.
Fields | |
---|---|
overview |
Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. 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. |
EntryType
The enum field that lists all the types of entry resources in Data Catalog. For example, a BigQuery table entry has the TABLE
type.
Enums | |
---|---|
ENTRY_TYPE_UNSPECIFIED |
Default unknown type. |
TABLE |
The entry type that has a GoogleSQL schema, including logical views. |
MODEL |
Output only. The type of models. For more information, see Supported models in BigQuery ML. |
DATA_STREAM |
An entry type for streaming entries. For example, a Pub/Sub topic. |
FILESET |
An entry type for a set of files or objects. For example, a Cloud Storage fileset. |
CLUSTER |
A group of servers that work together. For example, a Kafka cluster. |
DATABASE |
A database. |
DATA_SOURCE_CONNECTION |
Output only. Connection to a data source. For example, a BigQuery connection. |
ROUTINE |
Output only. Routine, for example, a BigQuery routine. |
LAKE |
A Dataplex lake. |
ZONE |
A Dataplex zone. |
SERVICE |
A service, for example, a Dataproc Metastore service. |
DATABASE_SCHEMA |
Schema within a relational database. |
DASHBOARD |
A Dashboard, for example from Looker. |
EXPLORE |
A Looker Explore. For more information, see Looker Explore API. |
LOOK |
A Looker Look. For more information, see Looker Look API. |
ExportTaxonomiesRequest
Request message for ExportTaxonomies
.
Fields | |
---|---|
parent |
Required. Resource name of the project that the exported taxonomies belong to. Authorization requires the following IAM permission on the specified resource
|
|