Package google.cloud.datacatalog.v1

The taxonomy to create.

CrossRegionalSource

Cross-regional source used to import an existing taxonomy into a different region.

Fields

taxonomy

string

Required. The resource name of the source taxonomy to import.

DataSource

Physical location of an entry.

Fields

service

Service

Service that physically stores the data.

resource

string

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}

Service

Name of a service that stores the data.

Enums
`SERVICE_UNSPECIFIED`	Default unknown service.
`CLOUD_STORAGE`	Google Cloud Storage service.
`BIGQUERY`	BigQuery service.

DataSourceConnectionSpec

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

Fields

bigquery_connection_spec

BigQueryConnectionSpec

Fields specific to BigQuery connections.

DatabaseTableSpec

Specification that applies to a table resource. Valid only for entries with the TABLE type.

Fields

type

TableType

Type of this table.

TableType

Type of the table.

Enums
`TABLE_TYPE_UNSPECIFIED`	Default unknown table type.
`NATIVE`	Native table.
`EXTERNAL`	External table.

DeleteEntryGroupRequest

Request message for DeleteEntryGroup.

Fields

name

string

Required. The name of the entry group to delete.

force

bool

Optional. If true, deletes all entries in the entry group.

DeleteEntryRequest

Request message for DeleteEntry.

Fields

name

string

Required. The name of the entry to delete.

DeletePolicyTagRequest

Request message for DeletePolicyTag.

Fields

name

string

Required. Resource name of the policy tag to delete.

Note: All of its descendant policy tags are also deleted.

Authorization requires the following IAM permission on the specified resource name:

datacatalog.taxonomies.update

DeleteTagRequest

Request message for DeleteTag.

Fields

name

string

Required. The name of the tag to delete.

DeleteTagTemplateFieldRequest

Request message for DeleteTagTemplateField.

Fields

name

string

Required. The name of the tag template field to delete.

force

bool

Required. If true, deletes this field from any tags that use it.

Currently, true is the only supported value.

DeleteTagTemplateRequest

Request message for DeleteTagTemplate.

Fields

name

string

Required. The name of the tag template to delete.

force

bool

Required. If true, deletes all tags that use this template.

Currently, true is the only supported value.

DeleteTaxonomyRequest

Request message for DeleteTaxonomy.

Fields

name

string

Required. Resource name of the taxonomy to delete.

Note: All policy tags in this taxonomy are also deleted.

Authorization requires the following IAM permission on the specified resource name:

datacatalog.taxonomies.delete

Entry

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

