{ "version_module": true, "baseUrl": "https://datacatalog.googleapis.com/", "batchPath": "batch", "title": "Google Cloud Data Catalog API", "documentationLink": "https://cloud.google.com/data-catalog/docs/", "ownerName": "Google", "kind": "discovery#restDescription", "fullyEncodeReservedExpansion": true, "schemas": { "GoogleCloudDatacatalogV1CrossRegionalSource": { "id": "GoogleCloudDatacatalogV1CrossRegionalSource", "properties": { "taxonomy": { "type": "string", "description": "Required. The resource name of the source taxonomy to import." } }, "description": "Cross-regional source used to import an existing taxonomy into a different region.", "type": "object" }, "GoogleCloudDatacatalogV1BigQueryRoutineSpec": { "id": "GoogleCloudDatacatalogV1BigQueryRoutineSpec", "properties": { "importedLibraries": { "type": "array", "items": { "type": "string" }, "description": "Paths of the imported libraries." } }, "description": "Fields specific for BigQuery routines.", "type": "object" }, "GoogleCloudDatacatalogV1ServiceSpec": { "id": "GoogleCloudDatacatalogV1ServiceSpec", "properties": { "cloudBigtableInstanceSpec": { "description": "Specification that applies to Instance entries of `CLOUD_BIGTABLE` system.", "$ref": "GoogleCloudDatacatalogV1CloudBigtableInstanceSpec" } }, "type": "object", "description": "Specification that applies to a Service resource. Valid only for entries with the `SERVICE` type." }, "GoogleCloudDatacatalogV1GcsFilesetSpec": { "id": "GoogleCloudDatacatalogV1GcsFilesetSpec", "properties": { "filePatterns": { "type": "array", "items": { "type": "string" }, "description": "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`" }, "sampleGcsFileSpecs": { "description": "Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1GcsFileSpec" } } }, "type": "object", "description": "Describes a Cloud Storage fileset entry." }, "GoogleCloudDatacatalogV1PhysicalSchemaThriftSchema": { "id": "GoogleCloudDatacatalogV1PhysicalSchemaThriftSchema", "properties": { "text": { "description": "Thrift IDL source of the schema.", "type": "string" } }, "description": "Schema in Thrift format.", "type": "object" }, "GoogleCloudDatacatalogV1ColumnSchema": { "id": "GoogleCloudDatacatalogV1ColumnSchema", "properties": { "defaultValue": { "description": "Optional. Default value for the column.", "type": "string" }, "type": { "description": "Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes.", "type": "string" }, "gcRule": { "description": "Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.", "type": "string" }, "lookerColumnSpec": { "description": "Looker specific column info of this column.", "$ref": "GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec" }, "highestIndexingType": { "type": "string", "enumDescriptions": [ "Unspecified.", "Column not a part of an index.", "Column Part of non unique index.", "Column part of unique index.", "Column part of the primary key." ], "description": "Optional. Most important inclusion of this column.", "enum": [ "INDEXING_TYPE_UNSPECIFIED", "INDEXING_TYPE_NONE", "INDEXING_TYPE_NON_UNIQUE", "INDEXING_TYPE_UNIQUE", "INDEXING_TYPE_PRIMARY_KEY" ] }, "subcolumns": { "description": "Optional. Schema of sub-columns. A column can have zero or more sub-columns.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1ColumnSchema" } }, "description": { "type": "string", "description": "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." }, "ordinalPosition": { "type": "integer", "description": "Optional. Ordinal position", "format": "int32" }, "mode": { "type": "string", "description": "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`." }, "column": { "type": "string", "description": "Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes." }, "rangeElementType": { "description": "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", "$ref": "GoogleCloudDatacatalogV1ColumnSchemaFieldElementType" } }, "type": "object", "description": "A column within a schema. Columns can be nested inside other columns." }, "GoogleCloudDatacatalogV1TaxonomyService": { "type": "object", "description": "The source system of the Taxonomy.", "id": "GoogleCloudDatacatalogV1TaxonomyService", "properties": { "name": { "type": "string", "enumDescriptions": [ "Default value", "Dataplex Universal Catalog.", "Other" ], "description": "The Google Cloud service name.", "enum": [ "MANAGING_SYSTEM_UNSPECIFIED", "MANAGING_SYSTEM_DATAPLEX", "MANAGING_SYSTEM_OTHER" ] }, "identity": { "description": "The service agent for the service.", "type": "string" } } }, "GoogleCloudDatacatalogV1FilesetSpec": { "id": "GoogleCloudDatacatalogV1FilesetSpec", "properties": { "dataplexFileset": { "description": "Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries.", "$ref": "GoogleCloudDatacatalogV1DataplexFilesetSpec" } }, "type": "object", "description": "Specification that applies to a fileset. Valid only for entries with the 'FILESET' type." }, "GoogleCloudDatacatalogV1ContactsPerson": { "description": "A contact person for the entry.", "type": "object", "id": "GoogleCloudDatacatalogV1ContactsPerson", "properties": { "email": { "type": "string", "description": "Email of the person in the format of `john.doe@xyz`, ``, or `John Doe`." }, "designation": { "type": "string", "description": "Designation of the person, for example, Data Steward." } } }, "Policy": { "id": "Policy", "properties": { "version": { "format": "int32", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array", "items": { "$ref": "Binding" } }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "type": "string", "format": "byte" } }, "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "type": "object" }, "GoogleCloudDatacatalogV1ModifyEntryContactsRequest": { "description": "Request message for ModifyEntryContacts.", "type": "object", "id": "GoogleCloudDatacatalogV1ModifyEntryContactsRequest", "properties": { "contacts": { "description": "Required. The new value for the Contacts.", "$ref": "GoogleCloudDatacatalogV1Contacts" } } }, "GoogleCloudDatacatalogV1DataplexExternalTable": { "type": "object", "description": "External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog 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.", "id": "GoogleCloudDatacatalogV1DataplexExternalTable", "properties": { "fullyQualifiedName": { "type": "string", "description": "Fully qualified name (FQN) of the external table." }, "dataCatalogEntry": { "type": "string", "description": "Name of the Data Catalog entry representing the external table." }, "system": { "description": "Service in which the external table is registered.", "enum": [ "INTEGRATED_SYSTEM_UNSPECIFIED", "BIGQUERY", "CLOUD_PUBSUB", "DATAPROC_METASTORE", "DATAPLEX", "CLOUD_SPANNER", "CLOUD_BIGTABLE", "CLOUD_SQL", "LOOKER", "VERTEX_AI" ], "type": "string", "enumDescriptions": [ "Default unknown system.", "BigQuery.", "Cloud Pub/Sub.", "Dataproc Metastore.", "Dataplex Universal Catalog.", "Cloud Spanner", "Cloud Bigtable", "Cloud Sql", "Looker", "Vertex AI" ] }, "googleCloudResource": { "type": "string", "description": "Google Cloud resource name of the external table." } } }, "GoogleCloudDatacatalogV1GraphSpecGraphElementTable": { "description": "Element table definition.", "type": "object", "id": "GoogleCloudDatacatalogV1GraphSpecGraphElementTable", "properties": { "sourceNodeReference": { "description": "Optional. The source node reference of the edge.", "$ref": "GoogleCloudDatacatalogV1GraphSpecGraphElementTableGraphNodeReference" }, "alias": { "description": "Required. The alias name of the graph element.", "type": "string" }, "elementKeys": { "type": "array", "items": { "type": "string" }, "description": "Required. The name of the keys of the elements in the table." }, "inputSource": { "type": "string", "enumDescriptions": [ "Default unknown input source.", "Table input source.", "View input source." ], "description": "Required. The input source of the graph element.", "enum": [ "INPUT_SOURCE_UNSPECIFIED", "TABLE", "VIEW" ] }, "labelAndProperties": { "description": "Required. The labels and their properties for the graph element.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1GraphSpecGraphElementTableLabelAndProperties" } }, "dynamicLabelColumn": { "description": "Optional. If set, this is the input column for dynamic label in schemaless data model.", "type": "string" }, "dynamicPropertiesColumn": { "description": "Optional. If set, this is the input column for dynamic properties in schemaless data model.", "type": "string" }, "destinationNodeReference": { "description": "Optional. The destination node reference of the edge.", "$ref": "GoogleCloudDatacatalogV1GraphSpecGraphElementTableGraphNodeReference" }, "kind": { "type": "string", "enumDescriptions": [ "Default unknown kind.", "Node kind.", "Edge kind." ], "description": "Required. The kind of the graph element.", "enum": [ "KIND_UNSPECIFIED", "NODE", "EDGE" ] }, "dataSource": { "description": "Required. The name of the data source. This is either a table name or a view name that is used for graph element input source. E.g. `Person` table or `PersonView` view.", "type": "string" } } }, "GoogleCloudDatacatalogV1ReconcileTagsMetadata": { "id": "GoogleCloudDatacatalogV1ReconcileTagsMetadata", "properties": { "errors": { "type": "object", "description": "Maps the name of each tagged column (or empty string for a sole entry) to tagging operation status.", "additionalProperties": { "$ref": "Status" } }, "state": { "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "The reconciliation has been queued and awaits for execution.", "The reconciliation is in progress.", "The reconciliation has been finished." ], "description": "State of the reconciliation operation.", "enum": [ "RECONCILIATION_STATE_UNSPECIFIED", "RECONCILIATION_QUEUED", "RECONCILIATION_IN_PROGRESS", "RECONCILIATION_DONE" ] } }, "description": "Long-running operation metadata message returned by the ReconcileTags.", "type": "object" }, "GoogleCloudDatacatalogV1VertexDatasetSpec": { "id": "GoogleCloudDatacatalogV1VertexDatasetSpec", "properties": { "dataItemCount": { "format": "int64", "description": "The number of DataItems in this Dataset. Only apply for non-structured Dataset.", "type": "string" }, "dataType": { "type": "string", "enumDescriptions": [ "Should not be used.", "Structured data dataset.", "Image dataset which supports ImageClassification, ImageObjectDetection and ImageSegmentation problems.", "Document dataset which supports TextClassification, TextExtraction and TextSentiment problems.", "Video dataset which supports VideoClassification, VideoObjectTracking and VideoActionRecognition problems.", "Conversation dataset which supports conversation problems.", "TimeSeries dataset.", "Document dataset which supports DocumentAnnotation problems.", "TextToSpeech dataset which supports TextToSpeech problems.", "Translation dataset which supports Translation problems.", "Store Vision dataset which is used for HITL integration.", "Enterprise Knowledge Graph dataset which is used for HITL labeling integration.", "Text prompt dataset which supports Large Language Models." ], "description": "Type of the dataset.", "enum": [ "DATA_TYPE_UNSPECIFIED", "TABLE", "IMAGE", "TEXT", "VIDEO", "CONVERSATION", "TIME_SERIES", "DOCUMENT", "TEXT_TO_SPEECH", "TRANSLATION", "STORE_VISION", "ENTERPRISE_KNOWLEDGE_GRAPH", "TEXT_PROMPT" ] } }, "type": "object", "description": "Specification for vertex dataset resources." }, "GoogleCloudDatacatalogV1SearchCatalogRequestScope": { "id": "GoogleCloudDatacatalogV1SearchCatalogRequestScope", "properties": { "includePublicTagTemplates": { "deprecated": true, "type": "boolean", "description": "Optional. This field is deprecated. The search mechanism for public and private tag templates is the same." }, "starredOnly": { "description": "Optional. If `true`, search only among starred entries. By default, all results are returned, starred or not.", "type": "boolean" }, "includeGcpPublicDatasets": { "type": "boolean", "description": "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." }, "includeProjectIds": { "description": "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).", "type": "array", "items": { "type": "string" } }, "includeOrgIds": { "type": "array", "items": { "type": "string" }, "description": "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)." }, "restrictedLocations": { "type": "array", "items": { "type": "string" }, "description": "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." } }, "type": "object", "description": "The criteria that select the subspace used for query matching." }, "GoogleCloudDatacatalogV1ListTagsResponse": { "id": "GoogleCloudDatacatalogV1ListTagsResponse", "properties": { "tags": { "description": "Tag details.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1Tag" } }, "nextPageToken": { "type": "string", "description": "Pagination token of the next results page. Empty if there are no more items in results." } }, "description": "Response message for ListTags.", "type": "object" }, "GoogleCloudDatacatalogV1DatabaseTableSpec": { "type": "object", "description": "Specification that applies to a table resource. Valid only for entries with the `TABLE` type.", "id": "GoogleCloudDatacatalogV1DatabaseTableSpec", "properties": { "type": { "description": "Type of this table.", "enum": [ "TABLE_TYPE_UNSPECIFIED", "NATIVE", "EXTERNAL" ], "type": "string", "enumDescriptions": [ "Default unknown table type.", "Native table.", "External table." ] }, "dataplexTable": { "$ref": "GoogleCloudDatacatalogV1DataplexTableSpec", "readOnly": true, "description": "Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries." }, "databaseViewSpec": { "description": "Spec what applies to tables that are actually views. Not set for \"real\" tables.", "$ref": "GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec" } } }, "GoogleCloudDatacatalogV1PhysicalSchemaOrcSchema": { "description": "Marks an ORC-encoded data source.", "type": "object", "id": "GoogleCloudDatacatalogV1PhysicalSchemaOrcSchema", "properties": {} }, "GoogleCloudDatacatalogV1SpannerTableSpecSpannerPrimaryKey": { "description": "Specification of a Spanner primary key.", "type": "object", "id": "GoogleCloudDatacatalogV1SpannerTableSpecSpannerPrimaryKey", "properties": { "columns": { "description": "Output only. Column names of the primary key.", "readOnly": true, "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDatacatalogV1GraphSpecGraphElementTableGraphNodeReference": { "id": "GoogleCloudDatacatalogV1GraphSpecGraphElementTableGraphNodeReference", "properties": { "nodeTableColumns": { "description": "Required. The referenced columns of the source node table.", "type": "array", "items": { "type": "string" } }, "nodeAlias": { "description": "Required. The reference to the source/destination node of the edge. This name must be a valid `alias` of a node element in the same graph. Example, `Person` node can be a source node name of an edge element `Person_to_Address`.", "type": "string" }, "edgeTableColumns": { "description": "Required. The referencing columns in the edge table. The size of `edge_table_columns` must be equal to the size of `node_table_columns`.", "type": "array", "items": { "type": "string" } } }, "description": "A reference to a source or destination node in a graph edge.", "type": "object" }, "GetIamPolicyRequest": { "type": "object", "description": "Request message for `GetIamPolicy` method.", "id": "GetIamPolicyRequest", "properties": { "options": { "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.", "$ref": "GetPolicyOptions" } } }, "GoogleCloudDatacatalogV1VertexModelSpec": { "id": "GoogleCloudDatacatalogV1VertexModelSpec", "properties": { "containerImageUri": { "type": "string", "description": "URI of the Docker image to be used as the custom container for serving predictions." }, "versionId": { "description": "The version ID of the model.", "type": "string" }, "versionAliases": { "type": "array", "items": { "type": "string" }, "description": "User provided version aliases so that a model version can be referenced via alias" }, "vertexModelSourceInfo": { "description": "Source of a Vertex model.", "$ref": "GoogleCloudDatacatalogV1VertexModelSourceInfo" }, "versionDescription": { "type": "string", "description": "The description of this version." } }, "description": "Specification for vertex model resources.", "type": "object" }, "GoogleCloudDatacatalogV1ImportEntriesMetadata": { "type": "object", "description": "Metadata message for long-running operation returned by the ImportEntries.", "id": "GoogleCloudDatacatalogV1ImportEntriesMetadata", "properties": { "errors": { "type": "array", "items": { "$ref": "Status" }, "description": "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." }, "state": { "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "The dump with entries has been queued for import.", "The import of entries is in progress.", "The import of entries has been finished.", "The import of entries has been abandoned in favor of a newer request." ], "description": "State of the import operation.", "enum": [ "IMPORT_STATE_UNSPECIFIED", "IMPORT_QUEUED", "IMPORT_IN_PROGRESS", "IMPORT_DONE", "IMPORT_OBSOLETE" ] } } }, "GoogleCloudDatacatalogV1VertexModelSourceInfo": { "type": "object", "description": "Detail description of the source information of a Vertex model.", "id": "GoogleCloudDatacatalogV1VertexModelSourceInfo", "properties": { "copy": { "description": "If this Model is copy of another Model. If true then source_type pertains to the original.", "type": "boolean" }, "sourceType": { "type": "string", "enumDescriptions": [ "Should not be used.", "The Model is uploaded by automl training pipeline.", "The Model is uploaded by user or custom training pipeline.", "The Model is registered and sync'ed from BigQuery ML.", "The Model is saved or tuned from Model Garden.", "The Model is saved or tuned from Genie.", "The Model is uploaded by text embedding finetuning pipeline.", "The Model is saved or tuned from Marketplace." ], "description": "Type of the model source.", "enum": [ "MODEL_SOURCE_TYPE_UNSPECIFIED", "AUTOML", "CUSTOM", "BQML", "MODEL_GARDEN", "GENIE", "CUSTOM_TEXT_EMBEDDING", "MARKETPLACE" ] } } }, "GoogleCloudDatacatalogV1TaggedEntry": { "description": "Wrapper containing Entry and information about Tags that should and should not be attached to it.", "type": "object", "id": "GoogleCloudDatacatalogV1TaggedEntry", "properties": { "absentTags": { "description": "Optional. Tags that should be deleted from the Data Catalog. Caller should populate template name and column only.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1Tag" } }, "presentTags": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "description": "Optional. Tags that should be ingested into the Data Catalog. Caller should populate template name, column and fields." }, "v1Entry": { "description": "Non-encrypted Data Catalog v1 Entry.", "$ref": "GoogleCloudDatacatalogV1Entry" } } }, "GoogleCloudDatacatalogV1GraphSpec": { "id": "GoogleCloudDatacatalogV1GraphSpec", "properties": { "name": { "readOnly": true, "type": "string", "description": "Output only. Fully qualified graph name. e.g. `named_catalog.MyGraph`" }, "edgeTables": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1GraphSpecGraphElementTable" }, "description": "Optional. Edge tables of the graph." }, "nodeTables": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1GraphSpecGraphElementTable" }, "description": "Required. Node tables of the graph." } }, "description": "Specification that applies to a graph.", "type": "object" }, "GoogleCloudDatacatalogV1DataSourceConnectionSpec": { "description": "Specification 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.", "type": "object", "id": "GoogleCloudDatacatalogV1DataSourceConnectionSpec", "properties": { "bigqueryConnectionSpec": { "description": "Output only. Fields specific to BigQuery connections.", "$ref": "GoogleCloudDatacatalogV1BigQueryConnectionSpec" } } }, "GoogleCloudDatacatalogV1UsageStats": { "id": "GoogleCloudDatacatalogV1UsageStats", "properties": { "totalExecutionTimeForCompletionsMillis": { "format": "float", "description": "Total time spent only on successful uses, in milliseconds.", "type": "number" }, "totalCompletions": { "format": "float", "description": "The number of successful uses of the underlying entry.", "type": "number" }, "totalCancellations": { "format": "float", "type": "number", "description": "The number of cancelled attempts to use the underlying entry." }, "totalFailures": { "type": "number", "description": "The number of failed attempts to use the underlying entry.", "format": "float" } }, "type": "object", "description": "Detailed 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)" }, "GoogleCloudDatacatalogV1CloudBigtableInstanceSpecCloudBigtableClusterSpec": { "id": "GoogleCloudDatacatalogV1CloudBigtableInstanceSpecCloudBigtableClusterSpec", "properties": { "type": { "description": "Type of the resource. For a cluster this would be \"CLUSTER\".", "type": "string" }, "linkedResource": { "description": "A link back to the parent resource, in this case Instance.", "type": "string" }, "displayName": { "description": "Name of the cluster.", "type": "string" }, "location": { "type": "string", "description": "Location of the cluster, typically a Cloud zone." } }, "type": "object", "description": "Spec that applies to clusters of an Instance of Cloud Bigtable." }, "GoogleCloudDatacatalogV1TableSpec": { "type": "object", "description": "Normal BigQuery table specification.", "id": "GoogleCloudDatacatalogV1TableSpec", "properties": { "groupedEntry": { "description": "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.", "readOnly": true, "type": "string" } } }, "GoogleCloudDatacatalogV1BusinessContext": { "id": "GoogleCloudDatacatalogV1BusinessContext", "properties": { "contacts": { "description": "Contact people for the entry.", "$ref": "GoogleCloudDatacatalogV1Contacts" }, "entryOverview": { "description": "Entry overview fields for rich text descriptions of entries.", "$ref": "GoogleCloudDatacatalogV1EntryOverview" } }, "description": "Business Context of the entry.", "type": "object" }, "GoogleCloudDatacatalogV1GraphSpecGraphElementTableProperty": { "id": "GoogleCloudDatacatalogV1GraphSpecGraphElementTableProperty", "properties": { "name": { "type": "string", "description": "Required. Property name." }, "type": { "type": "string", "description": "Required. Property data type." } }, "description": "A property declaration.", "type": "object" }, "GoogleCloudDatacatalogV1PhysicalSchemaCsvSchema": { "id": "GoogleCloudDatacatalogV1PhysicalSchemaCsvSchema", "properties": {}, "description": "Marks a CSV-encoded data source.", "type": "object" }, "GoogleCloudDatacatalogV1SearchCatalogResult": { "id": "GoogleCloudDatacatalogV1SearchCatalogResult", "properties": { "searchResultType": { "type": "string", "enumDescriptions": [ "Default unknown type.", "An Entry.", "A TagTemplate.", "An EntryGroup." ], "description": "Type of the search result. You can use this field to determine which get method to call to fetch the full resource.", "enum": [ "SEARCH_RESULT_TYPE_UNSPECIFIED", "ENTRY", "TAG_TEMPLATE", "ENTRY_GROUP" ] }, "relativeResourceName": { "type": "string", "description": "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}`" }, "description": { "description": "Entry description that can consist of several sentences or paragraphs that describe entry contents.", "type": "string" }, "integratedSystem": { "description": "Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.", "enum": [ "INTEGRATED_SYSTEM_UNSPECIFIED", "BIGQUERY", "CLOUD_PUBSUB", "DATAPROC_METASTORE", "DATAPLEX", "CLOUD_SPANNER", "CLOUD_BIGTABLE", "CLOUD_SQL", "LOOKER", "VERTEX_AI" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Default unknown system.", "BigQuery.", "Cloud Pub/Sub.", "Dataproc Metastore.", "Dataplex Universal Catalog.", "Cloud Spanner", "Cloud Bigtable", "Cloud Sql", "Looker", "Vertex AI" ] }, "searchResultSubtype": { "type": "string", "description": "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`." }, "modifyTime": { "type": "string", "description": "The last modification timestamp of the entry in the source system.", "format": "google-datetime" }, "userSpecifiedSystem": { "type": "string", "description": "Custom source system that you can manually integrate Data Catalog with." }, "fullyQualifiedName": { "type": "string", "description": "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`" }, "displayName": { "type": "string", "description": "The display name of the result." }, "linkedResource": { "description": "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`", "type": "string" } }, "type": "object", "description": "Result in the response to a search request. Each result captures details of one entry that matches the search." }, "GoogleCloudDatacatalogV1DumpItem": { "type": "object", "description": "Wrapper for any item that can be contained in the dump.", "id": "GoogleCloudDatacatalogV1DumpItem", "properties": { "taggedEntry": { "description": "Entry and its tags.", "$ref": "GoogleCloudDatacatalogV1TaggedEntry" } } }, "GoogleCloudDatacatalogV1UsageSignal": { "id": "GoogleCloudDatacatalogV1UsageSignal", "properties": { "favoriteCount": { "description": "Favorite count in the source system.", "type": "string", "format": "int64" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "The end timestamp of the duration of usage statistics." }, "usageWithinTimeRange": { "additionalProperties": { "$ref": "GoogleCloudDatacatalogV1UsageStats" }, "readOnly": true, "type": "object", "description": "Output only. BigQuery usage statistics over each of the predefined time ranges. Supported time ranges are `{\"24H\", \"7D\", \"30D\"}`." }, "commonUsageWithinTimeRange": { "type": "object", "description": "Common usage statistics over each of the predefined time ranges. Supported time ranges are `{\"24H\", \"7D\", \"30D\", \"Lifetime\"}`.", "additionalProperties": { "$ref": "GoogleCloudDatacatalogV1CommonUsageStats" } } }, "type": "object", "description": "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." }, "GoogleCloudDatacatalogV1RoutineSpecArgument": { "type": "object", "description": "Input or output argument of a function or stored procedure.", "id": "GoogleCloudDatacatalogV1RoutineSpecArgument", "properties": { "name": { "description": "The name of the argument. A return argument of a function might not have a name.", "type": "string" }, "mode": { "description": "Specifies whether the argument is input or output.", "enum": [ "MODE_UNSPECIFIED", "IN", "OUT", "INOUT" ], "type": "string", "enumDescriptions": [ "Unspecified mode.", "The argument is input-only.", "The argument is output-only.", "The argument is both an input and an output." ] }, "type": { "description": "Type of the argument. The exact value depends on the source system and the language.", "type": "string" } } }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "id": "ListOperationsResponse", "properties": { "operations": { "type": "array", "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDatacatalogV1ModifyEntryOverviewRequest": { "description": "Request message for ModifyEntryOverview.", "type": "object", "id": "GoogleCloudDatacatalogV1ModifyEntryOverviewRequest", "properties": { "entryOverview": { "description": "Required. The new value for the Entry Overview.", "$ref": "GoogleCloudDatacatalogV1EntryOverview" } } }, "GoogleCloudDatacatalogV1SqlDatabaseSystemSpec": { "id": "GoogleCloudDatacatalogV1SqlDatabaseSystemSpec", "properties": { "sqlEngine": { "type": "string", "description": "SQL Database Engine. enum SqlEngine { UNDEFINED = 0; MY_SQL = 1; POSTGRE_SQL = 2; SQL_SERVER = 3; } Engine of the enclosing database instance." }, "databaseVersion": { "description": "Version of the database engine.", "type": "string" }, "instanceHost": { "type": "string", "description": "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." } }, "description": "Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_type)", "type": "object" }, "GoogleCloudDatacatalogV1SpannerTableSpecSpannerForeignKeyForeignKeyColumnMapping": { "id": "GoogleCloudDatacatalogV1SpannerTableSpecSpannerForeignKeyForeignKeyColumnMapping", "properties": { "column": { "readOnly": true, "type": "string", "description": "Output only. The column in the current table that is part of the foreign key." }, "referenceColumn": { "readOnly": true, "type": "string", "description": "Output only. The column in the referenced table that is part of the foreign key." } }, "description": "Column mapping for a Spanner foreign key.", "type": "object" }, "GoogleCloudDatacatalogV1SpannerTableSpec": { "type": "object", "description": "Specification of a Spanner table.", "id": "GoogleCloudDatacatalogV1SpannerTableSpec", "properties": { "primaryKey": { "$ref": "GoogleCloudDatacatalogV1SpannerTableSpecSpannerPrimaryKey", "readOnly": true, "description": "Output only. The primary key of the table." }, "foreignKeys": { "description": "Output only. The foreign keys of the table.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1SpannerTableSpecSpannerForeignKey" } } } }, "GoogleCloudDatacatalogV1PhysicalSchemaProtobufSchema": { "description": "Schema in protocol buffer format.", "type": "object", "id": "GoogleCloudDatacatalogV1PhysicalSchemaProtobufSchema", "properties": { "text": { "type": "string", "description": "Protocol buffer source of the schema." } } }, "GoogleCloudDatacatalogV1TagField": { "description": "Contains the value and additional information on a field within a Tag.", "type": "object", "id": "GoogleCloudDatacatalogV1TagField", "properties": { "doubleValue": { "type": "number", "description": "The value of a tag field with a double type.", "format": "double" }, "boolValue": { "description": "The value of a tag field with a boolean type.", "type": "boolean" }, "enumValue": { "description": "The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum.", "$ref": "GoogleCloudDatacatalogV1TagFieldEnumValue" }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of this field." }, "stringValue": { "type": "string", "description": "The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters." }, "timestampValue": { "type": "string", "description": "The value of a tag field with a timestamp type.", "format": "google-datetime" }, "richtextValue": { "type": "string", "description": "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." }, "order": { "description": "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.", "readOnly": true, "type": "integer", "format": "int32" } } }, "GoogleCloudDatacatalogV1ReconcileTagsRequest": { "id": "GoogleCloudDatacatalogV1ReconcileTagsRequest", "properties": { "forceDeleteMissing": { "type": "boolean" }, "tagTemplate": { "description": "Required. The name of the tag template, which is used for reconciliation.", "type": "string" }, "tags": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "description": "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." } }, "type": "object", "description": "Request message for ReconcileTags." }, "GoogleCloudDatacatalogV1UnstarEntryRequest": { "type": "object", "description": "Request message for UnstarEntry.", "id": "GoogleCloudDatacatalogV1UnstarEntryRequest", "properties": {} }, "GoogleCloudDatacatalogV1Contacts": { "id": "GoogleCloudDatacatalogV1Contacts", "properties": { "people": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1ContactsPerson" }, "description": "The list of contact people for the entry." } }, "type": "object", "description": "Contact people for the entry." }, "GoogleCloudDatacatalogV1PersonalDetails": { "description": "Entry metadata relevant only to the user and private to them.", "type": "object", "id": "GoogleCloudDatacatalogV1PersonalDetails", "properties": { "starred": { "type": "boolean", "description": "True if the entry is starred by the user; false otherwise." }, "starTime": { "description": "Set if the entry is starred; unset otherwise.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDatacatalogV1OrganizationConfig": { "description": "The configuration related to the migration from Data Catalog to Dataplex Universal Catalog that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig.", "type": "object", "id": "GoogleCloudDatacatalogV1OrganizationConfig", "properties": { "config": { "additionalProperties": { "$ref": "GoogleCloudDatacatalogV1MigrationConfig" }, "type": "object", "description": "Map of organizations and project resource names and their configuration. The format for the map keys is `organizations/{organizationId}` or `projects/{projectId}`." } } }, "Status": { "id": "Status", "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object" }, "GoogleCloudDatacatalogV1SystemTimestamps": { "description": "Timestamps associated with this resource in a particular system.", "type": "object", "id": "GoogleCloudDatacatalogV1SystemTimestamps", "properties": { "expireTime": { "description": "Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Creation timestamp of the resource within the given system.", "type": "string", "format": "google-datetime" }, "updateTime": { "format": "google-datetime", "description": "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.", "type": "string" } } }, "GoogleCloudDatacatalogV1ImportEntriesRequest": { "type": "object", "description": "Request message for ImportEntries method.", "id": "GoogleCloudDatacatalogV1ImportEntriesRequest", "properties": { "gcsBucketPath": { "description": "Path to a Cloud Storage bucket that contains a dump ready for ingestion.", "type": "string" }, "jobId": { "description": "Optional. (Optional) Dataplex Universal Catalog task job id, if specified will be used as part of ImportEntries LRO ID", "type": "string" } } }, "GoogleCloudDatacatalogV1ReplaceTaxonomyRequest": { "id": "GoogleCloudDatacatalogV1ReplaceTaxonomyRequest", "properties": { "serializedTaxonomy": { "description": "Required. Taxonomy to update along with its child policy tags.", "$ref": "GoogleCloudDatacatalogV1SerializedTaxonomy" } }, "description": "Request message for ReplaceTaxonomy.", "type": "object" }, "GoogleCloudDatacatalogV1FieldType": { "id": "GoogleCloudDatacatalogV1FieldType", "properties": { "primitiveType": { "type": "string", "enumDescriptions": [ "The default invalid value for a type.", "A double precision number.", "An UTF-8 string.", "A boolean value.", "A timestamp.", "A Richtext description." ], "description": "Primitive types, such as string, boolean, etc.", "enum": [ "PRIMITIVE_TYPE_UNSPECIFIED", "DOUBLE", "STRING", "BOOL", "TIMESTAMP", "RICHTEXT" ] }, "enumType": { "description": "An enum type.", "$ref": "GoogleCloudDatacatalogV1FieldTypeEnumType" } }, "type": "object" }, "GoogleCloudDatacatalogV1FeatureOnlineStoreSpec": { "description": "Detail description of the source information of a Vertex Feature Online Store.", "type": "object", "id": "GoogleCloudDatacatalogV1FeatureOnlineStoreSpec", "properties": { "storageType": { "readOnly": true, "type": "string", "enumDescriptions": [ "Should not be used.", "Underlsying storgae is Bigtable.", "Underlying is optimized online server (Lightning)." ], "description": "Output only. Type of underlying storage for the FeatureOnlineStore.", "enum": [ "STORAGE_TYPE_UNSPECIFIED", "BIGTABLE", "OPTIMIZED" ] } } }, "GoogleCloudDatacatalogV1CommonUsageStats": { "id": "GoogleCloudDatacatalogV1CommonUsageStats", "properties": { "viewCount": { "format": "int64", "description": "View count in source system.", "type": "string" } }, "description": "Common statistics on the entry's usage. They can be set on any system.", "type": "object" }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "type": "object", "id": "TestIamPermissionsRequest", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)." } } }, "GoogleCloudDatacatalogV1BigQueryConnectionSpec": { "id": "GoogleCloudDatacatalogV1BigQueryConnectionSpec", "properties": { "hasCredential": { "type": "boolean", "description": "True if there are credentials attached to the BigQuery connection; false otherwise." }, "connectionType": { "description": "The type of the BigQuery connection.", "enum": [ "CONNECTION_TYPE_UNSPECIFIED", "CLOUD_SQL" ], "type": "string", "enumDescriptions": [ "Unspecified type.", "Cloud SQL connection." ] }, "cloudSql": { "description": "Specification for the BigQuery connection to a Cloud SQL instance.", "$ref": "GoogleCloudDatacatalogV1CloudSqlBigQueryConnectionSpec" } }, "type": "object", "description": "Specification for the BigQuery connection." }, "GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec": { "type": "object", "description": "Column info specific to Looker System.", "id": "GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec", "properties": { "type": { "description": "Looker specific column type of this column.", "enum": [ "LOOKER_COLUMN_TYPE_UNSPECIFIED", "DIMENSION", "DIMENSION_GROUP", "FILTER", "MEASURE", "PARAMETER" ], "type": "string", "enumDescriptions": [ "Unspecified.", "Dimension.", "Dimension group - parent for Dimension.", "Filter.", "Measure.", "Parameter." ] } } }, "GoogleCloudDatacatalogV1GcsFileSpec": { "description": "Specification of a single file in Cloud Storage.", "type": "object", "id": "GoogleCloudDatacatalogV1GcsFileSpec", "properties": { "filePath": { "description": "Required. Full file path. Example: `gs://bucket_name/a/b.txt`.", "type": "string" }, "gcsTimestamps": { "$ref": "GoogleCloudDatacatalogV1SystemTimestamps", "description": "Output only. Creation, modification, and expiration timestamps of a Cloud Storage file.", "readOnly": true }, "sizeBytes": { "format": "int64", "readOnly": true, "type": "string", "description": "Output only. File size in bytes." } } }, "GoogleCloudDatacatalogV1PhysicalSchemaParquetSchema": { "type": "object", "description": "Marks a Parquet-encoded data source.", "id": "GoogleCloudDatacatalogV1PhysicalSchemaParquetSchema", "properties": {} }, "TestIamPermissionsResponse": { "id": "TestIamPermissionsResponse", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed." } }, "type": "object", "description": "Response message for `TestIamPermissions` method." }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation", "properties": { "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "metadata": { "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" } } }, "GoogleCloudDatacatalogV1DataSource": { "type": "object", "description": "Physical location of an entry.", "id": "GoogleCloudDatacatalogV1DataSource", "properties": { "resource": { "description": "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}`", "type": "string" }, "storageProperties": { "description": "Detailed properties of the underlying storage.", "$ref": "GoogleCloudDatacatalogV1StorageProperties" }, "service": { "type": "string", "enumDescriptions": [ "Default unknown service.", "Google Cloud Storage service.", "BigQuery service." ], "description": "Service that physically stores the data.", "enum": [ "SERVICE_UNSPECIFIED", "CLOUD_STORAGE", "BIGQUERY" ] }, "sourceEntry": { "description": "Output only. Data Catalog entry name, if applicable.", "readOnly": true, "type": "string" } } }, "GoogleCloudDatacatalogV1Schema": { "type": "object", "description": "Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.", "id": "GoogleCloudDatacatalogV1Schema", "properties": { "columns": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1ColumnSchema" }, "description": "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." } } }, "GoogleCloudDatacatalogV1FieldTypeEnumTypeEnumValue": { "type": "object", "id": "GoogleCloudDatacatalogV1FieldTypeEnumTypeEnumValue", "properties": { "displayName": { "description": "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.", "type": "string" } } }, "Empty": { "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "properties": {} }, "GoogleCloudDatacatalogV1Entry": { "id": "GoogleCloudDatacatalogV1Entry", "properties": { "spannerTableSpec": { "description": "Specification of a Spanner table.", "$ref": "GoogleCloudDatacatalogV1SpannerTableSpec" }, "usageSignal": { "description": "Resource usage statistics.", "$ref": "GoogleCloudDatacatalogV1UsageSignal" }, "routineSpec": { "description": "Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type.", "$ref": "GoogleCloudDatacatalogV1RoutineSpec" }, "modelSpec": { "description": "Model specification.", "$ref": "GoogleCloudDatacatalogV1ModelSpec" }, "databaseTableSpec": { "description": "Specification that applies to a table resource. Valid only for entries with the `TABLE` or `EXPLORE` type.", "$ref": "GoogleCloudDatacatalogV1DatabaseTableSpec" }, "userSpecifiedType": { "type": "string", "description": "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." }, "graphSpec": { "description": "Spec for graph.", "$ref": "GoogleCloudDatacatalogV1GraphSpec" }, "datasetSpec": { "description": "Specification that applies to a dataset.", "$ref": "GoogleCloudDatacatalogV1DatasetSpec" }, "dataSource": { "$ref": "GoogleCloudDatacatalogV1DataSource", "description": "Output only. Physical location of the entry.", "readOnly": true }, "integratedSystem": { "description": "Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.", "enum": [ "INTEGRATED_SYSTEM_UNSPECIFIED", "BIGQUERY", "CLOUD_PUBSUB", "DATAPROC_METASTORE", "DATAPLEX", "CLOUD_SPANNER", "CLOUD_BIGTABLE", "CLOUD_SQL", "LOOKER", "VERTEX_AI" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Default unknown system.", "BigQuery.", "Cloud Pub/Sub.", "Dataproc Metastore.", "Dataplex Universal Catalog.", "Cloud Spanner", "Cloud Bigtable", "Cloud Sql", "Looker", "Vertex AI" ] }, "filesetSpec": { "description": "Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type.", "$ref": "GoogleCloudDatacatalogV1FilesetSpec" }, "linkedResource": { "description": "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.", "type": "string" }, "type": { "type": "string", "enumDescriptions": [ "Default unknown type.", "The entry type that has a GoogleSQL schema, including logical views.", "The type of models. For more information, see [Supported models in BigQuery ML](/bigquery/docs/bqml-introduction#supported_models).", "An entry type for streaming entries. For example, a Pub/Sub topic.", "An entry type for a set of files or objects. For example, a Cloud Storage fileset.", "A group of servers that work together. For example, a Kafka cluster.", "A database.", "Connection to a data source. For example, a BigQuery connection.", "Routine, for example, a BigQuery routine.", "A Dataplex Universal Catalog lake.", "A Dataplex Universal Catalog zone.", "A service, for example, a Dataproc Metastore service.", "Schema within a relational database.", "A Dashboard, for example from Looker.", "A Looker Explore. For more information, see [Looker Explore API] (https://developers.looker.com/api/explorer/4.0/methods/LookmlModel/lookml_model_explore).", "A Looker Look. For more information, see [Looker Look API] (https://developers.looker.com/api/explorer/4.0/methods/Look).", "Feature Online Store resource in Vertex AI Feature Store.", "Feature View resource in Vertex AI Feature Store.", "Feature Group resource in Vertex AI Feature Store.", "An entry type for a graph." ], "description": "The type of the entry. For details, see [`EntryType`](#entrytype).", "enum": [ "ENTRY_TYPE_UNSPECIFIED", "TABLE", "MODEL", "DATA_STREAM", "FILESET", "CLUSTER", "DATABASE", "DATA_SOURCE_CONNECTION", "ROUTINE", "LAKE", "ZONE", "SERVICE", "DATABASE_SCHEMA", "DASHBOARD", "EXPLORE", "LOOK", "FEATURE_ONLINE_STORE", "FEATURE_VIEW", "FEATURE_GROUP", "GRAPH" ] }, "bigqueryDateShardedSpec": { "readOnly": true, "description": "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).", "$ref": "GoogleCloudDatacatalogV1BigQueryDateShardedSpec" }, "featureOnlineStoreSpec": { "description": "FeatureonlineStore spec for Vertex AI Feature Store.", "$ref": "GoogleCloudDatacatalogV1FeatureOnlineStoreSpec" }, "lookerSystemSpec": { "description": "Specification that applies to Looker sysstem. Only settable when `user_specified_system` is equal to `LOOKER`", "$ref": "GoogleCloudDatacatalogV1LookerSystemSpec" }, "name": { "description": "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.", "readOnly": true, "type": "string" }, "sqlDatabaseSystemSpec": { "description": "Specification that applies to a relational database system. Only settable when `user_specified_system` is equal to `SQL_DATABASE`", "$ref": "GoogleCloudDatacatalogV1SqlDatabaseSystemSpec" }, "displayName": { "description": "Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.", "type": "string" }, "bigqueryTableSpec": { "description": "Output only. Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type.", "readOnly": true, "$ref": "GoogleCloudDatacatalogV1BigQueryTableSpec" }, "cloudBigtableSystemSpec": { "description": "Specification that applies to Cloud Bigtable system. Only settable when `integrated_system` is equal to `CLOUD_BIGTABLE`", "$ref": "GoogleCloudDatacatalogV1CloudBigtableSystemSpec" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "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." }, "dataSourceConnectionSpec": { "description": "Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type.", "$ref": "GoogleCloudDatacatalogV1DataSourceConnectionSpec" }, "personalDetails": { "readOnly": true, "description": "Output only. Additional information related to the entry. Private to the current user.", "$ref": "GoogleCloudDatacatalogV1PersonalDetails" }, "gcsFilesetSpec": { "description": "Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type.", "$ref": "GoogleCloudDatacatalogV1GcsFilesetSpec" }, "serviceSpec": { "description": "Specification that applies to a Service resource.", "$ref": "GoogleCloudDatacatalogV1ServiceSpec" }, "description": { "type": "string", "description": "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." }, "sourceSystemTimestamps": { "description": "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.", "$ref": "GoogleCloudDatacatalogV1SystemTimestamps" }, "schema": { "description": "Schema of the entry. An entry might not have any schema attached to it.", "$ref": "GoogleCloudDatacatalogV1Schema" }, "businessContext": { "description": "Business Context of the entry. Not supported for BigQuery datasets", "$ref": "GoogleCloudDatacatalogV1BusinessContext" }, "fullyQualifiedName": { "type": "string", "description": "[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. " }, "userSpecifiedSystem": { "type": "string", "description": "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." } }, "description": "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.", "type": "object" }, "Expr": { "type": "object", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", "properties": { "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "location": { "type": "string", "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" } } }, "GoogleCloudDatacatalogV1DataplexSpec": { "type": "object", "description": "Common Dataplex Universal Catalog fields.", "id": "GoogleCloudDatacatalogV1DataplexSpec", "properties": { "dataFormat": { "description": "Format of the data.", "$ref": "GoogleCloudDatacatalogV1PhysicalSchema" }, "compressionFormat": { "type": "string", "description": "Compression format of the data, e.g., zip, gzip etc." }, "projectId": { "type": "string", "description": "Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset." }, "asset": { "description": "Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.", "type": "string" } } }, "GoogleCloudDatacatalogV1MigrationConfig": { "type": "object", "description": "The configuration related to the migration to Dataplex Universal Catalog applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.", "id": "GoogleCloudDatacatalogV1MigrationConfig", "properties": { "templateMigrationEnabledTime": { "type": "string", "description": "The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set.", "format": "google-datetime" }, "tagTemplateMigration": { "type": "string", "enumDescriptions": [ "Default value. Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is not performed. For projects that are under an organization, the project inherits the organization's configuration when you set the project-level configuration to unspecified (`TAG_TEMPLATE_MIGRATION_UNSPECIFIED`). This means that when migration is enabled at the organization level, and the project-level configuration is unspecified, the project is migrated. To explicitly opt-in or opt-out individual projects, set the project-level configuration to enabled (`TAG_TEMPLATE_MIGRATION_ENABLED`) or disabled (`TAG_TEMPLATE_MIGRATION_DISABLED`).", "Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is enabled.", "Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is disabled." ], "description": "Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog.", "enum": [ "TAG_TEMPLATE_MIGRATION_UNSPECIFIED", "TAG_TEMPLATE_MIGRATION_ENABLED", "TAG_TEMPLATE_MIGRATION_DISABLED" ] }, "catalogUiExperience": { "type": "string", "enumDescriptions": [ "Default value. The default UI is Dataplex Universal Catalog.", "The UI is Dataplex Universal Catalog.", "The UI is Data Catalog." ], "description": "Opt-in status for the UI switch to Dataplex Universal Catalog.", "enum": [ "CATALOG_UI_EXPERIENCE_UNSPECIFIED", "CATALOG_UI_EXPERIENCE_ENABLED", "CATALOG_UI_EXPERIENCE_DISABLED" ] } } }, "GoogleCloudDatacatalogV1StarEntryRequest": { "id": "GoogleCloudDatacatalogV1StarEntryRequest", "properties": {}, "type": "object", "description": "Request message for StarEntry." }, "GoogleCloudDatacatalogV1EntryGroup": { "description": "Entry group metadata. An `EntryGroup` resource represents a logical grouping of zero or more Data Catalog Entry resources.", "type": "object", "id": "GoogleCloudDatacatalogV1EntryGroup", "properties": { "name": { "description": "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.", "type": "string" }, "displayName": { "description": "A short name to identify the entry group, for example, \"analytics data - jan 2011\". Default value is an empty string.", "type": "string" }, "transferredToDataplex": { "type": "boolean", "description": "Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. 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." }, "dataCatalogTimestamps": { "readOnly": true, "description": "Output only. Timestamps of the entry group. Default value is empty.", "$ref": "GoogleCloudDatacatalogV1SystemTimestamps" }, "description": { "type": "string", "description": "Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string." } } }, "GoogleCloudDatacatalogV1DataplexFilesetSpec": { "description": "Entry specification for a Dataplex Universal Catalog fileset.", "type": "object", "id": "GoogleCloudDatacatalogV1DataplexFilesetSpec", "properties": { "dataplexSpec": { "description": "Common Dataplex Universal Catalog fields.", "$ref": "GoogleCloudDatacatalogV1DataplexSpec" } } }, "GetPolicyOptions": { "type": "object", "description": "Encapsulates settings provided to GetIamPolicy.", "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } } }, "GoogleCloudDatacatalogV1DatasetSpec": { "description": "Specification that applies to a dataset. Valid only for entries with the `DATASET` type.", "type": "object", "id": "GoogleCloudDatacatalogV1DatasetSpec", "properties": { "vertexDatasetSpec": { "description": "Vertex AI Dataset specific fields", "$ref": "GoogleCloudDatacatalogV1VertexDatasetSpec" } } }, "SetIamPolicyRequest": { "type": "object", "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "Policy" } } }, "GoogleCloudDatacatalogV1TagTemplate": { "type": "object", "description": "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 Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/roles-permissions/datacatalog) 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.", "id": "GoogleCloudDatacatalogV1TagTemplate", "properties": { "name": { "description": "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.", "type": "string" }, "displayName": { "description": "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.", "type": "string" }, "isPubliclyReadable": { "description": "Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in 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.", "type": "boolean" }, "dataplexTransferStatus": { "enumDeprecated": [ false, true, false ], "type": "string", "enumDescriptions": [ "Default value. TagTemplate and its tags are only visible and editable in Data Catalog.", "TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Data Catalog, read-only in Dataplex Universal Catalog. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", "TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Dataplex Universal Catalog, read-only in Data Catalog." ], "description": "Optional. Transfer status of the TagTemplate", "enum": [ "DATAPLEX_TRANSFER_STATUS_UNSPECIFIED", "MIGRATED", "TRANSFERRED" ] }, "fields": { "additionalProperties": { "$ref": "GoogleCloudDatacatalogV1TagTemplateField" }, "description": "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.", "type": "object" } } }, "GoogleCloudDatacatalogV1SerializedPolicyTag": { "description": "A nested protocol buffer that represents a policy tag and all its descendants.", "type": "object", "id": "GoogleCloudDatacatalogV1SerializedPolicyTag", "properties": { "displayName": { "type": "string", "description": "Required. Display name of the policy tag. At most 200 bytes when encoded in UTF-8." }, "childPolicyTags": { "description": "Children of the policy tag, if any.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1SerializedPolicyTag" } }, "policyTag": { "description": "Resource name of the policy tag. This field is ignored when calling `ImportTaxonomies`.", "type": "string" }, "description": { "type": "string", "description": "Description of the serialized policy tag. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description." } } }, "GoogleCloudDatacatalogV1DataplexTableSpec": { "description": "Entry specification for a Dataplex Universal Catalog table.", "type": "object", "id": "GoogleCloudDatacatalogV1DataplexTableSpec", "properties": { "externalTables": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1DataplexExternalTable" }, "description": "List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems." }, "dataplexSpec": { "description": "Common Dataplex Universal Catalog fields.", "$ref": "GoogleCloudDatacatalogV1DataplexSpec" }, "userManaged": { "type": "boolean", "description": "Indicates if the table schema is managed by the user or not." } } }, "GoogleCloudDatacatalogV1StorageProperties": { "id": "GoogleCloudDatacatalogV1StorageProperties", "properties": { "filePattern": { "type": "array", "items": { "type": "string" }, "description": "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`" }, "fileType": { "type": "string", "description": "File type in MIME format, for example, `text/plain`." } }, "description": "Details the properties of the underlying storage.", "type": "object" }, "GoogleCloudDatacatalogV1ModelSpec": { "id": "GoogleCloudDatacatalogV1ModelSpec", "properties": { "vertexModelSpec": { "description": "Specification for vertex model resources.", "$ref": "GoogleCloudDatacatalogV1VertexModelSpec" } }, "type": "object", "description": "Specification that applies to a model. Valid only for entries with the `MODEL` type." }, "GoogleCloudDatacatalogV1Taxonomy": { "id": "GoogleCloudDatacatalogV1Taxonomy", "properties": { "description": { "description": "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.", "type": "string" }, "taxonomyTimestamps": { "$ref": "GoogleCloudDatacatalogV1SystemTimestamps", "readOnly": true, "description": "Output only. Creation and modification timestamps of this taxonomy." }, "policyTagCount": { "readOnly": true, "type": "integer", "description": "Output only. Number of policy tags in this taxonomy.", "format": "int32" }, "activatedPolicyTypes": { "type": "array", "items": { "enum": [ "POLICY_TYPE_UNSPECIFIED", "FINE_GRAINED_ACCESS_CONTROL" ], "type": "string", "enumDescriptions": [ "Unspecified policy type.", "Fine-grained access control policy that enables access control on tagged sub-resources." ] }, "description": "Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list." }, "name": { "description": "Identifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.", "type": "string" }, "displayName": { "type": "string", "description": "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." }, "service": { "description": "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.", "readOnly": true, "$ref": "GoogleCloudDatacatalogV1TaxonomyService" } }, "description": "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 ```", "type": "object" }, "GoogleCloudDatacatalogV1InlineSource": { "id": "GoogleCloudDatacatalogV1InlineSource", "properties": { "taxonomies": { "description": "Required. Taxonomies to import.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1SerializedTaxonomy" } } }, "description": "Inline source containing taxonomies to import.", "type": "object" }, "GoogleCloudDatacatalogV1Tag": { "type": "object", "description": "Tags 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.", "id": "GoogleCloudDatacatalogV1Tag", "properties": { "column": { "type": "string", "description": "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`." }, "templateDisplayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the tag template." }, "fields": { "description": "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.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDatacatalogV1TagField" } }, "template": { "type": "string", "description": "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." }, "name": { "type": "string", "description": "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." }, "dataplexTransferStatus": { "description": "Output only. Denotes the transfer status of the Tag Template.", "enum": [ "DATAPLEX_TRANSFER_STATUS_UNSPECIFIED", "MIGRATED", "TRANSFERRED" ], "enumDeprecated": [ false, true, false ], "readOnly": true, "type": "string", "enumDescriptions": [ "Default value. TagTemplate and its tags are only visible and editable in Data Catalog.", "TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Data Catalog, read-only in Dataplex Universal Catalog. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", "TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Dataplex Universal Catalog, read-only in Data Catalog." ] } } }, "GoogleCloudDatacatalogV1ListEntryGroupsResponse": { "id": "GoogleCloudDatacatalogV1ListEntryGroupsResponse", "properties": { "nextPageToken": { "description": "Pagination token to specify in the next call to retrieve the next page of results. Empty if there are no more items.", "type": "string" }, "entryGroups": { "description": "Entry group details.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1EntryGroup" } } }, "description": "Response message for ListEntryGroups.", "type": "object" }, "GoogleCloudDatacatalogV1TagFieldEnumValue": { "description": "An enum value.", "type": "object", "id": "GoogleCloudDatacatalogV1TagFieldEnumValue", "properties": { "displayName": { "type": "string", "description": "The display name of the enum value." } } }, "GoogleCloudDatacatalogV1SpannerTableSpecSpannerForeignKey": { "id": "GoogleCloudDatacatalogV1SpannerTableSpecSpannerForeignKey", "properties": { "entry": { "description": "Output only. The table name this foreign key referenced to. Format: `projects/{PROJECT_ID}/locations/{LOCATION}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`", "readOnly": true, "type": "string" }, "name": { "description": "Output only. The constraint_name of the foreign key, for example, FK_CustomerOrder.", "readOnly": true, "type": "string" }, "columnMappings": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1SpannerTableSpecSpannerForeignKeyForeignKeyColumnMapping" }, "description": "Output only. The ordered list of column mappings for this foreign key." } }, "description": "Specification of a Spanner foreign key.", "type": "object" }, "GoogleCloudDatacatalogV1ViewSpec": { "description": "Table view specification.", "type": "object", "id": "GoogleCloudDatacatalogV1ViewSpec", "properties": { "viewQuery": { "readOnly": true, "type": "string", "description": "Output only. The query that defines the table view." } } }, "GoogleCloudDatacatalogV1ColumnSchemaFieldElementType": { "id": "GoogleCloudDatacatalogV1ColumnSchemaFieldElementType", "properties": { "type": { "type": "string", "description": "Required. The type of a field element. See ColumnSchema.type." } }, "description": "Represents the type of a field element.", "type": "object" }, "GoogleCloudDatacatalogV1GraphSpecGraphElementTableLabelAndProperties": { "id": "GoogleCloudDatacatalogV1GraphSpecGraphElementTableLabelAndProperties", "properties": { "label": { "description": "Required. The name of the label.", "type": "string" }, "properties": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1GraphSpecGraphElementTableProperty" }, "description": "Optional. The properties associated with the label." } }, "type": "object", "description": "The label and its properties. Each label is associated with a set of properties." }, "GoogleCloudDatacatalogV1ExportTaxonomiesResponse": { "id": "GoogleCloudDatacatalogV1ExportTaxonomiesResponse", "properties": { "taxonomies": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1SerializedTaxonomy" }, "description": "List of taxonomies and policy tags as nested protocol buffers." } }, "type": "object", "description": "Response message for ExportTaxonomies." }, "GoogleCloudDatacatalogV1ListTaxonomiesResponse": { "type": "object", "description": "Response message for ListTaxonomies.", "id": "GoogleCloudDatacatalogV1ListTaxonomiesResponse", "properties": { "taxonomies": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1Taxonomy" }, "description": "Taxonomies that the project contains." }, "nextPageToken": { "description": "Pagination token of the next results page. Empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDatacatalogV1CloudSqlBigQueryConnectionSpec": { "description": "Specification for the BigQuery connection to a Cloud SQL instance.", "type": "object", "id": "GoogleCloudDatacatalogV1CloudSqlBigQueryConnectionSpec", "properties": { "instanceId": { "description": "Cloud SQL instance ID in the format of `project:location:instance`.", "type": "string" }, "database": { "description": "Database name.", "type": "string" }, "type": { "description": "Type of the Cloud SQL database.", "enum": [ "DATABASE_TYPE_UNSPECIFIED", "POSTGRES", "MYSQL" ], "type": "string", "enumDescriptions": [ "Unspecified database type.", "Cloud SQL for PostgreSQL.", "Cloud SQL for MySQL." ] } } }, "GoogleCloudDatacatalogV1ImportEntriesResponse": { "description": "Response message for long-running operation returned by the ImportEntries.", "type": "object", "id": "GoogleCloudDatacatalogV1ImportEntriesResponse", "properties": { "upsertedEntriesCount": { "description": "Cumulative number of entries created and entries updated as a result of import operation.", "type": "string", "format": "int64" }, "deletedEntriesCount": { "format": "int64", "type": "string", "description": "Number of entries deleted as a result of import operation." } } }, "GoogleCloudDatacatalogV1PhysicalSchema": { "type": "object", "description": "Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data.", "id": "GoogleCloudDatacatalogV1PhysicalSchema", "properties": { "thrift": { "description": "Schema in Thrift format.", "$ref": "GoogleCloudDatacatalogV1PhysicalSchemaThriftSchema" }, "csv": { "description": "Marks a CSV-encoded data source.", "$ref": "GoogleCloudDatacatalogV1PhysicalSchemaCsvSchema" }, "avro": { "description": "Schema in Avro JSON format.", "$ref": "GoogleCloudDatacatalogV1PhysicalSchemaAvroSchema" }, "orc": { "description": "Marks an ORC-encoded data source.", "$ref": "GoogleCloudDatacatalogV1PhysicalSchemaOrcSchema" }, "protobuf": { "description": "Schema in protocol buffer format.", "$ref": "GoogleCloudDatacatalogV1PhysicalSchemaProtobufSchema" }, "parquet": { "description": "Marks a Parquet-encoded data source.", "$ref": "GoogleCloudDatacatalogV1PhysicalSchemaParquetSchema" } } }, "GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec": { "description": "Specification that applies to database view.", "type": "object", "id": "GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec", "properties": { "sqlQuery": { "description": "SQL query used to generate this view.", "type": "string" }, "viewType": { "description": "Type of this view.", "enum": [ "VIEW_TYPE_UNSPECIFIED", "STANDARD_VIEW", "MATERIALIZED_VIEW" ], "type": "string", "enumDescriptions": [ "Default unknown view type.", "Standard view.", "Materialized view." ] }, "baseTable": { "type": "string", "description": "Name of a singular table this view reflects one to one." } } }, "GoogleCloudDatacatalogV1StarEntryResponse": { "description": "Response message for StarEntry. Empty for now", "type": "object", "id": "GoogleCloudDatacatalogV1StarEntryResponse", "properties": {} }, "Binding": { "id": "Binding", "properties": { "role": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles)." }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "Expr" }, "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array", "items": { "type": "string" } } }, "type": "object", "description": "Associates `members`, or principals, with a `role`." }, "GoogleCloudDatacatalogV1CloudBigtableSystemSpec": { "type": "object", "description": "Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (user_specified_type)", "id": "GoogleCloudDatacatalogV1CloudBigtableSystemSpec", "properties": { "instanceDisplayName": { "description": "Display name of the Instance. This is user specified and different from the resource name.", "type": "string" } } }, "GoogleCloudDatacatalogV1BigQueryTableSpec": { "description": "Describes a BigQuery table.", "type": "object", "id": "GoogleCloudDatacatalogV1BigQueryTableSpec", "properties": { "tableSourceType": { "readOnly": true, "type": "string", "enumDescriptions": [ "Default unknown type.", "Table view.", "BigQuery native table.", "BigQuery materialized view." ], "description": "Output only. The table source type.", "enum": [ "TABLE_SOURCE_TYPE_UNSPECIFIED", "BIGQUERY_VIEW", "BIGQUERY_TABLE", "BIGQUERY_MATERIALIZED_VIEW" ] }, "tableSpec": { "description": "Specification of a BigQuery table. Populated only if the `table_source_type` is `BIGQUERY_TABLE`.", "$ref": "GoogleCloudDatacatalogV1TableSpec" }, "viewSpec": { "description": "Table view specification. Populated only if the `table_source_type` is `BIGQUERY_VIEW`.", "$ref": "GoogleCloudDatacatalogV1ViewSpec" } } }, "GoogleCloudDatacatalogV1RoutineSpec": { "description": "Specification that applies to a routine. Valid only for entries with the `ROUTINE` type.", "type": "object", "id": "GoogleCloudDatacatalogV1RoutineSpec", "properties": { "routineType": { "description": "The type of the routine.", "enum": [ "ROUTINE_TYPE_UNSPECIFIED", "SCALAR_FUNCTION", "PROCEDURE" ], "type": "string", "enumDescriptions": [ "Unspecified type.", "Non-builtin permanent scalar function.", "Stored procedure." ] }, "returnType": { "type": "string", "description": "Return type of the argument. The exact value depends on the source system and the language." }, "bigqueryRoutineSpec": { "description": "Fields specific for BigQuery routines.", "$ref": "GoogleCloudDatacatalogV1BigQueryRoutineSpec" }, "definitionBody": { "description": "The body of the routine.", "type": "string" }, "routineArguments": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1RoutineSpecArgument" }, "description": "Arguments of the routine." }, "language": { "description": "The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * `SQL` * `JAVASCRIPT`", "type": "string" } } }, "GoogleCloudDatacatalogV1EntryOverview": { "type": "object", "description": "Entry overview fields for rich text descriptions of entries.", "id": "GoogleCloudDatacatalogV1EntryOverview", "properties": { "overview": { "description": "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.", "type": "string" } } }, "GoogleCloudDatacatalogV1ListPolicyTagsResponse": { "id": "GoogleCloudDatacatalogV1ListPolicyTagsResponse", "properties": { "policyTags": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1PolicyTag" }, "description": "The policy tags that belong to the taxonomy." }, "nextPageToken": { "description": "Pagination token of the next results page. Empty if there are no more results in the list.", "type": "string" } }, "type": "object", "description": "Response message for ListPolicyTags." }, "GoogleCloudDatacatalogV1LookerSystemSpec": { "id": "GoogleCloudDatacatalogV1LookerSystemSpec", "properties": { "parentModelDisplayName": { "description": "Name of the parent Model. Empty if it does not exist.", "type": "string" }, "parentViewId": { "type": "string", "description": "ID of the parent View. Empty if it does not exist." }, "parentInstanceDisplayName": { "type": "string", "description": "Name of the parent Looker Instance. Empty if it does not exist." }, "parentModelId": { "type": "string", "description": "ID of the parent Model. Empty if it does not exist." }, "parentInstanceId": { "type": "string", "description": "ID of the parent Looker Instance. Empty if it does not exist. Example value: `someinstance.looker.com`" }, "parentViewDisplayName": { "description": "Name of the parent View. Empty if it does not exist.", "type": "string" } }, "description": "Specification that applies to entries that are part `LOOKER` system (user_specified_type)", "type": "object" }, "GoogleCloudDatacatalogV1ImportTaxonomiesRequest": { "description": "Request message for ImportTaxonomies.", "type": "object", "id": "GoogleCloudDatacatalogV1ImportTaxonomiesRequest", "properties": { "inlineSource": { "description": "Inline source taxonomy to import.", "$ref": "GoogleCloudDatacatalogV1InlineSource" }, "crossRegionalSource": { "description": "Cross-regional source taxonomy to import.", "$ref": "GoogleCloudDatacatalogV1CrossRegionalSource" } } }, "GoogleCloudDatacatalogV1ListEntriesResponse": { "type": "object", "description": "Response message for ListEntries.", "id": "GoogleCloudDatacatalogV1ListEntriesResponse", "properties": { "entries": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1Entry" }, "description": "Entry details." }, "nextPageToken": { "type": "string", "description": "Pagination token of the next results page. Empty if there are no more items in results." } } }, "GoogleCloudDatacatalogV1FieldTypeEnumType": { "type": "object", "id": "GoogleCloudDatacatalogV1FieldTypeEnumType", "properties": { "allowedValues": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1FieldTypeEnumTypeEnumValue" }, "description": "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." } } }, "GoogleCloudDatacatalogV1PolicyTag": { "description": "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.", "type": "object", "id": "GoogleCloudDatacatalogV1PolicyTag", "properties": { "name": { "type": "string", "description": "Identifier. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs." }, "displayName": { "type": "string", "description": "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." }, "parentPolicyTag": { "type": "string", "description": "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." }, "childPolicyTags": { "description": "Output only. Resource names of child policy tags of this policy tag.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "description": { "description": "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.", "type": "string" } } }, "GoogleCloudDatacatalogV1ImportTaxonomiesResponse": { "id": "GoogleCloudDatacatalogV1ImportTaxonomiesResponse", "properties": { "taxonomies": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1Taxonomy" }, "description": "Imported taxonomies." } }, "description": "Response message for ImportTaxonomies.", "type": "object" }, "GoogleCloudDatacatalogV1RenameTagTemplateFieldEnumValueRequest": { "id": "GoogleCloudDatacatalogV1RenameTagTemplateFieldEnumValueRequest", "properties": { "newEnumValueDisplayName": { "type": "string", "description": "Required. The new display name of the enum value. For example, `my_new_enum_value`." } }, "description": "Request message for RenameTagTemplateFieldEnumValue.", "type": "object" }, "GoogleCloudDatacatalogV1UnstarEntryResponse": { "type": "object", "description": "Response message for UnstarEntry. Empty for now", "id": "GoogleCloudDatacatalogV1UnstarEntryResponse", "properties": {} }, "GoogleCloudDatacatalogV1BigQueryDateShardedSpec": { "id": "GoogleCloudDatacatalogV1BigQueryDateShardedSpec", "properties": { "tablePrefix": { "readOnly": true, "type": "string", "description": "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`." }, "shardCount": { "description": "Output only. Total number of shards.", "readOnly": true, "type": "string", "format": "int64" }, "latestShardResource": { "description": "Output only. BigQuery resource name of the latest shard.", "readOnly": true, "type": "string" }, "dataset": { "readOnly": true, "type": "string", "description": "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}`." } }, "type": "object", "description": "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)." }, "GoogleCloudDatacatalogV1PhysicalSchemaAvroSchema": { "id": "GoogleCloudDatacatalogV1PhysicalSchemaAvroSchema", "properties": { "text": { "type": "string", "description": "JSON source of the Avro schema." } }, "description": "Schema in Avro JSON format.", "type": "object" }, "GoogleCloudDatacatalogV1RenameTagTemplateFieldRequest": { "id": "GoogleCloudDatacatalogV1RenameTagTemplateFieldRequest", "properties": { "newTagTemplateFieldId": { "description": "Required. The new ID of this tag template field. For example, `my_new_field`.", "type": "string" } }, "description": "Request message for RenameTagTemplateField.", "type": "object" }, "GoogleCloudDatacatalogV1SerializedTaxonomy": { "id": "GoogleCloudDatacatalogV1SerializedTaxonomy", "properties": { "displayName": { "description": "Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8.", "type": "string" }, "activatedPolicyTypes": { "type": "array", "items": { "type": "string", "enumDescriptions": [ "Unspecified policy type.", "Fine-grained access control policy that enables access control on tagged sub-resources." ], "enum": [ "POLICY_TYPE_UNSPECIFIED", "FINE_GRAINED_ACCESS_CONTROL" ] }, "description": "A list of policy types that are activated per taxonomy." }, "policyTags": { "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1SerializedPolicyTag" }, "description": "Top level policy tags associated with the taxonomy, if any." }, "description": { "description": "Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.", "type": "string" } }, "type": "object", "description": "A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export." }, "GoogleCloudDatacatalogV1ReconcileTagsResponse": { "id": "GoogleCloudDatacatalogV1ReconcileTagsResponse", "properties": { "updatedTagsCount": { "description": "Number of tags updated in the request.", "type": "string", "format": "int64" }, "deletedTagsCount": { "description": "Number of tags deleted in the request.", "type": "string", "format": "int64" }, "createdTagsCount": { "format": "int64", "type": "string", "description": "Number of tags created in the request." } }, "description": "Long-running operation response message returned by ReconcileTags.", "type": "object" }, "GoogleCloudDatacatalogV1SetConfigRequest": { "id": "GoogleCloudDatacatalogV1SetConfigRequest", "properties": { "tagTemplateMigration": { "type": "string", "enumDescriptions": [ "Default value. Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is not performed. For projects that are under an organization, the project inherits the organization's configuration when you set the project-level configuration to unspecified (`TAG_TEMPLATE_MIGRATION_UNSPECIFIED`). This means that when migration is enabled at the organization level, and the project-level configuration is unspecified, the project is migrated. To explicitly opt-in or opt-out individual projects, set the project-level configuration to enabled (`TAG_TEMPLATE_MIGRATION_ENABLED`) or disabled (`TAG_TEMPLATE_MIGRATION_DISABLED`).", "Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is enabled.", "Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is disabled." ], "description": "Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog.", "enum": [ "TAG_TEMPLATE_MIGRATION_UNSPECIFIED", "TAG_TEMPLATE_MIGRATION_ENABLED", "TAG_TEMPLATE_MIGRATION_DISABLED" ] }, "catalogUiExperience": { "description": "Opt-in status for the UI switch to Dataplex Universal Catalog.", "enum": [ "CATALOG_UI_EXPERIENCE_UNSPECIFIED", "CATALOG_UI_EXPERIENCE_ENABLED", "CATALOG_UI_EXPERIENCE_DISABLED" ], "type": "string", "enumDescriptions": [ "Default value. The default UI is Dataplex Universal Catalog.", "The UI is Dataplex Universal Catalog.", "The UI is Data Catalog." ] } }, "description": "Request message for SetConfig.", "type": "object" }, "GoogleCloudDatacatalogV1SearchCatalogResponse": { "id": "GoogleCloudDatacatalogV1SearchCatalogResponse", "properties": { "results": { "description": "Search results.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1SearchCatalogResult" } }, "nextPageToken": { "type": "string", "description": "Pagination token that can be used in subsequent calls to retrieve the next page of results." }, "unreachable": { "description": "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.", "type": "array", "items": { "type": "string" } }, "totalSize": { "description": "The approximate total number of entries matched by the query.", "type": "integer", "format": "int32" } }, "description": "Response message for SearchCatalog.", "type": "object" }, "GoogleCloudDatacatalogV1SearchCatalogRequest": { "type": "object", "description": "Request message for SearchCatalog.", "id": "GoogleCloudDatacatalogV1SearchCatalogRequest", "properties": { "query": { "description": "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`", "type": "string" }, "scope": { "description": "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.", "$ref": "GoogleCloudDatacatalogV1SearchCatalogRequestScope" }, "orderBy": { "type": "string", "description": "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`." }, "adminSearch": { "type": "boolean", "description": "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." }, "pageSize": { "format": "int32", "type": "integer", "description": "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." }, "pageToken": { "type": "string", "description": "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." } } }, "GoogleCloudDatacatalogV1CloudBigtableInstanceSpec": { "description": "Specification that applies to Instance entries that are part of `CLOUD_BIGTABLE` system. (user_specified_type)", "type": "object", "id": "GoogleCloudDatacatalogV1CloudBigtableInstanceSpec", "properties": { "cloudBigtableClusterSpecs": { "description": "The list of clusters for the Instance.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogV1CloudBigtableInstanceSpecCloudBigtableClusterSpec" } } } }, "GoogleCloudDatacatalogV1TagTemplateField": { "type": "object", "description": "The template for an individual field within a tag template.", "id": "GoogleCloudDatacatalogV1TagTemplateField", "properties": { "name": { "description": "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.", "type": "string" }, "displayName": { "description": "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": "string" }, "type": { "description": "Required. The type of value this tag field can contain.", "$ref": "GoogleCloudDatacatalogV1FieldType" }, "order": { "format": "int32", "description": "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.", "type": "integer" }, "isRequired": { "description": "If true, this field is required. Defaults to false.", "type": "boolean" }, "description": { "description": "The description for this field. Defaults to an empty string.", "type": "string" } } } }, "basePath": "", "description": "A fully managed and highly scalable data discovery and metadata management service. ", "protocol": "rest", "rootUrl": "https://datacatalog.googleapis.com/", "resources": { "entries": { "methods": { "lookup": { "flatPath": "v1/entries:lookup", "id": "datacatalog.entries.lookup", "parameterOrder": [], "description": "Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "path": "v1/entries:lookup", "httpMethod": "GET", "response": { "$ref": "GoogleCloudDatacatalogV1Entry" }, "parameters": { "sqlResource": { "location": "query", "description": "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).", "type": "string" }, "fullyQualifiedName": { "location": "query", "type": "string", "description": "[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}`" }, "location": { "location": "query", "type": "string", "description": "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." }, "linkedResource": { "location": "query", "type": "string", "description": "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}`" }, "project": { "location": "query", "description": "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.", "type": "string" } } } }, "deprecated": true }, "projects": { "resources": { "locations": { "methods": { "setConfig": { "parameterOrder": [ "name" ], "description": "Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setConfig", "id": "datacatalog.projects.locations.setConfig", "request": { "$ref": "GoogleCloudDatacatalogV1SetConfigRequest" }, "response": { "$ref": "GoogleCloudDatacatalogV1MigrationConfig" }, "parameters": { "name": { "description": "Required. The organization or project whose config is being specified.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "path": "v1/{+name}:setConfig", "httpMethod": "POST" }, "retrieveEffectiveConfig": { "parameters": { "name": { "description": "Required. The resource whose effective config is being retrieved.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleCloudDatacatalogV1MigrationConfig" }, "httpMethod": "GET", "path": "v1/{+name}:retrieveEffectiveConfig", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog 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.", "id": "datacatalog.projects.locations.retrieveEffectiveConfig", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveEffectiveConfig" } }, "resources": { "entryGroups": { "methods": { "delete": { "path": "v1/{+name}", "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "description": "Required. The name of the entry group to delete." }, "force": { "location": "query", "description": "Optional. If true, deletes all entries in the entry group.", "type": "boolean" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "id": "datacatalog.projects.locations.entryGroups.delete", "parameterOrder": [ "name" ], "description": "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).", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "request": { "$ref": "GoogleCloudDatacatalogV1EntryGroup" }, "id": "datacatalog.projects.locations.entryGroups.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "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).", "httpMethod": "PATCH", "path": "v1/{+name}", "parameters": { "name": { "description": "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.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "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." } }, "response": { "$ref": "GoogleCloudDatacatalogV1EntryGroup" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "parent" ], "description": "Lists entry groups.", "id": "datacatalog.projects.locations.entryGroups.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups", "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "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." }, "pageToken": { "type": "string", "description": "Optional. Pagination token that specifies the next page to return. If empty, returns the first page.", "location": "query" }, "parent": { "description": "Required. The name of the location that contains the entry groups to list. Can be provided as a URL.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleCloudDatacatalogV1ListEntryGroupsResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/entryGroups" }, "testIamPermissions": { "response": { "$ref": "TestIamPermissionsResponse" }, "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "path": "v1/{+resource}:testIamPermissions", "httpMethod": "POST", "parameterOrder": [ "resource" ], "description": "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.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "id": "datacatalog.projects.locations.entryGroups.testIamPermissions" }, "get": { "id": "datacatalog.projects.locations.entryGroups.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets an entry group.", "httpMethod": "GET", "path": "v1/{+name}", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "description": "Required. The name of the entry group to get." }, "readMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "The fields to return. If empty or omitted, all fields are returned." } }, "response": { "$ref": "GoogleCloudDatacatalogV1EntryGroup" } }, "create": { "path": "v1/{+parent}/entryGroups", "httpMethod": "POST", "response": { "$ref": "GoogleCloudDatacatalogV1EntryGroup" }, "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "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." }, "entryGroupId": { "description": "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.", "type": "string", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups", "request": { "$ref": "GoogleCloudDatacatalogV1EntryGroup" }, "id": "datacatalog.projects.locations.entryGroups.create", "parameterOrder": [ "parent" ], "description": "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).", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "response": { "$ref": "Policy" }, "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "path": "v1/{+resource}:setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "description": "Sets 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.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "id": "datacatalog.projects.locations.entryGroups.setIamPolicy" }, "getIamPolicy": { "request": { "$ref": "GetIamPolicyRequest" }, "id": "datacatalog.projects.locations.entryGroups.getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "description": "Gets 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.", "httpMethod": "POST", "path": "v1/{+resource}:getIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string" } }, "response": { "$ref": "Policy" } } }, "resources": { "entries": { "methods": { "create": { "parameters": { "parent": { "description": "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.", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "required": true, "location": "path" }, "entryId": { "location": "query", "type": "string", "description": "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." } }, "response": { "$ref": "GoogleCloudDatacatalogV1Entry" }, "httpMethod": "POST", "path": "v1/{+parent}/entries", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "parent" ], "description": "Creates 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.", "id": "datacatalog.projects.locations.entryGroups.entries.create", "request": { "$ref": "GoogleCloudDatacatalogV1Entry" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries" }, "get": { "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "description": "Required. The name of the entry to get." } }, "response": { "$ref": "GoogleCloudDatacatalogV1Entry" }, "httpMethod": "GET", "path": "v1/{+name}", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets an entry.", "id": "datacatalog.projects.locations.entryGroups.entries.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}" }, "unstar": { "parameterOrder": [ "name" ], "description": "Marks an Entry as NOT starred by the current user. Starring information is private to each user.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:unstar", "request": { "$ref": "GoogleCloudDatacatalogV1UnstarEntryRequest" }, "id": "datacatalog.projects.locations.entryGroups.entries.unstar", "response": { "$ref": "GoogleCloudDatacatalogV1UnstarEntryResponse" }, "parameters": { "name": { "description": "Required. The name of the entry to mark as **not** starred.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string" } }, "path": "v1/{+name}:unstar", "httpMethod": "POST" }, "star": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:star", "id": "datacatalog.projects.locations.entryGroups.entries.star", "request": { "$ref": "GoogleCloudDatacatalogV1StarEntryRequest" }, "parameterOrder": [ "name" ], "description": "Marks an Entry as starred by the current user. Starring information is private to each user.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "path": "v1/{+name}:star", "httpMethod": "POST", "response": { "$ref": "GoogleCloudDatacatalogV1StarEntryResponse" }, "parameters": { "name": { "description": "Required. The name of the entry to mark as starred.", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "location": "path", "required": true } } }, "patch": { "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudDatacatalogV1Entry" }, "parameters": { "name": { "description": "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.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string" }, "updateMask": { "description": "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`", "type": "string", "location": "query", "format": "google-fieldmask" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "request": { "$ref": "GoogleCloudDatacatalogV1Entry" }, "id": "datacatalog.projects.locations.entryGroups.entries.patch", "parameterOrder": [ "name" ], "description": "Updates 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).", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "GoogleCloudDatacatalogV1ListEntriesResponse" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The name of the entry group that contains the entries to list. Can be provided in URL format." }, "pageSize": { "description": "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.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "location": "query", "description": "Pagination token that specifies the next page to return. If empty, the first page is returned.", "type": "string" }, "readMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "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." } }, "path": "v1/{+parent}/entries", "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", "id": "datacatalog.projects.locations.entryGroups.entries.list" }, "modifyEntryOverview": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "name" ], "description": "Modifies entry overview, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.", "id": "datacatalog.projects.locations.entryGroups.entries.modifyEntryOverview", "request": { "$ref": "GoogleCloudDatacatalogV1ModifyEntryOverviewRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:modifyEntryOverview", "parameters": { "name": { "description": "Required. The full resource name of the entry.", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "GoogleCloudDatacatalogV1EntryOverview" }, "httpMethod": "POST", "path": "v1/{+name}:modifyEntryOverview" }, "testIamPermissions": { "id": "datacatalog.projects.locations.entryGroups.entries.testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "resource" ], "description": "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.", "httpMethod": "POST", "path": "v1/{+resource}:testIamPermissions", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "required": true, "location": "path" } }, "response": { "$ref": "TestIamPermissionsResponse" } }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes an existing entry. You can delete only the entries created by the 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).", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "id": "datacatalog.projects.locations.entryGroups.entries.delete", "response": { "$ref": "Empty" }, "parameters": { "name": { "description": "Required. The name of the entry to delete.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string" } }, "path": "v1/{+name}", "httpMethod": "DELETE" }, "import": { "parameterOrder": [ "parent" ], "description": "Imports 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 type. `ImportEntries` returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries:import", "id": "datacatalog.projects.locations.entryGroups.entries.import", "request": { "$ref": "GoogleCloudDatacatalogV1ImportEntriesRequest" }, "response": { "$ref": "Operation" }, "parameters": { "parent": { "description": "Required. Target entry group for ingested entries.", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "required": true, "location": "path" } }, "path": "v1/{+parent}/entries:import", "httpMethod": "POST" }, "modifyEntryContacts": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:modifyEntryContacts", "id": "datacatalog.projects.locations.entryGroups.entries.modifyEntryContacts", "request": { "$ref": "GoogleCloudDatacatalogV1ModifyEntryContactsRequest" }, "parameterOrder": [ "name" ], "description": "Modifies contacts, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "path": "v1/{+name}:modifyEntryContacts", "httpMethod": "POST", "response": { "$ref": "GoogleCloudDatacatalogV1Contacts" }, "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "description": "Required. The full resource name of the entry." } } }, "getIamPolicy": { "path": "v1/{+resource}:getIamPolicy", "httpMethod": "POST", "response": { "$ref": "Policy" }, "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:getIamPolicy", "id": "datacatalog.projects.locations.entryGroups.entries.getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "description": "Gets 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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true } }, "resources": { "tags": { "methods": { "patch": { "request": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "id": "datacatalog.projects.locations.entryGroups.entries.tags.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Updates an existing tag.", "httpMethod": "PATCH", "path": "v1/{+name}", "parameters": { "name": { "description": "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.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+/tags/[^/]+$", "type": "string" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "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." } }, "response": { "$ref": "GoogleCloudDatacatalogV1Tag" } }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags", "id": "datacatalog.projects.locations.entryGroups.entries.tags.list", "parameterOrder": [ "parent" ], "description": "Lists tags assigned to an Entry. The columns in the response are lowercased.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/tags", "httpMethod": "GET", "response": { "$ref": "GoogleCloudDatacatalogV1ListTagsResponse" }, "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The maximum number of tags to return. Default is 10. Maximum limit is 1000." }, "pageToken": { "description": "Pagination token that specifies the next page to return. If empty, the first page is returned.", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "description": "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)." } } }, "delete": { "parameters": { "name": { "description": "Required. The name of the tag to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+/tags/[^/]+$", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "name" ], "description": "Deletes a tag.", "id": "datacatalog.projects.locations.entryGroups.entries.tags.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}" }, "create": { "parameterOrder": [ "parent" ], "description": "Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif 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.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags", "request": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "id": "datacatalog.projects.locations.entryGroups.entries.tags.create", "response": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "description": "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." } }, "path": "v1/{+parent}/tags", "httpMethod": "POST" }, "reconcile": { "response": { "$ref": "Operation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. Name of Entry to be tagged." } }, "path": "v1/{+parent}/tags:reconcile", "httpMethod": "POST", "parameterOrder": [ "parent" ], "description": "`ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message. Note: SearchCatalog might return stale search results for up to 24 hours after the `ReconcileTags` operation completes.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags:reconcile", "request": { "$ref": "GoogleCloudDatacatalogV1ReconcileTagsRequest" }, "id": "datacatalog.projects.locations.entryGroups.entries.tags.reconcile" } }, "deprecated": true } } }, "tags": { "methods": { "create": { "path": "v1/{+parent}/tags", "httpMethod": "POST", "response": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "parameters": { "parent": { "description": "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.", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags", "id": "datacatalog.projects.locations.entryGroups.tags.create", "request": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "parameterOrder": [ "parent" ], "description": "Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif 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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true }, "patch": { "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/tags/[^/]+$", "type": "string", "description": "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." }, "updateMask": { "location": "query", "format": "google-fieldmask", "description": "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.", "type": "string" } }, "response": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "httpMethod": "PATCH", "path": "v1/{+name}", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Updates an existing tag.", "request": { "$ref": "GoogleCloudDatacatalogV1Tag" }, "id": "datacatalog.projects.locations.entryGroups.tags.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}" }, "list": { "id": "datacatalog.projects.locations.entryGroups.tags.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "parent" ], "description": "Lists tags assigned to an Entry. The columns in the response are lowercased.", "httpMethod": "GET", "path": "v1/{+parent}/tags", "parameters": { "parent": { "description": "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).", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "type": "string", "required": true, "location": "path" }, "pageSize": { "type": "integer", "description": "The maximum number of tags to return. Default is 10. Maximum limit is 1000.", "format": "int32", "location": "query" }, "pageToken": { "type": "string", "description": "Pagination token that specifies the next page to return. If empty, the first page is returned.", "location": "query" } }, "response": { "$ref": "GoogleCloudDatacatalogV1ListTagsResponse" } }, "delete": { "httpMethod": "DELETE", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name of the tag to delete.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/tags/[^/]+$", "type": "string" } }, "response": { "$ref": "Empty" }, "id": "datacatalog.projects.locations.entryGroups.tags.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "name" ], "description": "Deletes a tag." } }, "deprecated": true } } }, "tagTemplates": { "methods": { "delete": { "parameterOrder": [ "name" ], "description": "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).", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "id": "datacatalog.projects.locations.tagTemplates.delete", "response": { "$ref": "Empty" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "type": "string", "description": "Required. The name of the tag template to delete." }, "force": { "location": "query", "type": "boolean", "description": "Required. If true, deletes all tags that use this template. Currently, `true` is the only supported value." } }, "path": "v1/{+name}", "httpMethod": "DELETE" }, "patch": { "parameterOrder": [ "name" ], "description": "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).", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "request": { "$ref": "GoogleCloudDatacatalogV1TagTemplate" }, "id": "datacatalog.projects.locations.tagTemplates.patch", "response": { "$ref": "GoogleCloudDatacatalogV1TagTemplate" }, "parameters": { "name": { "description": "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.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "type": "string" }, "updateMask": { "description": "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.", "type": "string", "location": "query", "format": "google-fieldmask" } }, "path": "v1/{+name}", "httpMethod": "PATCH" }, "testIamPermissions": { "request": { "$ref": "TestIamPermissionsRequest" }, "id": "datacatalog.projects.locations.tagTemplates.testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:testIamPermissions", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "description": "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.", "httpMethod": "POST", "path": "v1/{+resource}:testIamPermissions", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "type": "string" } }, "response": { "$ref": "TestIamPermissionsResponse" } }, "get": { "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudDatacatalogV1TagTemplate" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the tag template to get." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}", "id": "datacatalog.projects.locations.tagTemplates.get", "parameterOrder": [ "name" ], "description": "Gets a tag template.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true }, "create": { "parameterOrder": [ "parent" ], "description": "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).", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates", "id": "datacatalog.projects.locations.tagTemplates.create", "request": { "$ref": "GoogleCloudDatacatalogV1TagTemplate" }, "response": { "$ref": "GoogleCloudDatacatalogV1TagTemplate" }, "parameters": { "tagTemplateId": { "description": "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.", "type": "string", "location": "query" }, "parent": { "description": "Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions).", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "path": "v1/{+parent}/tagTemplates", "httpMethod": "POST" }, "setIamPolicy": { "path": "v1/{+resource}:setIamPolicy", "httpMethod": "POST", "response": { "$ref": "Policy" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:setIamPolicy", "id": "datacatalog.projects.locations.tagTemplates.setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "description": "Sets 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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true }, "getIamPolicy": { "response": { "$ref": "Policy" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "type": "string" } }, "path": "v1/{+resource}:getIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "description": "Gets 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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:getIamPolicy", "id": "datacatalog.projects.locations.tagTemplates.getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" } } }, "resources": { "fields": { "methods": { "patch": { "parameterOrder": [ "name" ], "description": "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).", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}", "id": "datacatalog.projects.locations.tagTemplates.fields.patch", "request": { "$ref": "GoogleCloudDatacatalogV1TagTemplateField" }, "response": { "$ref": "GoogleCloudDatacatalogV1TagTemplateField" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The name of the tag template field." }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "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." } }, "path": "v1/{+name}", "httpMethod": "PATCH" }, "rename": { "httpMethod": "POST", "path": "v1/{+name}:rename", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$", "type": "string", "description": "Required. The name of the tag template field." } }, "response": { "$ref": "GoogleCloudDatacatalogV1TagTemplateField" }, "request": { "$ref": "GoogleCloudDatacatalogV1RenameTagTemplateFieldRequest" }, "id": "datacatalog.projects.locations.tagTemplates.fields.rename", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}:rename", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "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)." }, "delete": { "response": { "$ref": "Empty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The name of the tag template field to delete." }, "force": { "location": "query", "type": "boolean", "description": "Required. If true, deletes this field from any tags that use it. Currently, `true` is the only supported value." } }, "path": "v1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "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).", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}", "id": "datacatalog.projects.locations.tagTemplates.fields.delete" }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions)." }, "tagTemplateFieldId": { "location": "query", "type": "string", "description": "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." } }, "response": { "$ref": "GoogleCloudDatacatalogV1TagTemplateField" }, "httpMethod": "POST", "path": "v1/{+parent}/fields", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "parent" ], "description": "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).", "id": "datacatalog.projects.locations.tagTemplates.fields.create", "request": { "$ref": "GoogleCloudDatacatalogV1TagTemplateField" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields" } }, "resources": { "enumValues": { "methods": { "rename": { "httpMethod": "POST", "path": "v1/{+name}:rename", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+/enumValues/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The name of the enum field value." } }, "response": { "$ref": "GoogleCloudDatacatalogV1TagTemplateField" }, "request": { "$ref": "GoogleCloudDatacatalogV1RenameTagTemplateFieldEnumValueRequest" }, "id": "datacatalog.projects.locations.tagTemplates.fields.enumValues.rename", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}/enumValues/{enumValuesId}:rename", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Renames an enum value in a tag template. Within a single enum field, enum values must be unique." } }, "deprecated": true } } } } }, "operations": { "methods": { "list": { "response": { "$ref": "ListOperationsResponse" }, "parameters": { "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "The name of the operation's parent resource." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" } }, "path": "v1/{+name}/operations", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "id": "datacatalog.projects.locations.operations.list" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "datacatalog.projects.locations.operations.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "path": "v1/{+name}" }, "cancel": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "id": "datacatalog.projects.locations.operations.cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:cancel", "httpMethod": "POST", "response": { "$ref": "Empty" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path" } } }, "get": { "id": "datacatalog.projects.locations.operations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "path": "v1/{+name}", "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "response": { "$ref": "Operation" } } } }, "taxonomies": { "methods": { "replace": { "parameters": { "name": { "description": "Required. Resource name of the taxonomy to update.", "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "required": true, "location": "path" } }, "response": { "$ref": "GoogleCloudDatacatalogV1Taxonomy" }, "httpMethod": "POST", "path": "v1/{+name}:replace", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "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": { "$ref": "GoogleCloudDatacatalogV1ReplaceTaxonomyRequest" }, "id": "datacatalog.projects.locations.taxonomies.replace", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}:replace" }, "getIamPolicy": { "parameterOrder": [ "resource" ], "description": "Gets the IAM policy for a policy tag or a taxonomy.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}:getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" }, "id": "datacatalog.projects.locations.taxonomies.getIamPolicy", "response": { "$ref": "Policy" }, "parameters": { "resource": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "path": "v1/{+resource}:getIamPolicy", "httpMethod": "POST" }, "delete": { "parameters": { "name": { "description": "Required. Resource name of the taxonomy to delete. Note: All policy tags in this taxonomy are also deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.", "id": "datacatalog.projects.locations.taxonomies.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}" }, "import": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies:import", "id": "datacatalog.projects.locations.taxonomies.import", "request": { "$ref": "GoogleCloudDatacatalogV1ImportTaxonomiesRequest" }, "parameterOrder": [ "parent" ], "description": "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/taxonomies:import", "httpMethod": "POST", "response": { "$ref": "GoogleCloudDatacatalogV1ImportTaxonomiesResponse" }, "parameters": { "parent": { "description": "Required. Resource name of project that the imported taxonomies will belong to.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" } } }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}", "id": "datacatalog.projects.locations.taxonomies.patch", "request": { "$ref": "GoogleCloudDatacatalogV1Taxonomy" }, "parameterOrder": [ "name" ], "description": "Updates a taxonomy, including its display name, description, and activated policy types.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudDatacatalogV1Taxonomy" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Identifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs." }, "updateMask": { "type": "string", "description": "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).", "format": "google-fieldmask", "location": "query" } } }, "list": { "httpMethod": "GET", "path": "v1/{+parent}/taxonomies", "parameters": { "parent": { "description": "Required. Resource name of the project to list the taxonomies of.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "Supported field for filter is 'service' and value is 'dataplex'. Eg: service=dataplex." }, "pageSize": { "description": "The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "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." } }, "response": { "$ref": "GoogleCloudDatacatalogV1ListTaxonomiesResponse" }, "id": "datacatalog.projects.locations.taxonomies.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Lists all taxonomies in a project in a particular location that you have a permission to view." }, "testIamPermissions": { "httpMethod": "POST", "path": "v1/{+resource}:testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "response": { "$ref": "TestIamPermissionsResponse" }, "request": { "$ref": "TestIamPermissionsRequest" }, "id": "datacatalog.projects.locations.taxonomies.testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "description": "Returns your permissions on a specified policy tag or taxonomy." }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets a taxonomy.", "id": "datacatalog.projects.locations.taxonomies.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "description": "Required. Resource name of the taxonomy to get." } }, "response": { "$ref": "GoogleCloudDatacatalogV1Taxonomy" }, "httpMethod": "GET", "path": "v1/{+name}" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.", "id": "datacatalog.projects.locations.taxonomies.create", "request": { "$ref": "GoogleCloudDatacatalogV1Taxonomy" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. Resource name of the project that the taxonomy will belong to." } }, "response": { "$ref": "GoogleCloudDatacatalogV1Taxonomy" }, "httpMethod": "POST", "path": "v1/{+parent}/taxonomies" }, "export": { "parameters": { "taxonomies": { "location": "query", "repeated": true, "type": "string", "description": "Required. Resource names of the taxonomies to export." }, "parent": { "description": "Required. Resource name of the project that the exported taxonomies belong to.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" }, "serializedTaxonomies": { "type": "boolean", "description": "Serialized export taxonomies that contain all the policy tags as nested protocol buffers.", "location": "query" } }, "response": { "$ref": "GoogleCloudDatacatalogV1ExportTaxonomiesResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/taxonomies:export", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "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.", "id": "datacatalog.projects.locations.taxonomies.export", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies:export" }, "setIamPolicy": { "response": { "$ref": "Policy" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "required": true, "location": "path" } }, "path": "v1/{+resource}:setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "description": "Sets the IAM policy for a policy tag or a taxonomy.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "id": "datacatalog.projects.locations.taxonomies.setIamPolicy" } }, "resources": { "policyTags": { "methods": { "setIamPolicy": { "httpMethod": "POST", "path": "v1/{+resource}:setIamPolicy", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+/policyTags/[^/]+$", "type": "string" } }, "response": { "$ref": "Policy" }, "id": "datacatalog.projects.locations.taxonomies.policyTags.setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "description": "Sets the IAM policy for a policy tag or a taxonomy." }, "getIamPolicy": { "path": "v1/{+resource}:getIamPolicy", "httpMethod": "POST", "response": { "$ref": "Policy" }, "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+/policyTags/[^/]+$", "type": "string", "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}:getIamPolicy", "id": "datacatalog.projects.locations.taxonomies.policyTags.getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "description": "Gets the IAM policy for a policy tag or a taxonomy.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. Resource name of the policy tag.", "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+/policyTags/[^/]+$", "type": "string", "required": true, "location": "path" } }, "response": { "$ref": "GoogleCloudDatacatalogV1PolicyTag" }, "id": "datacatalog.projects.locations.taxonomies.policyTags.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets a policy tag." }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Creates a policy tag in a taxonomy.", "id": "datacatalog.projects.locations.taxonomies.policyTags.create", "request": { "$ref": "GoogleCloudDatacatalogV1PolicyTag" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. Resource name of the taxonomy that the policy tag will belong to." } }, "response": { "$ref": "GoogleCloudDatacatalogV1PolicyTag" }, "httpMethod": "POST", "path": "v1/{+parent}/policyTags" }, "delete": { "id": "datacatalog.projects.locations.taxonomies.policyTags.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "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", "httpMethod": "DELETE", "path": "v1/{+name}", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+/policyTags/[^/]+$", "type": "string", "description": "Required. Resource name of the policy tag to delete. Note: All of its descendant policy tags are also deleted." } }, "response": { "$ref": "Empty" } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Updates a policy tag, including its display name, description, and parent policy tag.", "request": { "$ref": "GoogleCloudDatacatalogV1PolicyTag" }, "id": "datacatalog.projects.locations.taxonomies.policyTags.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}", "parameters": { "name": { "description": "Identifier. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+/policyTags/[^/]+$", "type": "string" }, "updateMask": { "type": "string", "description": "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).", "format": "google-fieldmask", "location": "query" } }, "response": { "$ref": "GoogleCloudDatacatalogV1PolicyTag" }, "httpMethod": "PATCH", "path": "v1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Lists all policy tags in a taxonomy.", "id": "datacatalog.projects.locations.taxonomies.policyTags.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags", "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50." }, "pageToken": { "location": "query", "type": "string", "description": "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." }, "parent": { "description": "Required. Resource name of the taxonomy to list the policy tags of.", "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+$", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "GoogleCloudDatacatalogV1ListPolicyTagsResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/policyTags" }, "testIamPermissions": { "path": "v1/{+resource}:testIamPermissions", "httpMethod": "POST", "response": { "$ref": "TestIamPermissionsResponse" }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/taxonomies/[^/]+/policyTags/[^/]+$", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "id": "datacatalog.projects.locations.taxonomies.policyTags.testIamPermissions", "parameterOrder": [ "resource" ], "description": "Returns your permissions on a specified policy tag or taxonomy.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } } }, "catalog": { "methods": { "search": { "parameters": {}, "response": { "$ref": "GoogleCloudDatacatalogV1SearchCatalogResponse" }, "httpMethod": "POST", "path": "v1/catalog:search", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [], "description": "Searches 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).", "request": { "$ref": "GoogleCloudDatacatalogV1SearchCatalogRequest" }, "id": "datacatalog.catalog.search", "flatPath": "v1/catalog:search" } }, "deprecated": true }, "organizations": { "resources": { "locations": { "methods": { "retrieveEffectiveConfig": { "parameterOrder": [ "name" ], "description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog 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.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:retrieveEffectiveConfig", "id": "datacatalog.organizations.locations.retrieveEffectiveConfig", "response": { "$ref": "GoogleCloudDatacatalogV1MigrationConfig" }, "parameters": { "name": { "description": "Required. The resource whose effective config is being retrieved.", "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "type": "string" } }, "path": "v1/{+name}:retrieveEffectiveConfig", "httpMethod": "GET" }, "setConfig": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true, "parameterOrder": [ "name" ], "description": "Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.", "id": "datacatalog.organizations.locations.setConfig", "request": { "$ref": "GoogleCloudDatacatalogV1SetConfigRequest" }, "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:setConfig", "parameters": { "name": { "location": "path", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The organization or project whose config is being specified." } }, "response": { "$ref": "GoogleCloudDatacatalogV1MigrationConfig" }, "httpMethod": "POST", "path": "v1/{+name}:setConfig" }, "retrieveConfig": { "path": "v1/{+name}:retrieveConfig", "httpMethod": "GET", "response": { "$ref": "GoogleCloudDatacatalogV1OrganizationConfig" }, "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The organization whose config is being retrieved." } }, "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:retrieveConfig", "id": "datacatalog.organizations.locations.retrieveConfig", "parameterOrder": [ "name" ], "description": "Retrieves the configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization, including all the projects under it which have a separate configuration set.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "deprecated": true } }, "deprecated": true } } } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "id": "datacatalog:v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "discoveryVersion": "v1", "canonicalName": "Data Catalog", "name": "datacatalog", "ownerDomain": "google.com", "parameters": { "callback": { "location": "query", "description": "JSONP", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query", "default": "true" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "quotaUser": { "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "alt": { "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "location": "query" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" } }, "version": "v1", "servicePath": "", "mtlsRootUrl": "https://datacatalog.mtls.googleapis.com/", "revision": "20260427" }