API documentation for datacatalog_v1.types
package.
Classes
BigQueryConnectionSpec
Specification for the BigQuery connection. .. attribute:: connection_type
The type of the BigQuery connection.
:type: google.cloud.datacatalog_v1.types.BigQueryConnectionSpec.ConnectionType
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. .. attribute:: imported_libraries
Paths of the imported libraries.
:type: Sequence[str]
BigQueryTableSpec
Describes a BigQuery table. .. attribute:: table_source_type
Output only. The table source type.
CloudSqlBigQueryConnectionSpec
Specification for the BigQuery connection to a Cloud SQL instance.
ColumnSchema
A column within a schema. Columns can be nested inside other columns.
CreateEntryGroupRequest
Request message for CreateEntryGroup.
CreateEntryRequest
Request message for CreateEntry.
CreatePolicyTagRequest
Request message for CreatePolicyTag.
CreateTagRequest
Request message for CreateTag.
CreateTagTemplateFieldRequest
Request message for CreateTagTemplateField.
CreateTagTemplateRequest
Request message for CreateTagTemplate.
CreateTaxonomyRequest
Request message for CreateTaxonomy.
CrossRegionalSource
Cross-regional source used to import an existing taxonomy into a different region.
DataSource
Physical location of an entry. .. attribute:: service
Service that physically stores the data.
DataSourceConnectionSpec
Specification that applies to a data source connection. Valid only
for entries with the DATA_SOURCE_CONNECTION
type.
DatabaseTableSpec
Specification that applies to a table resource. Valid only for
entries with the TABLE
type.
DeleteEntryGroupRequest
Request message for DeleteEntryGroup.
DeleteEntryRequest
Request message for DeleteEntry.
DeletePolicyTagRequest
Request message for DeletePolicyTag.
DeleteTagRequest
Request message for DeleteTag.
DeleteTagTemplateFieldRequest
Request message for DeleteTagTemplateField.
DeleteTagTemplateRequest
Request message for DeleteTagTemplate.
DeleteTaxonomyRequest
Request message for DeleteTaxonomy.
Entry
Entry metadata. A Data Catalog entry 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.
EntryGroup
Entry group metadata.
An EntryGroup
resource represents a logical grouping of zero or
more Data Catalog Entry
resources.
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
Request message for ExportTaxonomies.
ExportTaxonomiesResponse
Response message for ExportTaxonomies.
FieldType
GcsFileSpec
Specification of a single file in Cloud Storage. .. attribute:: file_path
Required. Full file path. Example:
gs://bucket_name/a/b.txt
.
:type: str
GcsFilesetSpec
Describes a Cloud Storage fileset entry. .. attribute:: file_patterns
Required. Patterns to identify a set of files in Google Cloud Storage.
For more information, see Wildcard Names.
Note: Currently, bucket wildcards are not supported.
Examples of valid file_patterns
:
gs://bucket_name/dir/*
: matches all files inbucket_name/dir
directorygs://bucket_name/dir/**
: matches all files inbucket_name/dir
and all subdirectoriesgs://bucket_name/file*
: matches files prefixed byfile
inbucket_name
gs://bucket_name/??.txt
: matches files with two characters followed by.txt
inbucket_name
gs://bucket_name/[aeiou].txt
: matches files that contain a single vowel character followed by.txt
inbucket_name
gs://bucket_name/[a-m].txt
: matches files that containa
,b
, ... orm
followed by.txt
inbucket_name
gs://bucket_name/a/*/b
: matches all files inbucket_name
that match thea/*/b
pattern, such asa/c/b
,a/d/b
gs://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: Sequence[str]
GetEntryGroupRequest
Request message for GetEntryGroup.
GetEntryRequest
Request message for GetEntry.
GetPolicyTagRequest
Request message for GetPolicyTag.
GetTagTemplateRequest
Request message for GetTagTemplate.
GetTaxonomyRequest
Request message for GetTaxonomy.
ImportTaxonomiesRequest
Request message for ImportTaxonomies.
ImportTaxonomiesResponse
Response message for ImportTaxonomies.
InlineSource
Inline source containing taxonomies to import. .. attribute:: taxonomies
Required. Taxonomies to import.
:type: Sequence[google.cloud.datacatalog_v1.types.SerializedTaxonomy]
ListEntriesRequest
Request message for ListEntries.
ListEntriesResponse
Response message for ListEntries.
ListEntryGroupsRequest
Request message for ListEntryGroups.
ListEntryGroupsResponse
Response message for ListEntryGroups.
ListPolicyTagsRequest
Request message for ListPolicyTags.
ListPolicyTagsResponse
Response message for ListPolicyTags.
ListTagsRequest
Request message for ListTags.
ListTagsResponse
Response message for ListTags.
ListTaxonomiesRequest
Request message for ListTaxonomies.
ListTaxonomiesResponse
Response message for ListTaxonomies.
LookupEntryRequest
Request message for LookupEntry.
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.
RenameTagTemplateFieldEnumValueRequest
Request message for RenameTagTemplateFieldEnumValue.
RenameTagTemplateFieldRequest
Request message for RenameTagTemplateField.
ReplaceTaxonomyRequest
Request message for ReplaceTaxonomy.
RoutineSpec
Specification that applies to a routine. Valid only for entries with
the ROUTINE
type.
Schema
Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
SearchCatalogRequest
Request message for SearchCatalog.
SearchCatalogResponse
Response message for SearchCatalog.
SearchCatalogResult
Result in the response to a search request. Each result captures details of one entry that matches the search.
SearchResultType
The resource types that can be returned in search results.
SerializedPolicyTag
A nested protocol buffer that represents a policy tag and all its descendants.
SerializedTaxonomy
A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.
SystemTimestamps
Timestamps associated with this resource in a particular system.
TableSourceType
Table source type.
TableSpec
Normal BigQuery table specification. .. attribute:: grouped_entry
Output only. If the table is date-sharded, that is, it
matches the [prefix]YYYYMMDD
name 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_entry
is empty.
:type: str
Tag
Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template.
See Data Catalog
IAM <https://cloud.google.com/data-catalog/docs/concepts/iam>
__ for
information on the permissions needed to create or view tags.
TagField
Contains the value and additional information on a field within a Tag.
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. .. attribute:: 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: str
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
UpdateEntryGroupRequest
Request message for UpdateEntryGroup.
UpdateEntryRequest
Request message for UpdateEntry.
UpdatePolicyTagRequest
Request message for UpdatePolicyTag.
UpdateTagRequest
Request message for UpdateTag.
UpdateTagTemplateFieldRequest
Request message for UpdateTagTemplateField.
UpdateTagTemplateRequest
Request message for UpdateTagTemplate.
UpdateTaxonomyRequest
Request message for UpdateTaxonomy.
UsageSignal
The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day.
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. .. attribute:: view_query
Output only. The query that defines the table view.
:type: str