Fields
`name`	`string` Output only. 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.
`linked_resource`	`string` The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the 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.
`fully_qualified_name`	`string` Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. 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}`
`display_name`	`string` Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string.
`description`	`string` 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.
`schema`	`Schema` Schema of the entry. An entry might not have any schema attached to it.
`source_system_timestamps`	`SystemTimestamps` Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a type listed in the `EntryType` enum. For entries with `user_specified_type`, this field is optional and defaults to an empty timestamp.
`usage_signal`	`UsageSignal` Output only. Resource usage statistics.
`labels`	`map<string, string>` 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.
`data_source`	`DataSource` Output only. Physical location of the entry.
Union field `entry_type`. Required. Entry type. `entry_type` can be only one of the following:
`type`	`EntryType` The type of the entry. Only used for entries with types listed in the `EntryType` enum. Currently, only `FILESET` enum value is allowed. All other entries created in Data Catalog must use the `user_specified_type`.
`user_specified_type`	`string` 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.
Union field `system`. The source system of the entry. `system` can be only one of the following:
`integrated_system`	`IntegratedSystem` Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
`user_specified_system`	`string` 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.
Union field `type_spec`. Type specification. `type_spec` can be only one of the following:
`gcs_fileset_spec`	`GcsFilesetSpec` Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type.
`bigquery_table_spec`	`BigQueryTableSpec` Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type.
`bigquery_date_sharded_spec`	`BigQueryDateShardedSpec` Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see Introduction to partitioned tables.
Union field `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`. `spec` can be only one of the following:
`database_table_spec`	`DatabaseTableSpec` Specification that applies to a table resource. Valid only for entries with the `TABLE` type.
`data_source_connection_spec`	`DataSourceConnectionSpec` Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type.
`routine_spec`	`RoutineSpec` Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type.

EntryGroup

Entry group metadata.

An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.

Fields
`name`	`string` 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.
`display_name`	`string` A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
`description`	`string` Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
`data_catalog_timestamps`	`SystemTimestamps` Output only. Timestamps of the entry group. Default value is empty.

EntryType

The enum field that lists all the types of entry resources in Data Catalog. For example, a BigQuery table entry has the TABLE type.

Enums
`ENTRY_TYPE_UNSPECIFIED`	Default unknown type.
`TABLE`	Output only. The entry type that has a GoogleSQL schema, including logical views.
`MODEL`	Output only. The type of models. For more information, see Supported models in BigQuery ML.
`DATA_STREAM`	An entry type for streaming entries. For example, a Pub/Sub topic.
`FILESET`	An entry type for a set of files or objects. For example, a Cloud Storage fileset.
`CLUSTER`	A group of servers that work together. For example, a Kafka cluster.
`DATABASE`	A database.
`DATA_SOURCE_CONNECTION`	Output only. Connection to a data source. For example, a BigQuery connection.
`ROUTINE`	Output only. Routine, for example, a BigQuery routine.
`SERVICE`	A service, for example, a Dataproc Metastore service.

ExportTaxonomiesRequest

Request message for ExportTaxonomies.

Fields

parent

string

Required. Resource name of the project that the exported taxonomies belong to.

Authorization requires the following IAM permission on the specified resource parent:

datacatalog.taxonomies.get

taxonomies[]

string

Required. Resource names of the taxonomies to export.

serialized_taxonomies

bool

Serialized export taxonomies that contain all the policy tags as nested protocol buffers.

ExportTaxonomiesResponse

Response message for ExportTaxonomies.

Fields

taxonomies[]

SerializedTaxonomy

List of taxonomies and policy tags as nested protocol buffers.

FieldType

Fields

Union field type_decl. Required. type_decl can be only one of the following:

primitive_type

PrimitiveType

Primitive types, such as string, boolean, etc.

enum_type

EnumType

An enum type.

EnumType

Fields

allowed_values[]

EnumValue

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.

EnumValue

Fields

display_name

string

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.

PrimitiveType

Enums
`PRIMITIVE_TYPE_UNSPECIFIED`	The default invalid value for a type.
`DOUBLE`	A double precision number.
`STRING`	An UTF-8 string.
`BOOL`	A boolean value.
`TIMESTAMP`	A timestamp.
`RICHTEXT`	A Richtext description.

GcsFileSpec

Specification of a single file in Cloud Storage.

Fields

file_path

string

Required. Full file path. Example: gs://bucket_name/a/b.txt.

gcs_timestamps

SystemTimestamps

Output only. Creation, modification, and expiration timestamps of a Cloud Storage file.

size_bytes

int64

Output only. File size in bytes.

GcsFilesetSpec

Describes a Cloud Storage fileset entry.

Fields

file_patterns[]

string

Required. Patterns to identify a set of files in Google Cloud Storage.

For more information, see Wildcard Names.

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

sample_gcs_file_specs[]

GcsFileSpec

Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.

GetEntryGroupRequest

Request message for GetEntryGroup.

Fields

name

string

Required. The name of the entry group to get.

read_mask

The fields to return. If empty or omitted, all fields are returned.

GetEntryRequest

Request message for GetEntry.

Fields

name

string

Required. The name of the entry to get.

GetPolicyTagRequest

Request message for GetPolicyTag.

Fields

name

string

Required. Resource name of the policy tag.

Authorization requires the following IAM permission on the specified resource name:

datacatalog.taxonomies.get

GetTagTemplateRequest

Request message for GetTagTemplate.

Fields

name

string

Required. The name of the tag template to get.

GetTaxonomyRequest

Request message for GetTaxonomy.

Fields

name

string

Required. Resource name of the taxonomy to get.

Authorization requires the following IAM permission on the specified resource name:

datacatalog.taxonomies.get

ImportTaxonomiesRequest

Request message for ImportTaxonomies.

Fields
`parent`	`string` Required. Resource name of project that the imported taxonomies will belong to. Authorization requires the following IAM permission on the specified resource `parent`: `datacatalog.taxonomies.create`
Union field `source`. Source taxonomies to import. `source` can be only one of the following:
`inline_source`	`InlineSource` Inline source taxonomy to import.
`cross_regional_source`	`CrossRegionalSource` Cross-regional source taxonomy to import.

ImportTaxonomiesResponse

Response message for ImportTaxonomies.

Fields

taxonomies[]

Imported taxonomies.

InlineSource

Inline source containing taxonomies to import.

Fields

taxonomies[]

SerializedTaxonomy

Required. Taxonomies to import.

IntegratedSystem

This enum lists all the systems that Data Catalog integrates with.

Enums
`INTEGRATED_SYSTEM_UNSPECIFIED`	Default unknown system.
`BIGQUERY`	BigQuery.
`CLOUD_PUBSUB`	Cloud Pub/Sub.
`DATAPROC_METASTORE`	Dataproc Metastore.

ListEntriesRequest

Request message for ListEntries.

Fields
`parent`	`string` Required. The name of the entry group that contains the entries to list. Can be provided in URL format.
`page_size`	`int32` 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.
`page_token`	`string` Pagination token that specifies the next page to return. If empty, the first page is returned.
`read_mask`	`FieldMask` 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.

ListEntriesResponse

Response message for ListEntries.

Fields

entries[]

Entry

Entry details.

next_page_token

string

Pagination token of the next results page. Empty if there are no more items in results.

ListEntryGroupsRequest

Request message for ListEntryGroups.

Fields

parent

string

Required. The name of the location that contains the entry groups to list.

Can be provided as a URL.

page_size

int32

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.

page_token

string

Optional. Pagination token that specifies the next page to return. If empty, returns the first page.

ListEntryGroupsResponse

Response message for ListEntryGroups.

Fields

entry_groups[]

EntryGroup

Entry group details.

next_page_token

string

Pagination token to specify in the next call to retrieve the next page of results. Empty if there are no more items.

ListPolicyTagsRequest

Request message for ListPolicyTags.

Fields

parent

string

Required. Resource name of the taxonomy to list the policy tags of.

Authorization requires the following IAM permission on the specified resource parent:

datacatalog.taxonomies.get

page_size

int32

The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.

page_token

string

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.

ListPolicyTagsResponse

Response message for ListPolicyTags.

Fields

policy_tags[]

PolicyTag

The policy tags that belong to the taxonomy.

next_page_token

string

Pagination token of the next results page. Empty if there are no more results in the list.

ListTagsRequest

Request message for ListTags.

Fields

parent

string

Required. The name of the Data Catalog resource to list the tags of.

The resource can be an Entry or an EntryGroup (without /entries/{entries} at the end).

page_size

int32

The maximum number of tags to return. Default is 10. Maximum limit is 1000.

page_token

string

Pagination token that specifies the next page to return. If empty, the first page is returned.

ListTagsResponse

Response message for ListTags.

Fields

tags[]

Tag

Tag details.

next_page_token

string

Pagination token of the next results page. Empty if there are no more items in results.

ListTaxonomiesRequest

Request message for ListTaxonomies.

Fields

parent

string

Required. Resource name of the project to list the taxonomies of.

Authorization requires the following IAM permission on the specified resource parent:

datacatalog.taxonomies.list

page_size

int32

The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.

page_token

string

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.

ListTaxonomiesResponse

Response message for ListTaxonomies.

Fields

taxonomies[]

Taxonomies that the project contains.

next_page_token

string

Pagination token of the next results page. Empty if there are no more results in the list.

LookupEntryRequest

Request message for LookupEntry.

Fields
Union field `target_name`. Required. A full name, SQL name, or a fully qualified name of a Google Cloud Platform resource. `target_name` can be only one of the following:
`linked_resource`	`string` The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see 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}`
`sql_resource`	`string` 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 Standard SQL.
`fully_qualified_name`	`string` 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}`

PolicyTag

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

Fields
`name`	`string` Output only. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
`display_name`	`string` 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.
`description`	`string` 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.
`parent_policy_tag`	`string` 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.
`child_policy_tags[]`	`string` Output only. Resource names of child policy tags of this policy tag.

RenameTagTemplateFieldEnumValueRequest

Request message for RenameTagTemplateFieldEnumValue.

Fields

name

string

Required. The name of the enum field value.

new_enum_value_display_name

string

Required. The new display name of the enum value. For example, my_new_enum_value.

RenameTagTemplateFieldRequest

Request message for RenameTagTemplateField.

Fields

name

string

Required. The name of the tag template.

new_tag_template_field_id

string

Required. The new ID of this tag template field. For example, my_new_field.

ReplaceTaxonomyRequest

Request message for ReplaceTaxonomy.

Fields

name

string

Required. Resource name of the taxonomy to update.

Authorization requires the following IAM permission on the specified resource name:

datacatalog.taxonomies.update

serialized_taxonomy

SerializedTaxonomy

Required. Taxonomy to update along with its child policy tags.

RoutineSpec

Specification that applies to a routine. Valid only for entries with the ROUTINE type.

Fields
`routine_type`	`RoutineType` The type of the routine.
`language`	`string` The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: `SQL` `JAVASCRIPT`
`routine_arguments[]`	`Argument` Arguments of the routine.
`return_type`	`string` Return type of the argument. The exact value depends on the source system and the language.
`definition_body`	`string` The body of the routine.
`bigquery_routine_spec`	`BigQueryRoutineSpec` Fields specific for BigQuery routines.

Argument

Input or output argument of a function or stored procedure.

Fields

name

string

The name of the argument. A return argument of a function might not have a name.

mode

Mode

Specifies whether the argument is input or output.

type

string

Type of the argument. The exact value depends on the source system and the language.

Mode

The input or output mode of the argument.

Enums
`MODE_UNSPECIFIED`	Unspecified mode.
`IN`	The argument is input-only.
`OUT`	The argument is output-only.
`INOUT`	The argument is both an input and an output.

RoutineType

The fine-grained type of the routine.

Enums
`ROUTINE_TYPE_UNSPECIFIED`	Unspecified type.
`SCALAR_FUNCTION`	Non-builtin permanent scalar function.
`PROCEDURE`	Stored procedure.

Schema

Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.

Fields

columns[]

ColumnSchema

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.

SearchCatalogRequest

Request message for SearchCatalog.

Fields
`scope`	`Scope` 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.
`query`	`string` Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. 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`
`page_size`	`int32` Number of results to return in a single search page. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
`page_token`	`string` 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` field of the response to a previous `SearchCatalogRequest` call.
`order_by`	`string` 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 If this parameter is omitted, it defaults to the descending `relevance`.

Scope

The criteria that select the subspace used for query matching.

Fields
`include_org_ids[]`	`string` The list of organization IDs to search within. To find your organization ID, follow the steps from Creating and managing organizations.
`include_project_ids[]`	`string` The list of project IDs to search within. For more information on the distinction between project names, IDs, and numbers, see Projects.
`include_gcp_public_datasets`	`bool` If `true`, include Google Cloud Platform (GCP) public datasets in search results. By default, they are excluded. See Google Cloud Public Datasets for more information.
`restricted_locations[]`	`string` 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. 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.
`include_public_tag_templates`	`bool` Optional. If `true`, include `public tag templates` in the search results. By default, they are included only if you have explicit permissions on them to view them. For example, if you are the owner. Other scope fields, for example, `include_org_ids`, still restrict the returned public tag templates and at least one of them is required.

SearchCatalogResponse

Response message for SearchCatalog.

Fields

results[]

SearchCatalogResult

Search results.

next_page_token

string

Pagination token that can be used in subsequent calls to retrieve the next page of results.

unreachable[]

string

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.

SearchCatalogResult

Result in the response to a search request.

Each result captures details of one entry that matches the search.

Fields
`search_result_type`	`SearchResultType` Type of the search result. You can use this field to determine which get method to call to fetch the full resource.
`search_result_subtype`	`string` 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`.
`relative_resource_name`	`string` 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}`
`linked_resource`	`string` The full name of the Google Cloud resource the entry belongs to. For more information, see Full Resource Name. Example: `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`
`modify_time`	`Timestamp` The last modification timestamp of the entry in the source system.
`fully_qualified_name`	`string` 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`
Union field `system`. The source system of the entry. Applicable only when the `search_result_type` is `ENTRY`. `system` can be only one of the following:
`integrated_system`	`IntegratedSystem` Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
`user_specified_system`	`string` Custom source system that you can manually integrate Data Catalog with.

