API documentation for datacatalog_v1beta1.types
package.
Classes
BigQueryDateShardedSpec
Spec for a group of BigQuery tables with name pattern
[prefix]YYYYMMDD
. Context:
https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding
BigQueryTableSpec
Describes a BigQuery table.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ColumnSchema
Representation of a column within a schema. Columns could be nested inside other columns.
CreateEntryGroupRequest
Request message for CreateEntryGroup.
CreateEntryRequest
Request message for CreateEntry.
CreatePolicyTagRequest
Request message for CreatePolicyTag.
CreateTagRequest
Request message for CreateTag.
CreateTagTemplateFieldRequest
Request message for CreateTagTemplateField.
CreateTagTemplateRequest
Request message for CreateTagTemplate.
CreateTaxonomyRequest
Request message for CreateTaxonomy.
DeleteEntryGroupRequest
Request message for DeleteEntryGroup.
DeleteEntryRequest
Request message for DeleteEntry.
DeletePolicyTagRequest
Request message for DeletePolicyTag.
DeleteTagRequest
Request message for DeleteTag.
DeleteTagTemplateFieldRequest
Request message for DeleteTagTemplateField.
DeleteTagTemplateRequest
Request message for DeleteTagTemplate.
DeleteTaxonomyRequest
Request message for DeleteTaxonomy.
Entry
Entry Metadata. A Data Catalog Entry resource represents another
resource in Google Cloud Platform (such as a BigQuery dataset or a
Pub/Sub topic), or outside of Google Cloud Platform. Clients can use
the linked_resource
field in the Entry resource to refer to the
original resource ID of the source system.
An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
EntryGroup
EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.
EntryType
Entry resources in Data Catalog can be of different types e.g. a
BigQuery Table entry is of type TABLE
. This enum describes all
the possible types Data Catalog contains.
Values: ENTRY_TYPE_UNSPECIFIED (0): Default unknown type. TABLE (2): Output only. The type of entry that has a GoogleSQL schema, including logical views. MODEL (5): Output only. The type of models. https://cloud.google.com/bigquery-ml/docs/bigqueryml-intro DATA_STREAM (3): Output only. An entry type which is used for streaming entries. Example: Pub/Sub topic. FILESET (4): An entry type which is a set of files or objects. Example: Cloud Storage fileset.
ExportTaxonomiesRequest
Request message for ExportTaxonomies.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExportTaxonomiesResponse
Response message for ExportTaxonomies.
FieldType
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GcsFileSpec
Specifications of a single file in Cloud Storage.
GcsFilesetSpec
Describes a Cloud Storage fileset entry.
GetEntryGroupRequest
Request message for GetEntryGroup.
GetEntryRequest
Request message for GetEntry.
GetPolicyTagRequest
Request message for GetPolicyTag.
GetTagTemplateRequest
Request message for GetTagTemplate.
GetTaxonomyRequest
Request message for GetTaxonomy.
ImportTaxonomiesRequest
Request message for ImportTaxonomies.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportTaxonomiesResponse
Response message for ImportTaxonomies.
InlineSource
Inline source used for taxonomies import.
ListEntriesRequest
Request message for ListEntries.
ListEntriesResponse
Response message for ListEntries.
ListEntryGroupsRequest
Request message for ListEntryGroups.
ListEntryGroupsResponse
Response message for ListEntryGroups.
ListPolicyTagsRequest
Request message for ListPolicyTags.
ListPolicyTagsResponse
Response message for ListPolicyTags.
ListTagsRequest
Request message for ListTags.
ListTagsResponse
Response message for ListTags.
ListTaxonomiesRequest
Request message for ListTaxonomies.
ListTaxonomiesResponse
Response message for ListTaxonomies.
LookupEntryRequest
Request message for LookupEntry.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PolicyTag
Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy:
Geolocation -> (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode".
RenameTagTemplateFieldEnumValueRequest
Request message for RenameTagTemplateFieldEnumValue.
RenameTagTemplateFieldRequest
Request message for RenameTagTemplateField.
Schema
Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
SearchCatalogRequest
Request message for SearchCatalog.
SearchCatalogResponse
Response message for SearchCatalog.
SearchCatalogResult
A result that appears in the response of a search request. Each result captures details of one entry that matches the search.
SearchResultType
The different types of resources that can be returned in search.
Values: SEARCH_RESULT_TYPE_UNSPECIFIED (0): Default unknown type. ENTRY (1): An Entry. TAG_TEMPLATE (2): A TagTemplate. ENTRY_GROUP (3): An EntryGroup.
SerializedPolicyTag
Message representing one policy tag when exported as a nested proto.
SerializedTaxonomy
Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.
SystemTimestamps
Timestamps about this resource according to a particular system.
TableSourceType
Table source type.
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.
TableSpec
Normal BigQuery table spec.
Tag
Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template.
See Data Catalog
IAM <https://cloud.google.com/data-catalog/docs/concepts/iam>
__ for
information on the permissions needed to create or view tags.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TagField
Contains the value and supporting information for a field within a Tag.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TagTemplate
A tag template defines a tag, which can have one or more typed
fields. The template is used to create and attach the tag to Google
Cloud resources. Tag template
roles <https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles>
provide permissions to create, edit, and use the template. See, for
example, the TagTemplate
User <https://cloud.google.com/data-catalog/docs/how-to/template-user>
role, which includes permission to use the tag template to tag
resources.
TagTemplateField
The template for an individual field within a tag template.
Taxonomy
A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data sensitivity taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data origin taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.
UpdateEntryGroupRequest
Request message for UpdateEntryGroup.
UpdateEntryRequest
Request message for UpdateEntry.
UpdatePolicyTagRequest
Request message for UpdatePolicyTag.
UpdateTagRequest
Request message for UpdateTag.
UpdateTagTemplateFieldRequest
Request message for UpdateTagTemplateField.
UpdateTagTemplateRequest
Request message for UpdateTagTemplate.
UpdateTaxonomyRequest
Request message for UpdateTaxonomy.
UsageSignal
The set of all usage signals that we store in Data Catalog.
UsageStats
Detailed counts on the entry's usage. Caveats:
- Only BigQuery tables have usage stats
- The usage stats only include BigQuery query jobs
- The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables
ViewSpec
Table view specification.