Classes
BigQueryConnectionSpec
Specification for the BigQuery connection.
BigQueryConnectionSpec.Types
Container for nested types declared in the BigQueryConnectionSpec message type.
BigQueryDateShardedSpec
Specification for a group of BigQuery tables with the [prefix]YYYYMMDD
name
pattern.
For more information, see Introduction to partitioned tables.
BigQueryRoutineSpec
Fields specific for BigQuery routines.
BigQueryTableSpec
Describes a BigQuery table.
CloudSqlBigQueryConnectionSpec
Specification for the BigQuery connection to a Cloud SQL instance.
CloudSqlBigQueryConnectionSpec.Types
Container for nested types declared in the CloudSqlBigQueryConnectionSpec message type.
ColumnSchema
A column within a schema. Columns can be nested inside other columns.
CreateEntryGroupRequest
Request message for [CreateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup].
CreateEntryRequest
Request message for [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry].
CreatePolicyTagRequest
Request message for [CreatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag].
CreateTagRequest
Request message for [CreateTag][google.cloud.datacatalog.v1.DataCatalog.CreateTag].
CreateTagTemplateFieldRequest
Request message for [CreateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField].
CreateTagTemplateRequest
Request message for [CreateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate].
CreateTaxonomyRequest
Request message for [CreateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy].
CrossRegionalSource
Cross-regional source used to import an existing taxonomy into a different region.
DatabaseTableSpec
Specification that applies to a table resource. Valid only
for entries with the TABLE
type.
DatabaseTableSpec.Types
Container for nested types declared in the DatabaseTableSpec message type.
DataCatalog
Data Catalog API service allows you to discover, understand, and manage your data.
DataCatalog.DataCatalogBase
Base class for server-side implementations of DataCatalog
DataCatalog.DataCatalogClient
Client for DataCatalog
DataCatalogClient
DataCatalog client wrapper, for convenient use.
DataCatalogClientBuilder
Builder class for DataCatalogClient to provide simple configuration of credentials, endpoint etc.
DataCatalogClientImpl
DataCatalog client wrapper implementation, for convenient use.
DataCatalogSettings
Settings for DataCatalogClient instances.
DataSource
Physical location of an entry.
DataSource.Types
Container for nested types declared in the DataSource message type.
DataSourceConnectionSpec
Specification that applies to a data source connection. Valid only for
entries with the DATA_SOURCE_CONNECTION
type.
DeleteEntryGroupRequest
Request message for [DeleteEntryGroup][google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup].
DeleteEntryRequest
Request message for [DeleteEntry][google.cloud.datacatalog.v1.DataCatalog.DeleteEntry].
DeletePolicyTagRequest
Request message for [DeletePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag].
DeleteTagRequest
Request message for [DeleteTag][google.cloud.datacatalog.v1.DataCatalog.DeleteTag].
DeleteTagTemplateFieldRequest
Request message for [DeleteTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField].
DeleteTagTemplateRequest
Request message for [DeleteTagTemplate][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate].
DeleteTaxonomyRequest
Request message for [DeleteTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy].
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][google.cloud.datacatalog.v1.Tag].
EntryGroup
Entry group metadata.
An EntryGroup
resource represents a logical grouping of zero or more
Data Catalog [Entry][google.cloud.datacatalog.v1.Entry] resources.
EntryGroupName
Resource name for the EntryGroup
resource.
EntryName
Resource name for the Entry
resource.
ExportTaxonomiesRequest
Request message for [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].
ExportTaxonomiesResponse
Response message for [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].
FieldType
FieldType.Types
Container for nested types declared in the FieldType message type.
FieldType.Types.EnumType
FieldType.Types.EnumType.Types
Container for nested types declared in the EnumType message type.
FieldType.Types.EnumType.Types.EnumValue
GcsFilesetSpec
Describes a Cloud Storage fileset entry.
GcsFileSpec
Specification of a single file in Cloud Storage.
GetEntryGroupRequest
Request message for [GetEntryGroup][google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup].
GetEntryRequest
Request message for [GetEntry][google.cloud.datacatalog.v1.DataCatalog.GetEntry].
GetPolicyTagRequest
Request message for [GetPolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag].
GetTagTemplateRequest
Request message for [GetTagTemplate][google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate].
GetTaxonomyRequest
Request message for [GetTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy].
ImportTaxonomiesRequest
Request message for [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].
ImportTaxonomiesResponse
Response message for [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].
InlineSource
Inline source containing taxonomies to import.
ListEntriesRequest
Request message for [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].
ListEntriesResponse
Response message for [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].
ListEntryGroupsRequest
Request message for [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
ListEntryGroupsResponse
Response message for [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
ListPolicyTagsRequest
Request message for [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].
ListPolicyTagsResponse
Response message for [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].
ListTagsRequest
Request message for [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
ListTagsResponse
Response message for [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
ListTaxonomiesRequest
Request message for [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].
ListTaxonomiesResponse
Response message for [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].
LookupEntryRequest
Request message for [LookupEntry][google.cloud.datacatalog.v1.DataCatalog.LookupEntry].
PolicyTag
Denotes one policy tag in a taxonomy, for example, SSN.
Policy tags can be defined in a hierarchy. For example:
+ Geolocation
+ LatLong
+ City
+ ZipCode
Where the "Geolocation" policy tag contains three children.
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.
PolicyTagManager.PolicyTagManagerBase
Base class for server-side implementations of PolicyTagManager
PolicyTagManager.PolicyTagManagerClient
Client for PolicyTagManager
PolicyTagManagerClient
PolicyTagManager client wrapper, for convenient use.
PolicyTagManagerClientBuilder
Builder class for PolicyTagManagerClient to provide simple configuration of credentials, endpoint etc.
PolicyTagManagerClientImpl
PolicyTagManager client wrapper implementation, for convenient use.
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.
PolicyTagManagerSerialization.PolicyTagManagerSerializationBase
Base class for server-side implementations of PolicyTagManagerSerialization
PolicyTagManagerSerialization.PolicyTagManagerSerializationClient
Client for PolicyTagManagerSerialization
PolicyTagManagerSerializationClient
PolicyTagManagerSerialization client wrapper, for convenient use.
PolicyTagManagerSerializationClientBuilder
Builder class for PolicyTagManagerSerializationClient to provide simple configuration of credentials, endpoint etc.
PolicyTagManagerSerializationClientImpl
PolicyTagManagerSerialization client wrapper implementation, for convenient use.
PolicyTagManagerSerializationSettings
Settings for PolicyTagManagerSerializationClient instances.
PolicyTagManagerSettings
Settings for PolicyTagManagerClient instances.
PolicyTagName
Resource name for the PolicyTag
resource.
RenameTagTemplateFieldEnumValueRequest
Request message for [RenameTagTemplateFieldEnumValue][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue].
RenameTagTemplateFieldRequest
Request message for [RenameTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField].
ReplaceTaxonomyRequest
Request message for [ReplaceTaxonomy][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy].
RoutineSpec
Specification that applies to a routine. Valid only for
entries with the ROUTINE
type.
RoutineSpec.Types
Container for nested types declared in the RoutineSpec message type.
RoutineSpec.Types.Argument
Input or output argument of a function or stored procedure.
RoutineSpec.Types.Argument.Types
Container for nested types declared in the Argument message type.
Schema
Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
SearchCatalogRequest
Request message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
SearchCatalogRequest.Types
Container for nested types declared in the SearchCatalogRequest message type.
SearchCatalogRequest.Types.Scope
The criteria that select the subspace used for query matching.
SearchCatalogResponse
Response message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
SearchCatalogResult
Result in the response to a search request.
Each result captures details of one entry that matches the search.
SerializedPolicyTag
A nested protocol buffer that represents a policy tag and all its descendants.
SerializedTaxonomy
A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.
SystemTimestamps
Timestamps associated with this resource in a particular system.
TableSpec
Normal BigQuery table specification.
Tag
Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template.
See Data Catalog IAM for information on the permissions needed to create or view tags.
TagField
Contains the value and additional information on a field within a [Tag][google.cloud.datacatalog.v1.Tag].
TagField.Types
Container for nested types declared in the TagField message type.
TagField.Types.EnumValue
An enum value.
TagName
Resource name for the Tag
resource.
TagTemplate
A tag template defines a tag that can have one or more typed fields.
The template is used to create tags that are attached to GCP resources. Tag template roles provide permissions to create, edit, and use the template. For example, see the TagTemplate User role that includes a permission to use the tag template to tag resources.
TagTemplateField
The template for an individual field within a tag template.
TagTemplateFieldEnumValueName
Resource name for the TagTemplateFieldEnumValue
resource.
TagTemplateFieldName
Resource name for the TagTemplateField
resource.
TagTemplateName
Resource name for the TagTemplate
resource.
Taxonomy
A taxonomy is a collection of hierarchical policy tags that classify data along a common axis.
For example, a "data sensitivity" taxonomy might contain the following policy tags:
+ PII
+ Account number
+ Age
+ SSN
+ Zipcode
+ Financials
+ Revenue
A "data origin" taxonomy might contain the following policy tags:
+ User data
+ Employee data
+ Partner data
+ Public data
Taxonomy.Types
Container for nested types declared in the Taxonomy message type.
TaxonomyName
Resource name for the Taxonomy
resource.
UpdateEntryGroupRequest
Request message for [UpdateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup].
UpdateEntryRequest
Request message for [UpdateEntry][google.cloud.datacatalog.v1.DataCatalog.UpdateEntry].
UpdatePolicyTagRequest
Request message for [UpdatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag].
UpdateTagRequest
Request message for [UpdateTag][google.cloud.datacatalog.v1.DataCatalog.UpdateTag].
UpdateTagTemplateFieldRequest
Request message for [UpdateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField].
UpdateTagTemplateRequest
Request message for [UpdateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate].
UpdateTaxonomyRequest
Request message for [UpdateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy].
UsageSignal
The set of all usage signals that Data Catalog stores.
Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.
UsageStats
Detailed statistics on the entry's usage.
Usage statistics have the following limitations:
- Only BigQuery tables have them.
- They only include BigQuery query jobs.
- They might be underestimated because wildcard table references are not yet counted. For more information, see Querying multiple tables using a wildcard table
ViewSpec
Table view specification.
Enums
BigQueryConnectionSpec.ConnectionSpecOneofCase
Enum of possible cases for the "connection_spec" oneof.
BigQueryConnectionSpec.Types.ConnectionType
The type of the BigQuery connection.
BigQueryTableSpec.TypeSpecOneofCase
Enum of possible cases for the "type_spec" oneof.
CloudSqlBigQueryConnectionSpec.Types.DatabaseType
Supported Cloud SQL database types.
DatabaseTableSpec.Types.TableType
Type of the table.
DataSource.Types.Service
Name of a service that stores the data.
Entry.EntryTypeOneofCase
Enum of possible cases for the "entry_type" oneof.
Entry.SpecOneofCase
Enum of possible cases for the "spec" oneof.
Entry.SystemOneofCase
Enum of possible cases for the "system" oneof.
Entry.TypeSpecOneofCase
Enum of possible cases for the "type_spec" oneof.
EntryGroupName.ResourceNameType
The possible contents of EntryGroupName.
EntryName.ResourceNameType
The possible contents of EntryName.
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.
ExportTaxonomiesRequest.DestinationOneofCase
Enum of possible cases for the "destination" oneof.
FieldType.TypeDeclOneofCase
Enum of possible cases for the "type_decl" oneof.
FieldType.Types.PrimitiveType
ImportTaxonomiesRequest.SourceOneofCase
Enum of possible cases for the "source" oneof.
IntegratedSystem
This enum lists all the systems that Data Catalog integrates with.
LookupEntryRequest.TargetNameOneofCase
Enum of possible cases for the "target_name" oneof.
PolicyTagName.ResourceNameType
The possible contents of PolicyTagName.
RoutineSpec.SystemSpecOneofCase
Enum of possible cases for the "system_spec" oneof.
RoutineSpec.Types.Argument.Types.Mode
The input or output mode of the argument.
RoutineSpec.Types.RoutineType
The fine-grained type of the routine.
SearchCatalogResult.SystemOneofCase
Enum of possible cases for the "system" oneof.
SearchResultType
The resource types that can be returned in search results.
TableSourceType
Table source type.
Tag.ScopeOneofCase
Enum of possible cases for the "scope" oneof.
TagField.KindOneofCase
Enum of possible cases for the "kind" oneof.
TagName.ResourceNameType
The possible contents of TagName.
TagTemplateFieldEnumValueName.ResourceNameType
The possible contents of TagTemplateFieldEnumValueName.
TagTemplateFieldName.ResourceNameType
The possible contents of TagTemplateFieldName.
TagTemplateName.ResourceNameType
The possible contents of TagTemplateName.
Taxonomy.Types.PolicyType
Defines policy types where the policy tags can be used for.
TaxonomyName.ResourceNameType
The possible contents of TaxonomyName.