SearchResultType

The resource types that can be returned in search results.

Enums
`SEARCH_RESULT_TYPE_UNSPECIFIED`	Default unknown type.
`ENTRY`	An `Entry`.
`TAG_TEMPLATE`	A `TagTemplate`.
`ENTRY_GROUP`	An `EntryGroup`.

SerializedPolicyTag

A nested protocol buffer that represents a policy tag and all its descendants.

Fields
`policy_tag`	`string` Resource name of the policy tag. This field is ignored when calling `ImportTaxonomies`.
`display_name`	`string` Required. Display name of the policy tag. At most 200 bytes when encoded in UTF-8.
`description`	`string` Description of the serialized policy tag. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
`child_policy_tags[]`	`SerializedPolicyTag` Children of the policy tag, if any.

SerializedTaxonomy

A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export.

Fields
`display_name`	`string` Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.
`description`	`string` Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
`policy_tags[]`	`SerializedPolicyTag` Top level policy tags associated with the taxonomy, if any.
`activated_policy_types[]`	`PolicyType` A list of policy types that are activated per taxonomy.

SystemTimestamps

Timestamps associated with this resource in a particular system.

Fields

create_time

Creation timestamp of the resource within the given system.

update_time

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.

expire_time

Output only. Expiration timestamp of the resource within the given system.

