API documentation for datacatalog_v1beta1.types
module.
Classes
AuditConfig
API documentation for datacatalog_v1beta1.types.AuditConfig
class.
AuditConfigDelta
API documentation for datacatalog_v1beta1.types.AuditConfigDelta
class.
AuditLogConfig
API documentation for datacatalog_v1beta1.types.AuditLogConfig
class.
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
Output only. The table name prefix of the shards. The name of
any given shard is [table_prefix]YYYYMMDD
, for example,
for shard MyTable20180101
, the table_prefix
is
MyTable
.
BigQueryTableSpec
Describes a BigQuery table.
Output only.
Spec of a BigQuery table. This field should only be populated
if table_source_type
is BIGQUERY_TABLE
.
Binding
API documentation for datacatalog_v1beta1.types.Binding
class.
BindingDelta
API documentation for datacatalog_v1beta1.types.BindingDelta
class.
ColumnSchema
Representation of a column within a schema. Columns could be nested inside other columns.
Required. Type of the column.
Optional. A column's mode indicates whether the values in this
column are required, nullable, etc. Only NULLABLE
,
REQUIRED
and REPEATED
are supported. Default mode is
NULLABLE
.
CreateEntryGroupRequest
Request message for CreateEntryGroup.
Required. The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.
CreateEntryRequest
Request message for CreateEntry.
Required. The id of the entry to create.
CreatePolicyTagRequest
Request message for CreatePolicyTag.
The policy tag to be created. The name, and taxonomy_display_name field must be left blank. The display_name field is mandatory and must not be duplicated with existing policy tags in the same taxonomy.
CreateTagRequest
Request message for CreateTag.
Required. The tag to create.
CreateTagTemplateFieldRequest
Request message for CreateTagTemplateField.
Required. The ID of the tag template field to create. 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.
CreateTagTemplateRequest
Request message for CreateTagTemplate.
Required. The id of the tag template to create.
CreateTaxonomyRequest
Request message for CreateTaxonomy.
The taxonomy to be created. The name field must be left blank. The display_name field is mandatory.
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.
Required. Currently, this field must always be set to
true
. This confirms the deletion of this field from any
tags using this field. force = false
will be supported in
the future.
DeleteTagTemplateRequest
Request message for DeleteTagTemplate.
Required. Currently, this field must always be set to
true
. This confirms the deletion of any possible tags
using this template. force = false
will be supported in
the future.
DeleteTaxonomyRequest
Request message for DeleteTaxonomy.
Empty
API documentation for datacatalog_v1beta1.types.Empty
class.
Entry
Entry Metadata. A Data Catalog Entry resource represents another
resource in Google Cloud Platform, such as a BigQuery dataset or a Cloud
Pub/Sub topic. 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.
Output only. The resource this metadata entry refers to. For
Google Cloud Platform resources, linked_resource
is the
full name of the resource <https://cloud.google.com/apis/desi
gn/resource_names#full_resource_name>
__. For example, the
linked_resource
for a table resource from BigQuery is: -
//bigquery.googleapis.com/projects/projectId/datasets/datasetI
d/tables/tableId
The type of the entry.
Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
Specification for a group of BigQuery tables with name pattern
[prefix]YYYYMMDD
. Context:
https://cloud.google.com/bigquery/docs/partitioned-
tables#partitioning_versus_sharding.
Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
Output only. Timestamps about the underlying Google Cloud Platform resource, not about this Data Catalog Entry.
EntryGroup
EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.
A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
Output only. Timestamps about this EntryGroup. Default value is empty timestamps.
ExportTaxonomiesRequest
Request message for ExportTaxonomies.
Required. Resource names of the taxonomies to be exported.
Export taxonomies as serialized taxonomies.
ExportTaxonomiesResponse
Response message for ExportTaxonomies.
Expr
API documentation for datacatalog_v1beta1.types.Expr
class.
FieldMask
API documentation for datacatalog_v1beta1.types.FieldMask
class.
FieldType
Represents primitive types - string, bool etc.
GcsFileSpec
Specifications of a single file in Cloud Storage.
Output only. Timestamps about the Cloud Storage file.
GcsFilesetSpec
Describes a Cloud Storage fileset entry.
Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.
GetEntryGroupRequest
Request message for GetEntryGroup.
The fields to return. If not set or empty, all fields are returned.
GetEntryRequest
Request message for GetEntry.
GetIamPolicyRequest
API documentation for datacatalog_v1beta1.types.GetIamPolicyRequest
class.
GetPolicyOptions
API documentation for datacatalog_v1beta1.types.GetPolicyOptions
class.
GetPolicyTagRequest
Request message for GetPolicyTag.
GetTagTemplateRequest
Request message for GetTagTemplate.
GetTaxonomyRequest
Request message for GetTaxonomy.
ImportTaxonomiesRequest
Request message for ImportTaxonomies.
Required. Source taxonomies to be imported in a tree structure.
ImportTaxonomiesResponse
Response message for ImportTaxonomies.
InlineSource
Inline source used for taxonomies import.
ListPolicyTagsRequest
Request message for ListPolicyTags.
The maximum number of items to return. If not set, defaults to 50.
ListPolicyTagsResponse
Response message for ListPolicyTags.
Token to retrieve the next page of results, or empty if there are no more results in the list.
ListTagsRequest
Request message for ListTags.
The maximum number of tags to return. Default is 10. Max limit is 1000.
ListTagsResponse
Response message for ListTags.
Token to retrieve the next page of results. It is set to empty if no items remain in results.
ListTaxonomiesRequest
Request message for ListTaxonomies.
The maximum number of items to return. If not set, defaults to 50.
ListTaxonomiesResponse
Response message for ListTaxonomies.
Token to retrieve the next page of results, or empty if there are no more results in the list.
LookupEntryRequest
Request message for LookupEntry.
The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/d esign/resource_names#full_resource_name. Full names are case-sensitive. Examples: - //bigquery.googleapis.com/proje cts/projectId/datasets/datasetId/tables/tableId - //pubsub.googleapis.com/projects/projectId/topics/topicId
Policy
API documentation for datacatalog_v1beta1.types.Policy
class.
PolicyDelta
API documentation for datacatalog_v1beta1.types.PolicyDelta
class.
PolicyTag
Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierachy: Geolocation | ------------------------------------ | | | LatLong City ZipCode PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode".
Required. Human readable name of this policy tag. Max 200 bytes when encoded in UTF-8.
Resource name of the parent policy tag to this policy tag (e.g. for policy tag "LatLong" in the example above, this field contains the resource name of policy tag "Geolocation"). If empty, it means this policy tag is a top level policy tag (e.g. this field is empty for policy tag "Geolocation" in the example above). If not set, defaults to an empty string.
RenameTagTemplateFieldRequest
Request message for RenameTagTemplateField.
Required. The new ID of this tag template field. For example,
my_new_field
.
Schema
Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
SearchCatalogRequest
Request message for SearchCatalog.
Required. The query string in search query syntax. The query
must be non-empty. Query strings can be simple as "x" or more
qualified as: - name:x - column:x - description:y Note:
Query tokens need to have a minimum of 3 characters for
substring matching to work correctly. See Data Catalog Search
Syntax </data-catalog/docs/how-to/search-reference>
__ for
more information.
Optional. Pagination token returned in an earlier [SearchCatal ogResponse.next_page_token][google.cloud.datacatalog.v1beta1 .SearchCatalogResponse.next_page_token], which indicates that this is a continuation of a prior [SearchCatalogRequest][ google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data. If empty, the first page is returned.
SearchCatalogResponse
Response message for SearchCatalog.
The token that can be used to retrieve the next page of results.
SearchCatalogResult
A result that appears in the response of a search request. Each result captures details of one entry that matches the search.
Sub-type of the search result. This is a dot-delimited
description of the resource's full type, and is the same as
the value callers would provide in the "type" search facet.
Examples: entry.table
, entry.dataStream
,
tagTemplate
.
The full name of the cloud resource the entry belongs to. See:
https://cloud.google.com/apis/design/resource_names#full_res
ource_name. Example: - //bigquery.googleapis.com/projects
/projectId/datasets/datasetId/tables/tableId
SerializedPolicyTag
Message representing one policy tag when exported as a nested proto.
Description of the serialized policy tag. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
SerializedTaxonomy
Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.
Description of the serialized taxonomy. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
SetIamPolicyRequest
API documentation for datacatalog_v1beta1.types.SetIamPolicyRequest
class.
SystemTimestamps
Timestamps about this resource according to a particular system.
The last-modified time of the resource within the given system.
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 </data-catalog/docs/concepts/iam>
__ for
information on the permissions needed to create or view tags.
Required. The resource name of the tag template that this tag uses. Example: - projects/{project_id}/locations/{location} /tagTemplates/{tag_template_id} This field cannot be modified after creation.
The scope within the parent resource that this tag is attached to. If not provided, the tag is attached to the parent resource itself. Deleting the scope from the parent resource will delete all tags attached to that scope. These fields cannot be updated after creation.
Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.
TagField
Contains the value and supporting information for a field within a Tag.
Required. The value of this field.
Holds the value for a tag field with string type.
Holds the value for a tag field with timestamp type.
TagTemplate
A tag template defines the schema of the tags used to attach to Data Catalog resources. It defines the mapping of accepted field names and types that can be used within the tag. The tag template also controls the access to the tag.
The display name for this template. Defaults to an empty string.
TagTemplateField
The template for an individual field within a tag template.
The display name for this field. Defaults to an empty string.
Taxonomy
A taxonomy is a collection of policy tags of business significance, typically associated with the substance of the policy tag (e.g. credit card, SSN), or how it is used (e.g. account name, user ID).
Required. Human readable name of this taxonomy. Max 200 bytes when encoded in UTF-8.
Optional. A list of policy types that are activated for the taxonomy. If not set, defaults to an empty list of activated policy types.
TestIamPermissionsRequest
API documentation for datacatalog_v1beta1.types.TestIamPermissionsRequest
class.
TestIamPermissionsResponse
API documentation for datacatalog_v1beta1.types.TestIamPermissionsResponse
class.
Timestamp
API documentation for datacatalog_v1beta1.types.Timestamp
class.
UpdateEntryRequest
Request message for UpdateEntry.
The fields to update on the entry. If absent or empty, all
modifiable fields are updated. The following fields are
modifiable: * For entries with type DATA_STREAM
: *
schema
* For entries with type FILESET
* schema
* display_name
* description
* gcs_fileset_spec
* gcs_fileset_spec.file_patterns
UpdatePolicyTagRequest
Request message for UpdatePolicyTag.
The update mask applies to the resource. Only display_name,
description and parent_policy_tag can be updated and thus
can be listed in the mask. If update_mask is not provided,
all allowed fields (i.e. display_name, description and
parent) will be updated. For more information including the
FieldMask
definition, see
https://developers.google.com/protocol-
buffers/docs/reference/google.protobuf#fieldmask If not set,
defaults to all of the fields that are allowed to update.
UpdateTagRequest
Request message for UpdateTag.
The fields to update on the Tag. If absent or empty, all
modifiable fields are updated. Currently the only modifiable
field is the field fields
.
UpdateTagTemplateFieldRequest
Request message for UpdateTagTemplateField.
Required. The template to update.
UpdateTagTemplateRequest
Request message for UpdateTagTemplate.
The field mask specifies the parts of the template to
overwrite. Allowed fields: - display_name
If absent or
empty, all of the allowed fields above will be updated.
UpdateTaxonomyRequest
Request message for UpdateTaxonomy.
The update mask applies to the resource. For the FieldMask
definition, see https://developers.google.com/protocol-
buffers/docs/reference/google.protobuf#fieldmask If not set,
defaults to all of the fields that are allowed to update.
ViewSpec
Table view specification.