Module types (0.4.0)

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.

CreateEntryRequest

Request message for CreateEntry.

Required. The id of the entry to create.

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.

DeleteEntryGroupRequest

Request message for DeleteEntryGroup.

DeleteEntryRequest

Request message for DeleteEntry.

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.

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.

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 GCS.

Output only. Timestamps about the GCS 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.

GetTagTemplateRequest

Request message for GetTagTemplate.

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.

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.

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

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.

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.

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