Currently only applicable to BigQuery resources.

TableSourceType

Table source type.

Enums
`TABLE_SOURCE_TYPE_UNSPECIFIED`	Default unknown type.
`BIGQUERY_VIEW`	Table view.
`BIGQUERY_TABLE`	BigQuery native table.
`BIGQUERY_MATERIALIZED_VIEW`	BigQuery materialized view.

TableSpec

Normal BigQuery table specification.

Fields

grouped_entry

string

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.

Tag

Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template.

See Data Catalog IAM for information on the permissions needed to create or view tags.

Fields
`name`	`string` 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.
`template`	`string` 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.
`template_display_name`	`string` Output only. The display name of the tag template.
`fields`	`map<string, TagField>` 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.
`column`	`string` 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`.

TagField

Contains the value and additional information on a field within a Tag.

Fields
`display_name`	`string` Output only. The display name of this field.
`order`	`int32` Output only. The order of this field with respect to other fields in this tag. Can be set by `Tag`. 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.
Union field `kind`. Required. The value of this field. `kind` can be only one of the following:
`double_value`	`double` The value of a tag field with a double type.
`string_value`	`string` The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters.
`bool_value`	`bool` The value of a tag field with a boolean type.
`timestamp_value`	`Timestamp` The value of a tag field with a timestamp type.
`enum_value`	`EnumValue` The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.
`richtext_value`	`string` 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.

EnumValue

An enum value.

Fields

display_name

string

The display name of the enum value.

TagTemplate

A tag template defines a tag that can have one or more typed fields.

The template is used to create tags that are attached to GCP resources. Tag template roles provide permissions to create, edit, and use the template. For example, see the TagTemplate User role that includes a permission to use the tag template to tag resources.

Fields
`name`	`string` 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.
`display_name`	`string` 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.
`is_publicly_readable`	`bool` Indicates whether this is a public tag template. Every user has view access to a public tag template by default. This means that: Every user can use this tag template to tag an entry. If an entry is tagged using the tag template, the tag is always shown in the response to `ListTags` called on the entry. To get the template using the GetTagTemplate method, you need view access either on the project or the organization the tag template resides in but no other permission is needed. Operations on the tag template other than viewing (for example, editing IAM policies) follow standard IAM structures. Tags created with a public tag template are referred to as public tags. You can search for a public tag by value with a simple search query instead of using a `tag:` predicate. Public tag templates may not appear in search results depending on scope, see: `include_public_tag_templates` Note: If an IAM domain restriction is configured in the tag template's location, the public access will not be enabled but the simple search for tag values will still work.
`fields`	`map<string, TagTemplateField>` 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.

TagTemplateField

The template for an individual field within a tag template.

Fields
`name`	`string` Output only. The resource name of the tag template field in URL format. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}` Note: 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.
`display_name`	`string` 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.
`type`	`FieldType` Required. The type of value this tag field can contain.
`is_required`	`bool` If true, this field is required. Defaults to false.
`description`	`string` The description for this field. Defaults to an empty string.
`order`	`int32` 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.

