package google.cloud.datacatalog.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service DataCatalog
datacatalog.proto:42Data Catalog API service allows clients to discover, understand, and manage their data.
rpc SearchCatalog (, )
datacatalog.proto:62Searches Data Catalog for multiple resources like entries, tags that match a query. This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequentally call `Get` methods. Note that searches do not have full recall. There may be results that match your query but are not returned, even in subsequent pages of results. These missing results may vary across repeated calls to search. Do not rely on this method if you need to guarantee full recall. See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information.
message
datacatalog.proto:404Request message for [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
optional scope = 6
Required. The scope of this search request.
string query = 1
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.
int32 page_size = 2
Number of results in the search page. If <=0 then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.
string page_token = 3
Optional. Pagination token returned in an earlier [SearchCatalogResponse.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.
string order_by = 5
Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports desecending * `last_access_timestamp [asc|desc]`, defaults to descending if not specified * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified If not specified, defaults to `relevance` descending.
message
datacatalog.proto:473Response message for [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
repeated results = 1
Search results.
string next_page_token = 3
The token that can be used to retrieve the next page of results.
rpc CreateEntryGroup (, )
datacatalog.proto:75Alpha feature. Creates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:483Request message for [CreateEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntryGroup].
string parent = 1
Required. The name of the project this entry group is in. Example: * projects/{project_id}/locations/{location} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.
string entry_group_id = 3
Required. The id of the entry group to create.
optional entry_group = 2
The entry group to create. Defaults to an empty entry group.
rpc GetEntryGroup (, )
datacatalog.proto:85Alpha feature. Gets an EntryGroup.
message
datacatalog.proto:506Request message for [GetEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.GetEntryGroup].
string name = 1
Required. The name of the entry group. For example, `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
optional read_mask = 2
The fields to return. If not set or empty, all fields are returned.
rpc DeleteEntryGroup (, )
datacatalog.proto:98Alpha feature. Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:522Request message for [DeleteEntryGroup][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntryGroup].
string name = 1
Required. The name of the entry group. For example, `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
rpc CreateEntry (, )
datacatalog.proto:111Alpha feature. Creates an entry. Currently only entries of 'FILESET' type can be created. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:535Request message for [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry].
string parent = 1
Required. The name of the entry group this entry is in. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
string entry_id = 3
Required. The id of the entry to create.
optional entry = 2
Required. The entry to create.
rpc UpdateEntry (, )
datacatalog.proto:123Updates an existing entry. The user should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:558Request message for [UpdateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntry].
optional entry = 1
Required. The updated entry. The "name" field must be set.
optional update_mask = 2
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`
rpc DeleteEntry (, )
datacatalog.proto:139Alpha feature. Deletes an existing entry. Only entries created through [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:579Request message for [DeleteEntry][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntry].
string name = 1
Required. The name of the entry. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
rpc GetEntry (, )
datacatalog.proto:147Gets an entry.
message
datacatalog.proto:593Request message for [GetEntry][google.cloud.datacatalog.v1beta1.DataCatalog.GetEntry].
string name = 1
Required. The name of the entry. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Entry groups are logical groupings of entries. Currently, users cannot create/modify entry groups. They are created by Data Catalog; they include `@bigquery` for all BigQuery entries, and `@pubsub` for all Cloud Pub/Sub entries.
rpc LookupEntry (, )
datacatalog.proto:157Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.
message
datacatalog.proto:612Request message for [LookupEntry][google.cloud.datacatalog.v1beta1.DataCatalog.LookupEntry].
oneof target_name
Required. Represents either the Google Cloud Platform resource or SQL name for a Google Cloud Platform resource.
string linked_resource = 1
The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Full names are case-sensitive. Examples: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId * //pubsub.googleapis.com/projects/projectId/topics/topicId
string sql_resource = 3
The SQL name of the entry. SQL names are case-sensitive. Examples: * `cloud_pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.project_id.dataset_id.table_id` * `datacatalog.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:751Request message for [CreateTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplate].
string parent = 1
Required. The name of the project and the location this template is in. Example: * projects/{project_id}/locations/{location} TagTemplate and its child resources may not actually be stored in the location in this name.
string tag_template_id = 3
Required. The id of the tag template to create.
optional tag_template = 2
Required. The tag template to create.
rpc GetTagTemplate (, )
datacatalog.proto:177Gets a tag template.
message
datacatalog.proto:775Request message for [GetTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.GetTagTemplate].
string name = 1
Required. The name of the tag template. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. The user should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:809Request message for [UpdateTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplate].
optional tag_template = 1
Required. The template to update. The "name" field must be set.
optional update_mask = 2
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.
Deletes a tag template and all tags using the template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:825Request message for [DeleteTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplate].
string name = 1
Required. The name of the tag template to delete. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
bool force = 2
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.
Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:888Request message for [CreateTagTemplateField][google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplateField].
string parent = 1
Required. The name of the project this template is in. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplateField may not actually be stored in the location in this name.
string tag_template_field_id = 2
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.
optional tag_template_field = 3
Required. The tag template field to create.
Updates a field in a tag template. This method cannot be used to update the field type. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:916Request message for [UpdateTagTemplateField][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplateField].
string name = 1
Required. The name of the tag template field. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
optional tag_template_field = 2
Required. The template to update.
optional update_mask = 3
The field mask specifies the parts of the template to be updated. Allowed fields: * `display_name` * `type.enum_type` If `update_mask` is not set or empty, all of the allowed fields above will be updated. When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed.
Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project](/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:948Request message for [RenameTagTemplateField][google.cloud.datacatalog.v1beta1.DataCatalog.RenameTagTemplateField].
string name = 1
Required. The name of the tag template. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
string new_tag_template_field_id = 2
Required. The new ID of this tag template field. For example, `my_new_field`.
Deletes a field in a tag template and all uses of that field. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
message
datacatalog.proto:966Request message for [DeleteTagTemplateField][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplateField].
string name = 1
Required. The name of the tag template field to delete. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
bool force = 2
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.
rpc CreateTag (, )
datacatalog.proto:273Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.
message
datacatalog.proto:844Request message for [CreateTag][google.cloud.datacatalog.v1beta1.DataCatalog.CreateTag].
string parent = 1
Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Tag and its child resources may not actually be stored in the location in this name.
optional tag = 2
Required. The tag to create.
rpc UpdateTag (, )
datacatalog.proto:282Updates an existing tag.
message
datacatalog.proto:863Request message for [UpdateTag][google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTag].
optional tag = 1
Required. The updated tag. The "name" field must be set.
optional update_mask = 2
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`.
rpc DeleteTag (, )
datacatalog.proto:292Deletes a tag.
message
datacatalog.proto:874Request message for [DeleteTag][google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTag].
string name = 1
Required. The name of the tag to delete. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
rpc ListTags (, )
datacatalog.proto:300Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
message
datacatalog.proto:985Request message for [ListTags][google.cloud.datacatalog.v1beta1.DataCatalog.ListTags].
string parent = 1
Required. The name of the Data Catalog resource to list the tags of. The resource could be an [Entry][google.cloud.datacatalog.v1beta1.Entry].
int32 page_size = 2
The maximum number of tags to return. Default is 10. Max limit is 1000.
string page_token = 3
Token that specifies which page is requested. If empty, the first page is returned.
message
datacatalog.proto:1005Response message for [ListTags][google.cloud.datacatalog.v1beta1.DataCatalog.ListTags].
repeated tags = 1
[Tag][google.cloud.datacatalog.v1beta1.Tag] details.
string next_page_token = 2
Token to retrieve the next page of results. It is set to empty if no items remain in results.
rpc SetIamPolicy (, )
datacatalog.proto:322Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
rpc GetIamPolicy (, )
datacatalog.proto:355Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog. A caller is not required to have Google IAM permission to make this request.
message
table_spec.proto:82Spec for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding
Used in:
string dataset = 1
Output only. The Data Catalog resource name of the dataset entry the current table belongs to, for example, `projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}`.
string table_prefix = 2
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`.
int64 shard_count = 3
Output only. Total number of shards.
message
table_spec.proto:29Describes a BigQuery table.
Used in:
TableSourceType table_source_type = 1
Output only. The table source type.
oneof type_spec
Output only.
view_spec = 2
Table view specification. This field should only be populated if `table_source_type` is `BIGQUERY_VIEW`.
table_spec = 3
Spec of a BigQuery table. This field should only be populated if `table_source_type` is `BIGQUERY_TABLE`.
message
schema.proto:36Representation of a column within a schema. Columns could be nested inside other columns.
Used in:
string column = 6
Required. Name of the column.
string type = 1
Required. Type of the column.
string description = 2
Optional. Description of the column. Default value is an empty string.
string mode = 3
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`.
repeated subcolumns = 7
Optional. Schema of sub-columns. A column can have zero or more sub-columns.
message
datacatalog.proto:651Entry 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][google.cloud.datacatalog.v1beta1.Tag].
Used as response type in: DataCatalog.CreateEntry, DataCatalog.GetEntry, DataCatalog.LookupEntry, DataCatalog.UpdateEntry
Used as field type in: ,
string name = 1
The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
string linked_resource = 9
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/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
oneof entry_type
Required. Entry type.
EntryType type = 2
The type of the entry.
oneof type_spec
Type specification information.
gcs_fileset_spec = 6
Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
bigquery_table_spec = 12
Specification that applies to a BigQuery table. This is only valid on entries of type `TABLE`.
bigquery_date_sharded_spec = 15
Specification for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
string display_name = 3
Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
string description = 4
Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
optional schema = 5
Schema of the entry. An entry might not have any schema attached to it.
optional source_system_timestamps = 7
Output only. Timestamps about the underlying Google Cloud Platform resource, not about this Data Catalog Entry.
message
datacatalog.proto:720EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog [Entry][google.cloud.datacatalog.v1beta1.Entry] resources.
Used as response type in: DataCatalog.CreateEntryGroup, DataCatalog.GetEntryGroup
Used as field type in:
string name = 1
The resource name of the entry group in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.
string display_name = 2
A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
string description = 3
Entry group description, which can consist of several sentences or paragraphs that describe entry group contents. Default value is an empty string.
optional data_catalog_timestamps = 4
Output only. Timestamps about this EntryGroup. Default value is empty timestamps.
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.
Used in:
ENTRY_TYPE_UNSPECIFIED = 0
Default unknown type
TABLE = 2
Output only. The type of entry that has a GoogleSQL schema, including logical views.
DATA_STREAM = 3
Output only. An entry type which is used for streaming entries. Example: Cloud Pub/Sub topic.
FILESET = 4
Alpha feature. An entry type which is a set of files or objects. Example: Cloud Storage fileset.
message
tags.proto:164Used in:
oneof type_decl
Required.
FieldType.PrimitiveType primitive_type = 1
Represents primitive types - string, bool etc.
enum_type = 2
Represents an enum type.
message
tags.proto:165Used in:
repeated allowed_values = 1
Required on create; optional on update. The set of allowed values for this enum. This set must not be empty, the display names of the values in this set must not be empty and the display names of the values must be case-insensitively unique within this set. Currently, enum values can only be added to the list of allowed values. Deletion and renaming of enum values are not supported. Can have up to 500 allowed values.
message
tags.proto:166Used in:
string display_name = 1
Required. The display name of the enum value. Must not be an empty string.
Used in:
PRIMITIVE_TYPE_UNSPECIFIED = 0
This is the default invalid value for a type.
DOUBLE = 1
A double precision number.
STRING = 2
An UTF-8 string.
BOOL = 3
A boolean value.
TIMESTAMP = 4
A timestamp.
message
gcs_fileset_spec.proto:49Specifications of a single file in GCS.
Used in:
string file_path = 1
Required. The full file path. Example: `gs://bucket_name/a/b.txt`.
optional gcs_timestamps = 2
Output only. Timestamps about the GCS file.
int64 size_bytes = 4
Output only. The size of the file, in bytes.
message
gcs_fileset_spec.proto:29Describes a Cloud Storage fileset entry.
Used in:
repeated string file_patterns = 1
Required. Patterns to identify a set of files in Google Cloud Storage. Examples of valid file_patterns: * `gs://bucket_name/*`: matches all files in `bucket_name` * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`
repeated sample_gcs_file_specs = 2
Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.
message
schema.proto:28Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
Used in:
repeated columns = 2
Required. Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.
message
datacatalog.proto:405Used in:
repeated string include_org_ids = 2
Data Catalog tries to automatically choose the right corpus of data to search through. You can ensure an organization is included by adding it to `include_org_ids`. You can ensure a project's org is included with `include_project_ids`. You must specify at least one organization using `include_org_ids` or `include_project_ids` in all search requests. List of organization IDs to search within. To find your organization ID, follow instructions in https://cloud.google.com/resource-manager/docs/creating-managing-organization.
repeated string include_project_ids = 3
List of project IDs to search within. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects.
bool include_gcp_public_datasets = 7
If `true`, include Google Cloud Platform (GCP) public datasets in the search results. Info on GCP public datasets is available at https://cloud.google.com/public-datasets/. By default, GCP public datasets are excluded.
message
search.proto:30A result that appears in the response of a search request. Each result captures details of one entry that matches the search.
Used in:
SearchResultType search_result_type = 1
Type of the search result. This field can be used to determine which Get method to call to fetch the full resource.
string search_result_subtype = 2
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`.
string relative_resource_name = 3
The relative resource name of the resource in URL format. Examples: * `projects/{project_id}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}` * `projects/{project_id}/tagTemplates/{tag_template_id}`
string linked_resource = 4
The full name of the cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId`
The different types of resources that can be returned in search.
Used in:
SEARCH_RESULT_TYPE_UNSPECIFIED = 0
Default unknown type.
ENTRY = 1
An [Entry][google.cloud.datacatalog.v1beta1.Entry].
TAG_TEMPLATE = 2
A [TagTemplate][google.cloud.datacatalog.v1beta1.TagTemplate].
ENTRY_GROUP = 3
An [EntryGroup][google.cloud.datacatalog.v1beta1.EntryGroup].
message
timestamps.proto:29Timestamps about this resource according to a particular system.
Used in: , ,
optional create_time = 1
The creation time of the resource within the given system.
optional update_time = 2
The last-modified time of the resource within the given system.
optional expire_time = 3
Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
Table source type.
Used in:
TABLE_SOURCE_TYPE_UNSPECIFIED = 0
Default unknown type.
BIGQUERY_VIEW = 2
Table view.
BIGQUERY_TABLE = 5
BigQuery native table.
message
table_spec.proto:65Normal BigQuery table spec.
Used in:
string grouped_entry = 1
Output only. If the table is a dated shard, i.e., with name pattern `[prefix]YYYYMMDD`, `grouped_entry` 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.
message
tags.proto:31Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template.
Used as response type in: DataCatalog.CreateTag, DataCatalog.UpdateTag
Used as field type in: , ,
string name = 1
The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
string template = 2
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.
string template_display_name = 5
Output only. The display name of the tag template.
oneof scope
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.
string column = 4
Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use `.` to separate the column names. Example: * `outer_column.inner_column`
map<string, > fields = 3
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.
message
tags.proto:79Contains the value and supporting information for a field within a [Tag][google.cloud.datacatalog.v1beta1.Tag].
Used in:
string display_name = 1
Output only. The display name of this field.
oneof kind
Required. The value of this field.
double double_value = 2
Holds the value for a tag field with double type.
string string_value = 3
Holds the value for a tag field with string type.
bool bool_value = 4
Holds the value for a tag field with boolean type.
timestamp_value = 5
Holds the value for a tag field with timestamp type.
enum_value = 6
Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum.
message
tags.proto:81Holds an enum value.
Used in:
string display_name = 1
The display name of the enum value.
message
tags.proto:112A 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.
Used as response type in: DataCatalog.CreateTagTemplate, DataCatalog.GetTagTemplate, DataCatalog.UpdateTagTemplate
Used as field type in: ,
string name = 1
The resource name of the tag template in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.
string display_name = 2
The display name for this template. Defaults to an empty string.
map<string, > fields = 3
Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
message
tags.proto:142The template for an individual field within a tag template.
Used as response type in: DataCatalog.CreateTagTemplateField, DataCatalog.RenameTagTemplateField, DataCatalog.UpdateTagTemplateField
Used as field type in: , ,
string name = 6
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 that this TagTemplateField may not actually be stored in the location in this name.
string display_name = 1
The display name for this field. Defaults to an empty string.
optional type = 2
Required. The type of value this tag field can contain.
message
table_spec.proto:59Table view specification.
Used in:
string view_query = 1
Output only. The query that defines the table view.