package google.cloud.datacatalog.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service DataCatalog
datacatalog.proto:57Deprecated: Please use Dataplex Catalog instead. Data Catalog API service allows you to discover, understand, and manage your data.
rpc SearchCatalog (, )
datacatalog.proto:78Searches Data Catalog for multiple resources like entries and tags that match a query. This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods. Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
message
datacatalog.proto:712Request message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
optional scope = 6
Required. The scope of this search request. The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND `include_gcp_public_datasets` is set to `false`. In this case, the request returns an error.
string query = 1
Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see [Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference). An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: * `name:x` * `column:y` * `description:z`
int32 page_size = 2
Upper bound on the number of results you can get in a single response. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
string page_token = 3
Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token] field of the response to a previous [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog] call.
string order_by = 5
Specifies the order of results. Currently supported case-sensitive values are: * `relevance` that can only be descending * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default * `default` that can only be descending Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to `default`. If this parameter is omitted, it defaults to the descending `relevance`.
bool admin_search = 17
Optional. If set, use searchAll permission granted on organizations from `include_org_ids` and projects from `include_project_ids` instead of the fine grained per resource permissions when filtering the search results. The only allowed `order_by` criteria for admin_search mode is `default`. Using this flags guarantees a full recall of the search results.
message
datacatalog.proto:825Response message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
repeated results = 1
Search results.
int32 total_size = 2
The approximate total number of entries matched by the query.
string next_page_token = 3
Pagination token that can be used in subsequent calls to retrieve the next page of results.
repeated string unreachable = 6
Unreachable locations. Search results don't include data from those locations. To get additional information on an error, repeat the search request and restrict it to specific locations by setting the `SearchCatalogRequest.scope.restricted_locations` parameter.
Creates an entry group. An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources: * BigQuery entries (`@bigquery`) * Pub/Sub topics (`@pubsub`) * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:847Request message for [CreateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup].
string parent = 1
Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
string entry_group_id = 3
Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
optional entry_group = 2
The entry group to create. Defaults to empty.
rpc GetEntryGroup (, )
datacatalog.proto:124Gets an entry group.
message
datacatalog.proto:887Request message for [GetEntryGroup][google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup].
string name = 1
Required. The name of the entry group to get.
optional read_mask = 2
The fields to return. If empty or omitted, all fields are returned.
Updates an entry group. You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:873Request message for [UpdateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup].
optional entry_group = 1
Required. Updates for the entry group. The `name` field must be set.
optional update_mask = 2
Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
Deletes an entry group. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:902Request message for [DeleteEntryGroup][google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup].
string name = 1
Required. The name of the entry group to delete.
bool force = 2
Optional. If true, deletes all entries in the entry group.
rpc ListEntryGroups (, )
datacatalog.proto:165Lists entry groups.
message
datacatalog.proto:917Request message for [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
string parent = 1
Required. The name of the location that contains the entry groups to list. Can be provided as a URL.
int32 page_size = 2
Optional. The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if `page_size` is greater than 1000.
string page_token = 3
Optional. Pagination token that specifies the next page to return. If empty, returns the first page.
message
datacatalog.proto:941Response message for [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].
repeated entry_groups = 1
Entry group details.
string next_page_token = 2
Pagination token to specify in the next call to retrieve the next page of results. Empty if there are no more items.
rpc CreateEntry (, )
datacatalog.proto:185Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries.
message
datacatalog.proto:952Request message for [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry].
string parent = 1
Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name.
string entry_id = 3
Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8.
optional entry = 2
Required. The entry to create.
rpc UpdateEntry (, )
datacatalog.proto:200Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:977Request message for [UpdateEntry][google.cloud.datacatalog.v1.DataCatalog.UpdateEntry].
optional entry = 1
Required. Updates for the entry. The `name` field must be set.
optional update_mask = 2
Names of fields whose values to overwrite on an entry. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. You can modify only the fields listed below. For entries with type `DATA_STREAM`: * `schema` For entries with type `FILESET`: * `schema` * `display_name` * `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns` For entries with `user_specified_type`: * `schema` * `display_name` * `description` * `user_specified_type` * `user_specified_system` * `linked_resource` * `source_system_timestamps`
rpc DeleteEntry (, )
datacatalog.proto:220Deletes an existing entry. You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:1015Request message for [DeleteEntry][google.cloud.datacatalog.v1.DataCatalog.DeleteEntry].
string name = 1
Required. The name of the entry to delete.
rpc GetEntry (, )
datacatalog.proto:229Gets an entry.
message
datacatalog.proto:1027Request message for [GetEntry][google.cloud.datacatalog.v1.DataCatalog.GetEntry].
string name = 1
Required. The name of the entry to get.
rpc LookupEntry (, )
datacatalog.proto:240Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.
message
datacatalog.proto:1039Request message for [LookupEntry][google.cloud.datacatalog.v1.DataCatalog.LookupEntry].
oneof target_name
Required. A full name, SQL name, or a fully qualified name of a Google Cloud Platform resource.
string linked_resource = 1
The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). Full names are case-sensitive. For example: * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
string sql_resource = 3
The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}` * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\` * `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}` * `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}` * `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}` Identifiers (`*_ID`) should comply with the [Lexical structure in GoogleSQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
string fully_qualified_name = 5
[Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource. FQNs take two forms: * For non-regionalized resources: `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` * For regionalized resources: `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` Example for a DPMS table: `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
string project = 6
Project where the lookup should be performed. Required to lookup entry that is not a part of `DPMS` or `DATAPLEX` `integrated_system` using its `fully_qualified_name`. Ignored in other cases.
string location = 7
Location where the lookup should be performed. Required to lookup entry that is not a part of `DPMS` or `DATAPLEX` `integrated_system` using its `fully_qualified_name`. Ignored in other cases.
rpc ListEntries (, )
datacatalog.proto:252Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
message
datacatalog.proto:2123Request message for [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].
string parent = 1
Required. The name of the entry group that contains the entries to list. Can be provided in URL format.
int32 page_size = 2
The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if `page_size` is more than 1000.
string page_token = 3
Pagination token that specifies the next page to return. If empty, the first page is returned.
optional read_mask = 4
The fields to return for each entry. If empty or omitted, all fields are returned. For example, to return a list of entries with only the `name` field, set `read_mask` to only one path with the `name` value.
message
datacatalog.proto:2152Response message for [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].
repeated entries = 1
Entry details.
string next_page_token = 2
Pagination token of the next results page. Empty if there are no more items in results.
Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry]. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.
message
datacatalog.proto:2264Request message for [ModifyEntryOverview][google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverview].
string name = 1
Required. The full resource name of the entry.
optional entry_overview = 2
Required. The new value for the Entry Overview.
Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry]. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.
message
datacatalog.proto:2279Request message for [ModifyEntryContacts][google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContacts].
string name = 1
Required. The full resource name of the entry.
optional contacts = 2
Required. The new value for the Contacts.
Creates a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:1787Request message for [CreateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate].
string parent = 1
Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
string tag_template_id = 3
Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
optional tag_template = 2
Required. The tag template to create.
rpc GetTagTemplate (, )
datacatalog.proto:303Gets a tag template.
message
datacatalog.proto:1810Request message for [GetTagTemplate][google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate].
string name = 1
Required. The name of the tag template to get.
Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:1822Request message for [UpdateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate].
optional tag_template = 1
Required. The template to update. The `name` field must be set.
optional update_mask = 2
Names of fields whose values to overwrite on a tag template. Currently, only `display_name` and `is_publicly_readable` can be overwritten. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the `is_publicly_readable` field may require up to 12 hours to take effect in search results.
Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:1840Request message for [DeleteTagTemplate][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate].
string name = 1
Required. The name of the tag template to delete.
bool force = 2
Required. If true, deletes all tags that use this template. Currently, `true` is the only supported value.
Creates a field in a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:1905Request message for [CreateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField].
string parent = 1
Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
string tag_template_field_id = 2
Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is *not* allowed. 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. You can't update the field type with this method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:1932Request message for [UpdateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField].
string name = 1
Required. The name of the tag template field.
optional tag_template_field = 2
Required. The template to update.
optional update_mask = 3
Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable: * `display_name` * `type.enum_type` * `is_required` If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is *not* allowed.
Renames a field in a tag template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:1967Request message for [RenameTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField].
string name = 1
Required. The name of the tag template field.
string new_tag_template_field_id = 2
Required. The new ID of this tag template field. For example, `my_new_field`.
Renames an enum value in a tag template. Within a single enum field, enum values must be unique.
message
datacatalog.proto:1983Request message for [RenameTagTemplateFieldEnumValue][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue].
string name = 1
Required. The name of the enum field value.
string new_enum_value_display_name = 2
Required. The new display name of the enum value. For example, `my_new_enum_value`.
Deletes a field in a tag template and all uses of this field from the tags based on this template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
message
datacatalog.proto:2000Request message for [DeleteTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField].
string name = 1
Required. The name of the tag template field to delete.
bool force = 2
Required. If true, deletes this field from any tags that use it. Currently, `true` is the only supported value.
rpc CreateTag (, )
datacatalog.proto:435Creates a tag and assigns it to: * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
message
datacatalog.proto:1857Request message for [CreateTag][google.cloud.datacatalog.v1.DataCatalog.CreateTag].
string parent = 1
Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name.
optional tag = 2
Required. The tag to create.
rpc UpdateTag (, )
datacatalog.proto:449Updates an existing tag.
message
datacatalog.proto:1878Request message for [UpdateTag][google.cloud.datacatalog.v1.DataCatalog.UpdateTag].
optional tag = 1
Required. The updated tag. The "name" field must be set.
optional update_mask = 2
Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name `fields`. In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
rpc DeleteTag (, )
datacatalog.proto:464Deletes a tag.
message
datacatalog.proto:1893Request message for [DeleteTag][google.cloud.datacatalog.v1.DataCatalog.DeleteTag].
string name = 1
Required. The name of the tag to delete.
rpc ListTags (, )
datacatalog.proto:478Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.
message
datacatalog.proto:2017Request message for [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
string parent = 1
Required. The name of the Data Catalog resource to list the tags of. The resource can be an [Entry][google.cloud.datacatalog.v1.Entry] or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup] (without `/entries/{entries}` at the end).
int32 page_size = 2
The maximum number of tags to return. Default is 10. Maximum limit is 1000.
string page_token = 3
Pagination token that specifies the next page to return. If empty, the first page is returned.
message
datacatalog.proto:2040Response message for [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].
repeated tags = 1
[Tag][google.cloud.datacatalog.v1.Tag] details.
string next_page_token = 2
Pagination token of the next results page. Empty if there are no more items in results.
rpc ReconcileTags (, )
datacatalog.proto:502`ReconcileTags` creates or updates a list of tags on the entry. If the [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing] parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
message
datacatalog.proto:2051Request message for [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
string parent = 1
Required. Name of [Entry][google.cloud.datacatalog.v1.Entry] to be tagged.
string tag_template = 2
Required. The name of the tag template, which is used for reconciliation.
bool force_delete_missing = 3
If set to `true`, deletes entry tags related to a tag template not listed in the tags source from an entry. If set to `false`, unlisted tags are retained.
repeated tags = 4
A list of tags to apply to an entry. A tag can specify a tag template, which must be the template specified in the `ReconcileTagsRequest`. The sole entry and each of its columns must be mentioned at most once.
rpc StarEntry (, )
datacatalog.proto:517Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.
message
datacatalog.proto:2163Request message for [StarEntry][google.cloud.datacatalog.v1.DataCatalog.StarEntry].
string name = 1
Required. The name of the entry to mark as starred.
message
datacatalog.proto:2176Response message for [StarEntry][google.cloud.datacatalog.v1.DataCatalog.StarEntry]. Empty for now
(message has no fields)
rpc UnstarEntry (, )
datacatalog.proto:528Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user.
message
datacatalog.proto:2180Request message for [UnstarEntry][google.cloud.datacatalog.v1.DataCatalog.UnstarEntry].
string name = 1
Required. The name of the entry to mark as **not** starred.
message
datacatalog.proto:2193Response message for [UnstarEntry][google.cloud.datacatalog.v1.DataCatalog.UnstarEntry]. Empty for now
(message has no fields)
rpc SetIamPolicy (, )
datacatalog.proto:554Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
rpc GetIamPolicy (, )
datacatalog.proto:589Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.
rpc ImportEntries (, )
datacatalog.proto:656Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. `ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type. `ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message.
message
datacatalog.proto:2198Request message for [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries] method.
string parent = 1
Required. Target entry group for ingested entries.
oneof source
Source of imported entries, e.g. dump stored in a Cloud Storage
string gcs_bucket_path = 2
Path to a Cloud Storage bucket that contains a dump ready for ingestion.
string job_id = 3
Optional. (Optional) Dataplex task job id, if specified will be used as part of ImportEntries LRO ID
rpc SetConfig (, )
datacatalog.proto:671Sets the configuration related to the migration to Dataplex for an organization or project.
message
datacatalog.proto:2377Request message for [SetConfig][google.cloud.datacatalog.v1.DataCatalog.SetConfig].
string name = 1
Required. The organization or project whose config is being specified.
oneof configuration
The configuration field to set.
TagTemplateMigration tag_template_migration = 2
Opt-in status for the migration of Tag Templates to Dataplex.
CatalogUIExperience catalog_ui_experience = 3
Opt-in status for the UI switch to Dataplex.
rpc RetrieveConfig (, )
datacatalog.proto:686Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.
message
datacatalog.proto:2393Request message for [RetrieveConfig][google.cloud.datacatalog.v1.DataCatalog.RetrieveConfig].
string name = 1
Required. The organization whose config is being retrieved.
message
datacatalog.proto:2435The configuration related to the migration from Data Catalog to Dataplex that has been applied to an organization and any projects under it. It is the response message for [RetrieveConfig][google.cloud.datacatalog.v1.DataCatalog.RetrieveConfig].
map<string, > config = 1
Map of organizations and project resource names and their configuration. The format for the map keys is `organizations/{organizationId}` or `projects/{projectId}`.
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
message
datacatalog.proto:2400Request message for [RetrieveEffectiveConfig][google.cloud.datacatalog.v1.DataCatalog.RetrieveEffectiveConfig].
string name = 1
Required. The resource whose effective config is being retrieved.
Policy Tag Manager API service allows you to manage your policy tags and taxonomies. Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.
Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.
message
policytagmanager.proto:326Request message for [CreateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy].
string parent = 1
Required. Resource name of the project that the taxonomy will belong to.
optional taxonomy = 2
The taxonomy to create.
Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.
message
policytagmanager.proto:341Request message for [DeleteTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy].
string name = 1
Required. Resource name of the taxonomy to delete. Note: All policy tags in this taxonomy are also deleted.
Updates a taxonomy, including its display name, description, and activated policy types.
message
policytagmanager.proto:355Request message for [UpdateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy].
optional taxonomy = 1
The taxonomy to update. You can update only its description, display name, and activated policy types.
optional update_mask = 2
Specifies fields to update. If not set, defaults to all fields you can update. For more information, see [FieldMask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Lists all taxonomies in a project in a particular location that you have a permission to view.
message
policytagmanager.proto:370Request message for [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].
string parent = 1
Required. Resource name of the project to list the taxonomies of.
int32 page_size = 2
The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.
string page_token = 3
The pagination token of the next results page. If not set, the first page is returned. The token is returned in the response to a previous list request.
string filter = 4
Supported field for filter is 'service' and value is 'dataplex'. Eg: service=dataplex.
message
policytagmanager.proto:396Response message for [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].
repeated taxonomies = 1
Taxonomies that the project contains.
string next_page_token = 2
Pagination token of the next results page. Empty if there are no more results in the list.
rpc GetTaxonomy (, )
policytagmanager.proto:90Gets a taxonomy.
message
policytagmanager.proto:407Request message for [GetTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy].
string name = 1
Required. Resource name of the taxonomy to get.
Creates a policy tag in a taxonomy.
message
policytagmanager.proto:419Request message for [CreatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag].
string parent = 1
Required. Resource name of the taxonomy that the policy tag will belong to.
optional policy_tag = 2
The policy tag to create.
Deletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated with the policy tag and its descendants * References from BigQuery table schema of the policy tag and its descendants
message
policytagmanager.proto:434Request message for [DeletePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag].
string name = 1
Required. Resource name of the policy tag to delete. Note: All of its descendant policy tags are also deleted.
Updates a policy tag, including its display name, description, and parent policy tag.
message
policytagmanager.proto:448Request message for [UpdatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag].
optional policy_tag = 1
The policy tag to update. You can update only its description, display name, and parent policy tag fields.
optional update_mask = 2
Specifies the fields to update. You can update only display name, description, and parent policy tag. If not set, defaults to all updatable fields. For more information, see [FieldMask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
Lists all policy tags in a taxonomy.
message
policytagmanager.proto:464Request message for [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].
string parent = 1
Required. Resource name of the taxonomy to list the policy tags of.
int32 page_size = 2
The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.
string page_token = 3
The pagination token of the next results page. If not set, returns the first page. The token is returned in the response to a previous list request.
message
policytagmanager.proto:487Response message for [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].
repeated policy_tags = 1
The policy tags that belong to the taxonomy.
string next_page_token = 2
Pagination token of the next results page. Empty if there are no more results in the list.
Gets a policy tag.
message
policytagmanager.proto:498Request message for [GetPolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag].
string name = 1
Required. Resource name of the policy tag.
Gets the IAM policy for a policy tag or a taxonomy.
Sets the IAM policy for a policy tag or a taxonomy.
Returns your permissions on a specified policy tag or taxonomy.
Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format. Taxonomy is a hierarchical group of policy tags.
Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.
Request message for [ReplaceTaxonomy][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy].
string name = 1
Required. Resource name of the taxonomy to update.
optional serialized_taxonomy = 2
Required. Taxonomy to update along with its child policy tags.
Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.
Request message for [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].
string parent = 1
Required. Resource name of project that the imported taxonomies will belong to.
oneof source
Source taxonomies to import.
inline_source = 2
Inline source taxonomy to import.
cross_regional_source = 3
Cross-regional source taxonomy to import.
Response message for [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].
repeated taxonomies = 1
Imported taxonomies.
Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls.
Request message for [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].
string parent = 1
Required. Resource name of the project that the exported taxonomies belong to.
repeated string taxonomies = 2
Required. Resource names of the taxonomies to export.
oneof destination
Required. Export destination for taxonomies.
bool serialized_taxonomies = 3
Serialized export taxonomies that contain all the policy tags as nested protocol buffers.
Response message for [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].
repeated taxonomies = 1
List of taxonomies and policy tags as nested protocol buffers.
message
bigquery.proto:30Specification for the BigQuery connection.
Used in:
BigQueryConnectionSpec.ConnectionType connection_type = 1
The type of the BigQuery connection.
oneof connection_spec
cloud_sql = 2
Specification for the BigQuery connection to a Cloud SQL instance.
bool has_credential = 3
True if there are credentials attached to the BigQuery connection; false otherwise.
The type of the BigQuery connection.
Used in:
CONNECTION_TYPE_UNSPECIFIED = 0
Unspecified type.
CLOUD_SQL = 1
Cloud SQL connection.
message
table_spec.proto:90Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (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 the `MyTable20180101` shard, the `table_prefix` is `MyTable`.
int64 shard_count = 3
Output only. Total number of shards.
string latest_shard_resource = 4
Output only. BigQuery resource name of the latest shard.
message
bigquery.proto:78Fields specific for BigQuery routines.
Used in:
repeated string imported_libraries = 1
Paths of the imported libraries.
message
table_spec.proto:30Describes 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. Populated only if the `table_source_type` is `BIGQUERY_VIEW`.
table_spec = 3
Specification of a BigQuery table. Populated only if the `table_source_type` is `BIGQUERY_TABLE`.
message
datacatalog.proto:1712Business Context of the entry.
Used in:
optional entry_overview = 1
Entry overview fields for rich text descriptions of entries.
optional contacts = 2
Contact people for the entry.
Configuration related to the opt-in status for the UI switch to Dataplex.
Used in: ,
CATALOG_UI_EXPERIENCE_UNSPECIFIED = 0
Default value. The default UI is Dataplex.
CATALOG_UI_EXPERIENCE_ENABLED = 1
The UI is Dataplex.
CATALOG_UI_EXPERIENCE_DISABLED = 2
The UI is Data Catalog.
message
datacatalog.proto:1537Specification that applies to Instance entries that are part of `CLOUD_BIGTABLE` system. (user_specified_type)
Used in:
repeated cloud_bigtable_cluster_specs = 1
The list of clusters for the Instance.
message
datacatalog.proto:1539Spec that applies to clusters of an Instance of Cloud Bigtable.
Used in:
string display_name = 1
Name of the cluster.
string location = 2
Location of the cluster, typically a Cloud zone.
string type = 3
Type of the resource. For a cluster this would be "CLUSTER".
string linked_resource = 4
A link back to the parent resource, in this case Instance.
message
datacatalog.proto:1528Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (user_specified_type)
Used in:
string instance_display_name = 1
Display name of the Instance. This is user specified and different from the resource name.
message
bigquery.proto:54Specification for the BigQuery connection to a Cloud SQL instance.
Used in:
string instance_id = 1
Cloud SQL instance ID in the format of `project:location:instance`.
string database = 2
Database name.
CloudSqlBigQueryConnectionSpec.DatabaseType type = 3
Type of the Cloud SQL database.
Supported Cloud SQL database types.
Used in:
DATABASE_TYPE_UNSPECIFIED = 0
Unspecified database type.
POSTGRES = 1
Cloud SQL for PostgreSQL.
MYSQL = 2
Cloud SQL for MySQL.
message
schema.proto:39A column within a schema. Columns can be nested inside other columns.
Used in:
string column = 6
Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.
string type = 1
Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes.
string description = 2
Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes.
string mode = 3
Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`.
string default_value = 8
Optional. Default value for the column.
int32 ordinal_position = 9
Optional. Ordinal position
ColumnSchema.IndexingType highest_indexing_type = 10
Optional. Most important inclusion of this column.
repeated subcolumns = 7
Optional. Schema of sub-columns. A column can have zero or more sub-columns.
oneof system_spec
Information only applying for columns in Entries from a specific system.
looker_column_spec = 18
Looker specific column info of this column.
optional range_element_type = 19
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: * DATE * DATETIME * TIMESTAMP
string gc_rule = 11
Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.
message
schema.proto:86Represents the type of a field element.
Used in:
string type = 1
Required. The type of a field element. See [ColumnSchema.type][google.cloud.datacatalog.v1.ColumnSchema.type].
Specifies inclusion of the column in an index
Used in:
INDEXING_TYPE_UNSPECIFIED = 0
Unspecified.
INDEXING_TYPE_NONE = 1
Column not a part of an index.
INDEXING_TYPE_NON_UNIQUE = 2
Column Part of non unique index.
INDEXING_TYPE_UNIQUE = 3
Column part of unique index.
INDEXING_TYPE_PRIMARY_KEY = 4
Column part of the primary key.
message
schema.proto:59Column info specific to Looker System.
Used in:
LookerColumnSpec.LookerColumnType type = 1
Looker specific column type of this column.
Column type in Looker.
Used in:
LOOKER_COLUMN_TYPE_UNSPECIFIED = 0
Unspecified.
DIMENSION = 1
Dimension.
DIMENSION_GROUP = 2
Dimension group - parent for Dimension.
FILTER = 3
Filter.
MEASURE = 4
Measure.
PARAMETER = 5
Parameter.
message
usage.proto:56Common statistics on the entry's usage. They can be set on any system.
Used in:
optional int64 view_count = 1
View count in source system.
message
datacatalog.proto:1733Contact people for the entry.
Used as response type in: DataCatalog.ModifyEntryContacts
Used as field type in: ,
repeated people = 1
The list of contact people for the entry.
message
datacatalog.proto:1735A contact person for the entry.
Used in:
string designation = 1
Designation of the person, for example, Data Steward.
string email = 2
Email of the person in the format of `john.doe@xyz`, `<john.doe@xyz>`, or `John Doe<john.doe@xyz>`.
Cross-regional source used to import an existing taxonomy into a different region.
Used in:
string taxonomy = 1
Required. The resource name of the source taxonomy to import.
message
data_source.proto:30Physical location of an entry.
Used in:
DataSource.Service service = 1
Service that physically stores the data.
string resource = 2
Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}`
string source_entry = 3
Output only. Data Catalog entry name, if applicable.
oneof properties
storage_properties = 4
Detailed properties of the underlying storage.
Name of a service that stores the data.
Used in:
SERVICE_UNSPECIFIED = 0
Default unknown service.
CLOUD_STORAGE = 1
Google Cloud Storage service.
BIGQUERY = 2
BigQuery service.
message
datacatalog.proto:1386Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. Only one of internal specs can be set at the time, and cannot be changed later.
Used in:
optional bigquery_connection_spec = 1
Output only. Fields specific to BigQuery connections.
message
datacatalog.proto:1321Specification that applies to a table resource. Valid only for entries with the `TABLE` type.
Used in:
DatabaseTableSpec.TableType type = 1
Type of this table.
optional dataplex_table = 2
Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries.
optional database_view_spec = 3
Spec what applies to tables that are actually views. Not set for "real" tables.
message
datacatalog.proto:1335Specification that applies to database view.
Used in:
DatabaseViewSpec.ViewType view_type = 1
Type of this view.
oneof source_definition
Definition of the view.
string base_table = 2
Name of a singular table this view reflects one to one.
string sql_query = 3
SQL query used to generate this view.
Concrete type of the view.
Used in:
VIEW_TYPE_UNSPECIFIED = 0
Default unknown view type.
STANDARD_VIEW = 1
Standard view.
MATERIALIZED_VIEW = 2
Materialized view.
Type of the table.
Used in:
TABLE_TYPE_UNSPECIFIED = 0
Default unknown table type.
NATIVE = 1
Native table.
EXTERNAL = 2
External table.
message
dataplex_spec.proto:77External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.
Used in:
IntegratedSystem system = 1
Service in which the external table is registered.
string fully_qualified_name = 28
Fully qualified name (FQN) of the external table.
string google_cloud_resource = 3
Google Cloud resource name of the external table.
string data_catalog_entry = 4
Name of the Data Catalog entry representing the external table.
message
dataplex_spec.proto:50Entry specyfication for a Dataplex fileset.
Used in:
optional dataplex_spec = 1
Common Dataplex fields.
message
dataplex_spec.proto:31Common Dataplex fields.
Used in: ,
string asset = 1
Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.
optional data_format = 2
Format of the data.
string compression_format = 3
Compression format of the data, e.g., zip, gzip etc.
string project_id = 4
Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset.
message
dataplex_spec.proto:56Entry specification for a Dataplex table.
Used in:
repeated external_tables = 1
List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems.
optional dataplex_spec = 2
Common Dataplex fields.
bool user_managed = 3
Indicates if the table schema is managed by the user or not.
message
datacatalog.proto:1464Specification that applies to a dataset. Valid only for entries with the `DATASET` type.
Used in:
oneof system_spec
Fields specific to the source system.
vertex_dataset_spec = 2
Vertex AI Dataset specific fields
message
dump_content.proto:50Wrapper for any item that can be contained in the dump.
oneof item
tagged_entry = 1
Entry and its tags.
message
datacatalog.proto:1109Entry 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][google.cloud.datacatalog.v1.Tag].
Used as response type in: DataCatalog.CreateEntry, DataCatalog.GetEntry, DataCatalog.LookupEntry, DataCatalog.UpdateEntry
Used as field type in: , , ,
string name = 1
Output only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.
string linked_resource = 9
The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (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/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.
string fully_qualified_name = 29
[Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.
oneof entry_type
Required. Entry type.
EntryType type = 2
The type of the entry. For details, see [`EntryType`](#entrytype).
string user_specified_type = 16
Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long.
oneof system
The source system of the entry.
IntegratedSystem integrated_system = 17
Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
string user_specified_system = 18
Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long.
oneof system_spec
System specification. Can be used as a complement for `spec`, when some metadata is relevant for all entries existing within given system
sql_database_system_spec = 39
Specification that applies to a relational database system. Only settable when `user_specified_system` is equal to `SQL_DATABASE`
looker_system_spec = 40
Specification that applies to Looker sysstem. Only settable when `user_specified_system` is equal to `LOOKER`
cloud_bigtable_system_spec = 41
Specification that applies to Cloud Bigtable system. Only settable when `integrated_system` is equal to `CLOUD_BIGTABLE`
oneof type_spec
Type specification.
gcs_fileset_spec = 6
Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type.
bigquery_table_spec = 12
Output only. Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type.
bigquery_date_sharded_spec = 15
Output only. Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).
oneof spec
Type- and system-specific information. Specifications for types contain fields common to all entries of a given type, and sub-specifications with fields specific to a given source system. When extending the API with new types and systems, use this field instead of the legacy `type_spec`.
database_table_spec = 24
Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type.
data_source_connection_spec = 27
Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type.
routine_spec = 28
Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type.
dataset_spec = 32
Specification that applies to a dataset.
fileset_spec = 33
Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type.
service_spec = 42
Specification that applies to a Service resource.
model_spec = 43
Model specification.
feature_online_store_spec = 45
FeatureonlineStore spec for Vertex AI Feature Store.
string display_name = 3
Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
string description = 4
Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.
optional business_context = 37
Business Context of the entry. Not supported for BigQuery datasets
optional schema = 5
Schema of the entry. An entry might not have any schema attached to it.
optional source_system_timestamps = 7
Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a system listed in the `IntegratedSystem` enum. For entries with `user_specified_system`, this field is optional and defaults to an empty timestamp.
optional usage_signal = 13
Resource usage statistics.
map<string, string> labels = 14
Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.
optional data_source = 20
Output only. Physical location of the entry.
optional personal_details = 26
Output only. Additional information related to the entry. Private to the current user.
message
datacatalog.proto:1752Entry group metadata. An `EntryGroup` resource represents a logical grouping of zero or more Data Catalog [Entry][google.cloud.datacatalog.v1.Entry] resources.
Used as response type in: DataCatalog.CreateEntryGroup, DataCatalog.GetEntryGroup, DataCatalog.UpdateEntryGroup
Used as field type in: , ,
string name = 1
Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its 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. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
optional data_catalog_timestamps = 4
Output only. Timestamps of the entry group. Default value is empty.
bool transferred_to_dataplex = 9
Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.
message
datacatalog.proto:1721Entry overview fields for rich text descriptions of entries.
Used as response type in: DataCatalog.ModifyEntryOverview
Used as field type in: ,
string overview = 1
Entry overview with support for rich text. The overview must only contain Unicode characters, and should be formatted using HTML. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
Metadata automatically ingested from Google Cloud resources like BigQuery tables or Pub/Sub topics always uses enum values from `EntryType` as the type of entry. Other sources of metadata like Hive or Oracle databases can identify the type by either using one of the enum values from `EntryType` (for example, `FILESET` for a Cloud Storage fileset) or specifying a custom value using the [`Entry`](#resource:-entry) field `user_specified_type`. For more information, see [Surface files from Cloud Storage with fileset entries](/data-catalog/docs/how-to/filesets) or [Create custom entries for your data sources](/data-catalog/docs/how-to/custom-entries).
Used in:
ENTRY_TYPE_UNSPECIFIED = 0
Default unknown type.
TABLE = 2
The entry type that has a GoogleSQL schema, including logical views.
MODEL = 5
The type of models. For more information, see [Supported models in BigQuery ML](/bigquery/docs/bqml-introduction#supported_models).
DATA_STREAM = 3
An entry type for streaming entries. For example, a Pub/Sub topic.
FILESET = 4
An entry type for a set of files or objects. For example, a Cloud Storage fileset.
CLUSTER = 6
A group of servers that work together. For example, a Kafka cluster.
DATABASE = 7
A database.
DATA_SOURCE_CONNECTION = 8
Connection to a data source. For example, a BigQuery connection.
ROUTINE = 9
Routine, for example, a BigQuery routine.
LAKE = 10
A Dataplex lake.
ZONE = 11
A Dataplex zone.
SERVICE = 14
A service, for example, a Dataproc Metastore service.
DATABASE_SCHEMA = 15
Schema within a relational database.
DASHBOARD = 16
A Dashboard, for example from Looker.
EXPLORE = 17
A Looker Explore. For more information, see [Looker Explore API] (https://developers.looker.com/api/explorer/4.0/methods/LookmlModel/lookml_model_explore).
LOOK = 18
A Looker Look. For more information, see [Looker Look API] (https://developers.looker.com/api/explorer/4.0/methods/Look).
FEATURE_ONLINE_STORE = 19
Feature Online Store resource in Vertex AI Feature Store.
FEATURE_VIEW = 20
Feature View resource in Vertex AI Feature Store.
FEATURE_GROUP = 21
Feature Group resource in Vertex AI Feature Store.
message
datacatalog.proto:1694Detail description of the source information of a Vertex Feature Online Store.
Used in:
FeatureOnlineStoreSpec.StorageType storage_type = 1
Output only. Type of underlying storage for the FeatureOnlineStore.
Type of underlying storage type.
Used in:
STORAGE_TYPE_UNSPECIFIED = 0
Should not be used.
BIGTABLE = 1
Underlsying storgae is Bigtable.
OPTIMIZED = 2
Underlying is optimized online server (Lightning).
message
tags.proto:255Used in:
oneof type_decl
Required.
FieldType.PrimitiveType primitive_type = 1
Primitive types, such as string, boolean, etc.
enum_type = 2
An enum type.
message
tags.proto:276Used in:
repeated allowed_values = 1
The set of allowed values for this enum. This set must not be empty and can include up to 100 allowed values. The display names of the values in this set must not be empty and must be case-insensitively unique within this set. The order of items in this set is preserved. This field can be used to create, remove, and reorder enum values. To rename enum values, use the `RenameTagTemplateFieldEnumValue` method.
message
tags.proto:277Used in:
string display_name = 1
Required. The display name of the enum value. Must not be an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
Used in:
PRIMITIVE_TYPE_UNSPECIFIED = 0
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.
RICHTEXT = 5
A Richtext description.
message
datacatalog.proto:1376Specification that applies to a fileset. Valid only for entries with the 'FILESET' type.
Used in:
optional dataplex_fileset = 1
Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries.
message
gcs_fileset_spec.proto:69Specification of a single file in Cloud Storage.
Used in:
string file_path = 1
Required. Full file path. Example: `gs://bucket_name/a/b.txt`.
optional gcs_timestamps = 2
Output only. Creation, modification, and expiration timestamps of a Cloud Storage file.
int64 size_bytes = 4
Output only. File size in bytes.
message
gcs_fileset_spec.proto:30Describes a Cloud Storage fileset entry.
Used in:
repeated string file_patterns = 1
Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/wildcards). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g`
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
datacatalog.proto:2233Metadata message for [long-running operation][google.longrunning.Operation] returned by the [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries].
ImportEntriesMetadata.ImportState state = 1
State of the import operation.
repeated errors = 2
Partial errors that are encountered during the ImportEntries operation. There is no guarantee that all the encountered errors are reported. However, if no errors are reported, it means that no errors were encountered.
Enum holding possible states of the import operation.
Used in:
IMPORT_STATE_UNSPECIFIED = 0
Default value. This value is unused.
IMPORT_QUEUED = 1
The dump with entries has been queued for import.
IMPORT_IN_PROGRESS = 2
The import of entries is in progress.
IMPORT_DONE = 3
The import of entries has been finished.
IMPORT_OBSOLETE = 4
The import of entries has been abandoned in favor of a newer request.
message
datacatalog.proto:2221Response message for [long-running operation][google.longrunning.Operation] returned by the [ImportEntries][google.cloud.datacatalog.v1.DataCatalog.ImportEntries].
optional int64 upserted_entries_count = 5
Cumulative number of entries created and entries updated as a result of import operation.
optional int64 deleted_entries_count = 6
Number of entries deleted as a result of import operation.
Inline source containing taxonomies to import.
Used in:
repeated taxonomies = 1
Required. Taxonomies to import.
This enum lists all the systems that Data Catalog integrates with.
Used in: , ,
INTEGRATED_SYSTEM_UNSPECIFIED = 0
Default unknown system.
BIGQUERY = 1
BigQuery.
CLOUD_PUBSUB = 2
Cloud Pub/Sub.
DATAPROC_METASTORE = 3
Dataproc Metastore.
DATAPLEX = 4
Dataplex.
CLOUD_SPANNER = 6
Cloud Spanner
CLOUD_BIGTABLE = 7
Cloud Bigtable
CLOUD_SQL = 8
Cloud Sql
LOOKER = 9
Looker
VERTEX_AI = 10
Vertex AI
message
datacatalog.proto:1504Specification that applies to entries that are part `LOOKER` system (user_specified_type)
Used in:
string parent_instance_id = 1
ID of the parent Looker Instance. Empty if it does not exist. Example value: `someinstance.looker.com`
string parent_instance_display_name = 2
Name of the parent Looker Instance. Empty if it does not exist.
string parent_model_id = 3
ID of the parent Model. Empty if it does not exist.
string parent_model_display_name = 4
Name of the parent Model. Empty if it does not exist.
string parent_view_id = 5
ID of the parent View. Empty if it does not exist.
string parent_view_display_name = 6
Name of the parent View. Empty if it does not exist.
This enum describes all the systems that manage Taxonomy and PolicyTag resources in DataCatalog.
Used in:
MANAGING_SYSTEM_UNSPECIFIED = 0
Default value
MANAGING_SYSTEM_DATAPLEX = 1
Dataplex.
MANAGING_SYSTEM_OTHER = 2
Other
message
datacatalog.proto:2447The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for [SetConfig][google.cloud.datacatalog.v1.DataCatalog.SetConfig] and [RetrieveEffectiveConfig][google.cloud.datacatalog.v1.DataCatalog.RetrieveEffectiveConfig].
Used as response type in: DataCatalog.RetrieveEffectiveConfig, DataCatalog.SetConfig
Used as field type in:
TagTemplateMigration tag_template_migration = 1
Opt-in status for the migration of Tag Templates to Dataplex.
CatalogUIExperience catalog_ui_experience = 2
Opt-in status for the UI switch to Dataplex.
optional template_migration_enabled_time = 3
The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set.
message
datacatalog.proto:1684Specification that applies to a model. Valid only for entries with the `MODEL` type.
Used in:
oneof system_spec
System spec
vertex_model_spec = 1
Specification for vertex model resources.
message
common.proto:29Entry metadata relevant only to the user and private to them.
Used in:
bool starred = 1
True if the entry is starred by the user; false otherwise.
optional star_time = 2
Set if the entry is starred; unset otherwise.
message
physical_schema.proto:29Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data.
Used in:
oneof schema
avro = 1
Schema in Avro JSON format.
thrift = 2
Schema in Thrift format.
protobuf = 3
Schema in protocol buffer format.
parquet = 4
Marks a Parquet-encoded data source.
orc = 5
Marks an ORC-encoded data source.
csv = 6
Marks a CSV-encoded data source.
message
physical_schema.proto:31Schema in Avro JSON format.
Used in:
string text = 1
JSON source of the Avro schema.
message
physical_schema.proto:55Marks a CSV-encoded data source.
Used in:
(message has no fields)
message
physical_schema.proto:52Marks an ORC-encoded data source.
Used in:
(message has no fields)
message
physical_schema.proto:49Marks a Parquet-encoded data source.
Used in:
(message has no fields)
message
physical_schema.proto:43Schema in protocol buffer format.
Used in:
string text = 1
Protocol buffer source of the schema.
message
physical_schema.proto:37Schema in Thrift format.
Used in:
string text = 1
Thrift IDL source of the schema.
message
policytagmanager.proto:286Denotes 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.
Used as response type in: PolicyTagManager.CreatePolicyTag, PolicyTagManager.GetPolicyTag, PolicyTagManager.UpdatePolicyTag
Used as field type in: , ,
string name = 1
Identifier. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
string display_name = 2
Required. User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
string description = 3
Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
string parent_policy_tag = 4
Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
repeated string child_policy_tags = 5
Output only. Resource names of child policy tags of this policy tag.
message
datacatalog.proto:2097[Long-running operation][google.longrunning.Operation] metadata message returned by the [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
ReconcileTagsMetadata.ReconciliationState state = 1
State of the reconciliation operation.
map<string, > errors = 2
Maps the name of each tagged column (or empty string for a sole entry) to tagging operation [status][google.rpc.Status].
Enum holding possible states of the reconciliation operation.
Used in:
RECONCILIATION_STATE_UNSPECIFIED = 0
Default value. This value is unused.
RECONCILIATION_QUEUED = 1
The reconciliation has been queued and awaits for execution.
RECONCILIATION_IN_PROGRESS = 2
The reconciliation is in progress.
RECONCILIATION_DONE = 3
The reconciliation has been finished.
message
datacatalog.proto:2083[Long-running operation][google.longrunning.Operation] response message returned by [ReconcileTags][google.cloud.datacatalog.v1.DataCatalog.ReconcileTags].
int64 created_tags_count = 1
Number of tags created in the request.
int64 updated_tags_count = 2
Number of tags updated in the request.
int64 deleted_tags_count = 3
Number of tags deleted in the request.
message
datacatalog.proto:1393Specification that applies to a routine. Valid only for entries with the `ROUTINE` type.
Used in:
RoutineSpec.RoutineType routine_type = 1
The type of the routine.
string language = 2
The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * `SQL` * `JAVASCRIPT`
repeated routine_arguments = 3
Arguments of the routine.
string return_type = 4
Return type of the argument. The exact value depends on the source system and the language.
string definition_body = 5
The body of the routine.
oneof system_spec
Contains fields specific to the source system.
bigquery_routine_spec = 6
Fields specific for BigQuery routines.
message
datacatalog.proto:1407Input or output argument of a function or stored procedure.
Used in:
string name = 1
The name of the argument. A return argument of a function might not have a name.
Argument.Mode mode = 2
Specifies whether the argument is input or output.
string type = 3
Type of the argument. The exact value depends on the source system and the language.
The input or output mode of the argument.
Used in:
MODE_UNSPECIFIED = 0
Unspecified mode.
IN = 1
The argument is input-only.
OUT = 2
The argument is output-only.
INOUT = 3
The argument is both an input and an output.
The fine-grained type of the routine.
Used in:
ROUTINE_TYPE_UNSPECIFIED = 0
Unspecified type.
SCALAR_FUNCTION = 1
Non-builtin permanent scalar function.
PROCEDURE = 2
Stored procedure.
message
schema.proto:29Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.
Used in:
repeated columns = 2
The unified GoogleSQL-like schema of columns. The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels.
message
datacatalog.proto:714The criteria that select the subspace used for query matching.
Used in:
repeated string include_org_ids = 2
The list of organization IDs to search within. To find your organization ID, follow the steps from [Creating and managing organizations] (/resource-manager/docs/creating-managing-organization).
repeated string include_project_ids = 3
The list of project IDs to search within. For more information on the distinction between project names, IDs, and numbers, see [Projects](/docs/overview/#projects).
bool include_gcp_public_datasets = 7
If `true`, include Google Cloud public datasets in search results. By default, they are excluded. See [Google Cloud Public Datasets](/public-datasets) for more information.
repeated string restricted_locations = 16
Optional. The list of locations to search within. If empty, all locations are searched. Returns an error if any location in the list isn't one of the [Supported regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions). If a location is unreachable, its name is returned in the `SearchCatalogResponse.unreachable` field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.
bool starred_only = 18
Optional. If `true`, search only among starred entries. By default, all results are returned, starred or not.
bool include_public_tag_templates = 19
Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.
message
search.proto:33Result in the response to 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. You can use this field to determine which get method to call to fetch the full resource.
string search_result_subtype = 2
Sub-type of the search result. A dot-delimited full type of the resource. The same type you specify in the `type` search predicate. Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.
string relative_resource_name = 3
The relative 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 Google Cloud resource the entry belongs to. For more information, see [Full Resource Name] (/apis/design/resource_names#full_resource_name). Example: `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`
optional modify_time = 7
The last modification timestamp of the entry in the source system.
oneof system
The source system of the entry. Applicable only when the `search_result_type` is `ENTRY`.
IntegratedSystem integrated_system = 8
Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
string user_specified_system = 9
Custom source system that you can manually integrate Data Catalog with.
string fully_qualified_name = 10
Fully qualified name (FQN) of the resource. FQNs take two forms: * For non-regionalized resources: `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` * For regionalized resources: `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` Example for a DPMS table: `dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID`
string display_name = 12
The display name of the result.
string description = 13
Entry description that can consist of several sentences or paragraphs that describe entry contents.
The resource types that can be returned in search results.
Used in:
SEARCH_RESULT_TYPE_UNSPECIFIED = 0
Default unknown type.
ENTRY = 1
An [Entry][google.cloud.datacatalog.v1.Entry].
TAG_TEMPLATE = 2
A [TagTemplate][google.cloud.datacatalog.v1.TagTemplate].
ENTRY_GROUP = 3
An [EntryGroup][google.cloud.datacatalog.v1.EntryGroup].
A nested protocol buffer that represents a policy tag and all its descendants.
Used in:
string policy_tag = 1
Resource name of the policy tag. This field is ignored when calling `ImportTaxonomies`.
string display_name = 2
Required. Display name of the policy tag. At most 200 bytes when encoded in UTF-8.
string description = 3
Description of the serialized policy tag. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
repeated child_policy_tags = 4
Children of the policy tag, if any.
A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.
Used in: , ,
string display_name = 1
Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.
string description = 2
Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
repeated policy_tags = 3
Top level policy tags associated with the taxonomy, if any.
repeated Taxonomy.PolicyType activated_policy_types = 4
A list of policy types that are activated per taxonomy.
message
datacatalog.proto:1559Specification that applies to a Service resource. Valid only for entries with the `SERVICE` type.
Used in:
oneof system_spec
System spec
cloud_bigtable_instance_spec = 1
Specification that applies to Instance entries of `CLOUD_BIGTABLE` system.
message
datacatalog.proto:1475Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_type)
Used in:
string sql_engine = 1
SQL Database Engine. enum SqlEngine { UNDEFINED = 0; MY_SQL = 1; POSTGRE_SQL = 2; SQL_SERVER = 3; } Engine of the enclosing database instance.
string database_version = 2
Version of the database engine.
string instance_host = 3
Host of the SQL database enum InstanceHost { UNDEFINED = 0; SELF_HOSTED = 1; CLOUD_SQL = 2; AMAZON_RDS = 3; AZURE_SQL = 4; } Host of the enclousing database instance.
message
data_source.proto:61Details the properties of the underlying storage.
Used in:
repeated string file_pattern = 1
Patterns to identify a set of files for this fileset. Examples of a valid `file_pattern`: * `gs://bucket_name/dir/*`: matches all files in the `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in the `bucket_name/dir` and all subdirectories recursively * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt`
string file_type = 2
File type in MIME format, for example, `text/plain`.
message
timestamps.proto:30Timestamps associated with this resource in a particular system.
Used in: , , ,
optional create_time = 1
Creation timestamp of the resource within the given system.
optional update_time = 2
Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
optional expire_time = 3
Output only. Expiration timestamp of the resource within the given system. Currently only applicable 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.
BIGQUERY_MATERIALIZED_VIEW = 7
BigQuery materialized view.
message
table_spec.proto:69Normal BigQuery table specification.
Used in:
string grouped_entry = 1
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.
message
tags.proto:36Tags 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.
Used as response type in: DataCatalog.CreateTag, DataCatalog.UpdateTag
Used as field type in: , , , ,
string name = 1
Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
string template = 2
Required. The resource name of the tag template 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 deletes 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 you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`.
map<string, > fields = 3
Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.
TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7
Output only. Denotes the transfer status of the Tag Template.
message
tags.proto:89Contains the value and additional information on a field within a [Tag][google.cloud.datacatalog.v1.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
The value of a tag field with a double type.
string string_value = 3
The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
bool bool_value = 4
The value of a tag field with a boolean type.
timestamp_value = 5
The value of a tag field with a timestamp type.
enum_value = 6
The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
string richtext_value = 8
The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
int32 order = 7
Output only. The order of this field with respect to other fields in this tag. Can be set by [Tag][google.cloud.datacatalog.v1.TagTemplateField.order]. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
message
tags.proto:91An enum value.
Used in:
string display_name = 1
The display name of the enum value.
message
tags.proto:147A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached 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. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
Used as response type in: DataCatalog.CreateTagTemplate, DataCatalog.GetTagTemplate, DataCatalog.UpdateTagTemplate
Used as field type in: ,
string name = 1
Identifier. The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
string display_name = 2
Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
bool is_publicly_readable = 5
Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags] API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a ``tag:`` predicate.
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. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7
Optional. Transfer status of the TagTemplate
This enum describes TagTemplate transfer status to Dataplex service.
Used in: ,
DATAPLEX_TRANSFER_STATUS_UNSPECIFIED = 0
Default value. TagTemplate and its tags are only visible and editable in DataCatalog.
MIGRATED = 1
TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.
TRANSFERRED = 2
TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in Dataplex, read-only in DataCatalog.
message
tags.proto:211The template for an individual field within a tag template.
Used as response type in: DataCatalog.CreateTagTemplateField, DataCatalog.RenameTagTemplateField, DataCatalog.RenameTagTemplateFieldEnumValue, DataCatalog.UpdateTagTemplateField
Used as field type in: , ,
string name = 6
Identifier. 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.
string display_name = 1
The display name for this field. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
optional type = 2
Required. The type of value this tag field can contain.
bool is_required = 3
If true, this field is required. Defaults to false.
string description = 4
The description for this field. Defaults to an empty string.
int32 order = 5
The order of this field with respect to other fields in this tag template. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order and field orders within a tag don't have to be sequential.
Configuration related to the opt-in status for the migration of TagTemplates to Dataplex.
Used in: ,
TAG_TEMPLATE_MIGRATION_UNSPECIFIED = 0
Default value. Migration of Tag Templates from Data Catalog to Dataplex is not performed.
TAG_TEMPLATE_MIGRATION_ENABLED = 1
Migration of Tag Templates from Data Catalog to Dataplex is enabled.
TAG_TEMPLATE_MIGRATION_DISABLED = 2
Migration of Tag Templates from Data Catalog to Dataplex is disabled.
message
dump_content.proto:33Wrapper containing Entry and information about Tags that should and should not be attached to it.
Used in:
oneof entry
Required. Entry to be ingested.
v1_entry = 1
Non-encrypted Data Catalog v1 Entry.
repeated present_tags = 2
Optional. Tags that should be ingested into the Data Catalog. Caller should populate template name, column and fields.
repeated absent_tags = 3
Optional. Tags that should be deleted from the Data Catalog. Caller should populate template name and column only.
message
policytagmanager.proto:210A 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 ```
Used as response type in: PolicyTagManager.CreateTaxonomy, PolicyTagManager.GetTaxonomy, PolicyTagManager.UpdateTaxonomy, PolicyTagManagerSerialization.ReplaceTaxonomy
Used as field type in: , , ,
string name = 1
Identifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
string display_name = 2
Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
string description = 3
Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
int32 policy_tag_count = 4
Output only. Number of policy tags in this taxonomy.
optional taxonomy_timestamps = 5
Output only. Creation and modification timestamps of this taxonomy.
repeated Taxonomy.PolicyType activated_policy_types = 6
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
optional service = 7
Output only. Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
Defines policy types where the policy tags can be used for.
Used in: ,
POLICY_TYPE_UNSPECIFIED = 0
Unspecified policy type.
FINE_GRAINED_ACCESS_CONTROL = 1
Fine-grained access control policy that enables access control on tagged sub-resources.
message
policytagmanager.proto:227The source system of the Taxonomy.
Used in:
ManagingSystem name = 1
The Google Cloud service name.
string identity = 2
The service agent for the service.
message
usage.proto:65The 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.
Used in:
optional update_time = 1
The end timestamp of the duration of usage statistics.
map<string, > usage_within_time_range = 2
Output only. BigQuery usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`.
map<string, > common_usage_within_time_range = 3
Common usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D", "Lifetime"}`.
optional int64 favorite_count = 4
Favorite count in the source system.
message
usage.proto:39Detailed 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] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables)
Used in:
float total_completions = 1
The number of successful uses of the underlying entry.
float total_failures = 2
The number of failed attempts to use the underlying entry.
float total_cancellations = 3
The number of cancelled attempts to use the underlying entry.
float total_execution_time_for_completions_millis = 4
Total time spent only on successful uses, in milliseconds.
message
datacatalog.proto:1627Specification for vertex dataset resources.
Used in:
int64 data_item_count = 1
The number of DataItems in this Dataset. Only apply for non-structured Dataset.
VertexDatasetSpec.DataType data_type = 2
Type of the dataset.
Type of data stored in the dataset.
Used in:
DATA_TYPE_UNSPECIFIED = 0
Should not be used.
TABLE = 1
Structured data dataset.
IMAGE = 2
Image dataset which supports ImageClassification, ImageObjectDetection and ImageSegmentation problems.
TEXT = 3
Document dataset which supports TextClassification, TextExtraction and TextSentiment problems.
VIDEO = 4
Video dataset which supports VideoClassification, VideoObjectTracking and VideoActionRecognition problems.
CONVERSATION = 5
Conversation dataset which supports conversation problems.
TIME_SERIES = 6
TimeSeries dataset.
DOCUMENT = 7
Document dataset which supports DocumentAnnotation problems.
TEXT_TO_SPEECH = 8
TextToSpeech dataset which supports TextToSpeech problems.
TRANSLATION = 9
Translation dataset which supports Translation problems.
STORE_VISION = 10
Store Vision dataset which is used for HITL integration.
ENTERPRISE_KNOWLEDGE_GRAPH = 11
Enterprise Knowledge Graph dataset which is used for HITL labeling integration.
TEXT_PROMPT = 12
Text prompt dataset which supports Large Language Models.
message
datacatalog.proto:1569Detail description of the source information of a Vertex model.
Used in:
VertexModelSourceInfo.ModelSourceType source_type = 1
Type of the model source.
bool copy = 2
If this Model is copy of another Model. If true then [source_type][google.cloud.datacatalog.v1.VertexModelSourceInfo.source_type] pertains to the original.
Source of the model.
Used in:
MODEL_SOURCE_TYPE_UNSPECIFIED = 0
Should not be used.
AUTOML = 1
The Model is uploaded by automl training pipeline.
CUSTOM = 2
The Model is uploaded by user or custom training pipeline.
BQML = 3
The Model is registered and sync'ed from BigQuery ML.
MODEL_GARDEN = 4
The Model is saved or tuned from Model Garden.
GENIE = 5
The Model is saved or tuned from Genie.
CUSTOM_TEXT_EMBEDDING = 6
The Model is uploaded by text embedding finetuning pipeline.
MARKETPLACE = 7
The Model is saved or tuned from Marketplace.
message
datacatalog.proto:1607Specification for vertex model resources.
Used in:
string version_id = 1
The version ID of the model.
repeated string version_aliases = 2
User provided version aliases so that a model version can be referenced via alias
string version_description = 3
The description of this version.
optional vertex_model_source_info = 4
Source of a Vertex model.
string container_image_uri = 5
URI of the Docker image to be used as the custom container for serving predictions.
message
table_spec.proto:63Table view specification.
Used in:
string view_query = 1
Output only. The query that defines the table view.