Taxonomy

A 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

Fields
`name`	`string` Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
`display_name`	`string` 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.
`description`	`string` 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.
`policy_tag_count`	`int32` Output only. Number of policy tags in this taxonomy.
`taxonomy_timestamps`	`SystemTimestamps` Output only. Creation and modification timestamps of this taxonomy.
`activated_policy_types[]`	`PolicyType` Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

PolicyType

Defines policy types where the policy tags can be used for.

Enums
`POLICY_TYPE_UNSPECIFIED`	Unspecified policy type.
`FINE_GRAINED_ACCESS_CONTROL`	Fine-grained access control policy that enables access control on tagged sub-resources.

UpdateEntryGroupRequest

Request message for UpdateEntryGroup.

Fields

entry_group

EntryGroup

Required. Updates for the entry group. The name field must be set.

update_mask

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.

UpdateEntryRequest

Request message for UpdateEntry.

Fields

entry

Entry

Required. Updates for the entry. The name field must be set.

update_mask

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

UpdatePolicyTagRequest

Request message for UpdatePolicyTag.

Fields

policy_tag

PolicyTag

The policy tag to update. You can update only its description, display name, and parent policy tag fields.

Authorization requires the following IAM permission on the specified resource policyTag:

datacatalog.taxonomies.update

update_mask

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.

UpdateTagRequest

Request message for UpdateTag.

Fields

tag

Tag

Required. The updated tag. The "name" field must be set.

update_mask

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.

UpdateTagTemplateFieldRequest

Request message for UpdateTagTemplateField.

Fields

name

string

Required. The name of the tag template field.

tag_template_field

TagTemplateField

Required. The template to update.

update_mask

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.

UpdateTagTemplateRequest

Request message for UpdateTagTemplate.

Fields

tag_template

TagTemplate

Required. The template to update. The name field must be set.

update_mask

Names of fields whose values to overwrite on a tag template. Currently, only display_name 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.

UpdateTaxonomyRequest

Request message for UpdateTaxonomy.

Fields

taxonomy

The taxonomy to update. You can update only its description, display name, and activated policy types.

Authorization requires the following IAM permission on the specified resource taxonomy:

datacatalog.taxonomies.update

update_mask

Specifies fields to update. If not set, defaults to all fields you can update.

For more information, see FieldMask.

UsageSignal

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

Fields

update_time