{ "version": "v1beta", "version_module": true, "discoveryVersion": "v1", "basePath": "", "protocol": "rest", "mtlsRootUrl": "https://metastore.mtls.googleapis.com/", "rootUrl": "https://metastore.googleapis.com/", "ownerDomain": "google.com", "batchPath": "batch", "ownerName": "Google", "name": "metastore", "title": "Dataproc Metastore API", "id": "metastore:v1beta", "revision": "20260916", "canonicalName": "Dataproc Metastore", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "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." } } } }, "baseUrl": "https://metastore.googleapis.com/", "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", "resources": { "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "cancel": { "response": { "$ref": "Empty" }, "id": "metastore.projects.locations.operations.cancel", "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "path": "v1beta/{+name}:cancel", "httpMethod": "POST", "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" ], "request": { "$ref": "CancelOperationRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel" }, "list": { "response": { "$ref": "ListOperationsResponse" }, "id": "metastore.projects.locations.operations.list", "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "returnPartialSuccess": { "location": "query", "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" }, "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "The name of the operation's parent resource.", "location": "path", "required": true, "type": "string" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.", "httpMethod": "GET", "path": "v1beta/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", "parameterOrder": [ "name" ] }, "get": { "id": "metastore.projects.locations.operations.get", "httpMethod": "GET", "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.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted." } }, "id": "metastore.projects.locations.operations.delete", "path": "v1beta/{+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.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "httpMethod": "DELETE" } } }, "federations": { "methods": { "patch": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "parameters": { "updateMask": { "description": "Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.", "format": "google-fieldmask", "type": "string", "location": "query" }, "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$", "description": "Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`." }, "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string", "location": "query" } }, "response": { "$ref": "Operation" }, "description": "Updates the fields of a federation.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}", "request": { "$ref": "Federation" }, "httpMethod": "PATCH", "id": "metastore.projects.locations.federations.patch" }, "list": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/federations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000." }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to ListFederationServices must match the call that provided the page token." }, "filter": { "description": "Optional. The filter to apply to list results.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.", "type": "string", "location": "query" } }, "path": "v1beta/{+parent}/federations", "description": "Lists federations in a project and location.", "response": { "$ref": "ListFederationsResponse" }, "parameterOrder": [ "parent" ], "id": "metastore.projects.locations.federations.list", "httpMethod": "GET" }, "create": { "path": "v1beta/{+parent}/federations", "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/federations", "parameters": { "parent": { "description": "Required. The relative resource name of the location in which to create a federation service, in the following form:projects/{project_number}/locations/{location_id}.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "federationId": { "type": "string", "description": "Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.", "location": "query" }, "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "location": "query", "type": "string" } }, "request": { "$ref": "Federation" }, "response": { "$ref": "Operation" }, "description": "Creates a metastore federation in a project and location.", "id": "metastore.projects.locations.federations.create", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:testIamPermissions", "id": "metastore.projects.locations.federations.testIamPermissions", "httpMethod": "POST", "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" }, "path": "v1beta/{+resource}:testIamPermissions", "response": { "$ref": "TestIamPermissionsResponse" }, "parameters": { "resource": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$", "type": "string", "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." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "httpMethod": "POST", "response": { "$ref": "Policy" }, "parameterOrder": [ "resource" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "path": "v1beta/{+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, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "metastore.projects.locations.federations.setIamPolicy" }, "getIamPolicy": { "path": "v1beta/{+resource}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:getIamPolicy", "httpMethod": "GET", "response": { "$ref": "Policy" }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameters": { "options.requestedPolicyVersion": { "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).", "format": "int32", "location": "query", "type": "integer" }, "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.", "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "resource" ], "id": "metastore.projects.locations.federations.getIamPolicy" }, "delete": { "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "description": "Deletes a single federation.", "id": "metastore.projects.locations.federations.delete", "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$", "location": "path", "required": true, "description": "Required. The relative resource name of the metastore federation to delete, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}." }, "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "location": "query", "type": "string" } } }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}", "description": "Gets the details of a single federation.", "id": "metastore.projects.locations.federations.get", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$", "description": "Required. The relative resource name of the metastore federation to retrieve, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.", "type": "string" } }, "response": { "$ref": "Federation" }, "path": "v1beta/{+name}" } } }, "services": { "resources": { "metadataImports": { "methods": { "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports/{metadataImportsId}", "description": "Gets details of a single import.", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "metastore.projects.locations.services.metadataImports.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/metadataImports/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The relative resource name of the metadata import to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}." } }, "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "MetadataImport" } }, "create": { "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/metadataImports", "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports", "description": "Creates a new MetadataImport in a given project and location.", "request": { "$ref": "MetadataImport" }, "parameters": { "metadataImportId": { "location": "query", "type": "string", "description": "Required. The ID of the metadata import, which is used as the final component of the metadata import's name.This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens." }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. The relative resource name of the service in which to create a metastore import, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.", "location": "path", "required": true }, "requestId": { "location": "query", "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string" } }, "id": "metastore.projects.locations.services.metadataImports.create", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "httpMethod": "PATCH", "id": "metastore.projects.locations.services.metadataImports.patch", "description": "Updates a single import. Only the description field of MetadataImport is supported to be updated.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports/{metadataImportsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "parameters": { "updateMask": { "location": "query", "description": "Required. A field mask used to specify the fields to be overwritten in the metadata import resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.", "format": "google-fieldmask", "type": "string" }, "name": { "location": "path", "required": true, "description": "Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/metadataImports/[^/]+$" }, "requestId": { "type": "string", "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "location": "query" } }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "MetadataImport" } }, "list": { "id": "metastore.projects.locations.services.metadataImports.list", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The relative resource name of the service whose metadata imports to list, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports." }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. The maximum number of imports to return. The response may contain less than the maximum number. If unspecified, no more than 500 imports are returned. The maximum value is 1000; values above 1000 are changed to 1000." }, "filter": { "type": "string", "location": "query", "description": "Optional. The filter to apply to list results." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order." }, "pageToken": { "description": "Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListServices must match the call that provided the page token.", "type": "string", "location": "query" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports", "response": { "$ref": "ListMetadataImportsResponse" }, "description": "Lists imports in a service.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/metadataImports", "parameterOrder": [ "parent" ], "httpMethod": "GET" } } }, "migrationExecutions": { "methods": { "delete": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}", "parameters": { "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string", "location": "query" }, "name": { "description": "Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$" } }, "parameterOrder": [ "name" ], "id": "metastore.projects.locations.services.migrationExecutions.delete", "httpMethod": "DELETE", "description": "Deletes a single migration execution.", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" } }, "list": { "response": { "$ref": "ListMigrationExecutionsResponse" }, "parameters": { "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. The relative resource name of the service whose migration executions to list, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions." }, "orderBy": { "location": "query", "description": "Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "Optional. The maximum number of migration executions to return. The response may contain less than the maximum number. If unspecified, no more than 500 migration executions are returned. The maximum value is 1000; values above 1000 are changed to 1000.", "type": "integer" }, "filter": { "location": "query", "type": "string", "description": "Optional. The filter to apply to list results." }, "pageToken": { "description": "Optional. A page token, received from a previous DataprocMetastore.ListMigrationExecutions call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListMigrationExecutions must match the call that provided the page token.", "type": "string", "location": "query" } }, "id": "metastore.projects.locations.services.migrationExecutions.list", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions", "description": "Lists migration executions on a service.", "path": "v1beta/{+parent}/migrationExecutions", "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "MigrationExecution" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v1beta/{+name}", "id": "metastore.projects.locations.services.migrationExecutions.get", "description": "Gets details of a single migration execution.", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$", "type": "string", "description": "Required. The relative resource name of the migration execution to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}." } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}" } } }, "databases": { "methods": { "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.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/databases/[^/]+$" }, "options.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", "location": "query" } }, "path": "v1beta/{+resource}:getIamPolicy", "id": "metastore.projects.locations.services.databases.getIamPolicy", "httpMethod": "GET", "parameterOrder": [ "resource" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}:getIamPolicy" }, "testIamPermissions": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}:testIamPermissions", "path": "v1beta/{+resource}:testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "request": { "$ref": "TestIamPermissionsRequest" }, "id": "metastore.projects.locations.services.databases.testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/databases/[^/]+$", "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." } }, "parameterOrder": [ "resource" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "TestIamPermissionsResponse" } }, "setIamPolicy": { "response": { "$ref": "Policy" }, "httpMethod": "POST", "path": "v1beta/{+resource}:setIamPolicy", "id": "metastore.projects.locations.services.databases.setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "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/[^/]+/services/[^/]+/databases/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}:setIamPolicy" } }, "resources": { "tables": { "methods": { "setIamPolicy": { "path": "v1beta/{+resource}:setIamPolicy", "id": "metastore.projects.locations.services.databases.tables.setIamPolicy", "parameterOrder": [ "resource" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "response": { "$ref": "Policy" }, "httpMethod": "POST", "request": { "$ref": "SetIamPolicyRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}/tables/{tablesId}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/databases/[^/]+/tables/[^/]+$" } } }, "testIamPermissions": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}/tables/{tablesId}:testIamPermissions", "parameterOrder": [ "resource" ], "id": "metastore.projects.locations.services.databases.tables.testIamPermissions", "httpMethod": "POST", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "request": { "$ref": "TestIamPermissionsRequest" }, "path": "v1beta/{+resource}:testIamPermissions", "parameters": { "resource": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/databases/[^/]+/tables/[^/]+$", "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" } }, "getIamPolicy": { "parameterOrder": [ "resource" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}/tables/{tablesId}:getIamPolicy", "httpMethod": "GET", "path": "v1beta/{+resource}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameters": { "resource": { "location": "path", "required": true, "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.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/databases/[^/]+/tables/[^/]+$" }, "options.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", "location": "query" } }, "id": "metastore.projects.locations.services.databases.tables.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Policy" } } } } } }, "backups": { "methods": { "testIamPermissions": { "httpMethod": "POST", "id": "metastore.projects.locations.services.backups.testIamPermissions", "path": "v1beta/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "TestIamPermissionsResponse" }, "request": { "$ref": "TestIamPermissionsRequest" }, "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$", "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." } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}:testIamPermissions", "parameterOrder": [ "resource" ], "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning." }, "setIamPolicy": { "id": "metastore.projects.locations.services.backups.setIamPolicy", "response": { "$ref": "Policy" }, "path": "v1beta/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "request": { "$ref": "SetIamPolicyRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}:setIamPolicy", "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$", "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." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "metastore.projects.locations.services.backups.delete", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$", "description": "Required. The relative resource name of the backup to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.", "type": "string" }, "requestId": { "location": "query", "type": "string", "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported." } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}", "description": "Deletes a single backup.", "httpMethod": "DELETE" }, "create": { "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. The relative resource name of the service in which to create a backup of the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" }, "requestId": { "location": "query", "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string" }, "backupId": { "type": "string", "description": "Required. The ID of the backup, which is used as the final component of the backup's name.This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.", "location": "query" } }, "description": "Creates a new backup in a given project and location.", "response": { "$ref": "Operation" }, "id": "metastore.projects.locations.services.backups.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups", "request": { "$ref": "Backup" }, "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/backups" }, "get": { "httpMethod": "GET", "response": { "$ref": "Backup" }, "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$", "description": "Required. The relative resource name of the backup to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}", "id": "metastore.projects.locations.services.backups.get", "description": "Gets details of a single backup.", "parameterOrder": [ "name" ] }, "getIamPolicy": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "metastore.projects.locations.services.backups.getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameterOrder": [ "resource" ], "path": "v1beta/{+resource}:getIamPolicy", "response": { "$ref": "Policy" }, "parameters": { "options.requestedPolicyVersion": { "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).", "location": "query", "type": "integer", "format": "int32" }, "resource": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$", "type": "string" } } }, "list": { "httpMethod": "GET", "id": "metastore.projects.locations.services.backups.list", "response": { "$ref": "ListBackupsResponse" }, "description": "Lists backups in a service.", "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "location": "query", "description": "Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500 backups are returned. The maximum value is 1000; values above 1000 are changed to 1000.", "type": "integer" }, "filter": { "type": "string", "description": "Optional. The filter to apply to list results.", "location": "query" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. The relative resource name of the service whose backups to list, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups.", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous DataprocMetastore.ListBackups call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListBackups must match the call that provided the page token." } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups", "path": "v1beta/{+parent}/backups", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "list": { "description": "Lists services in a project and location.", "response": { "$ref": "ListServicesResponse" }, "id": "metastore.projects.locations.services.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+parent}/services", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "description": "Optional. The maximum number of services to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListServices must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The relative resource name of the location of metastore services to list, in the following form:projects/{project_number}/locations/{location_id}." }, "orderBy": { "type": "string", "description": "Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.", "location": "query" }, "filter": { "description": "Optional. The filter to apply to list results.", "type": "string", "location": "query" } } }, "exportMetadata": { "description": "Exports metadata from a service.", "request": { "$ref": "ExportMetadataRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:exportMetadata", "httpMethod": "POST", "path": "v1beta/{+service}:exportMetadata", "parameters": { "service": { "type": "string", "location": "path", "required": true, "description": "Required. The relative resource name of the metastore service to run export, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$" } }, "id": "metastore.projects.locations.services.exportMetadata", "parameterOrder": [ "service" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" } }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "httpMethod": "DELETE", "path": "v1beta/{+name}", "response": { "$ref": "Operation" }, "description": "Deletes a single service.", "id": "metastore.projects.locations.services.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The relative resource name of the metastore service to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}." }, "requestId": { "location": "query", "type": "string", "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "removeIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+resource}:removeIamPolicy", "id": "metastore.projects.locations.services.removeIamPolicy", "parameters": { "resource": { "description": "Required. The relative resource name of the dataplane resource to remove IAM policy, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id} or projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}/tables/{table_id}.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/.*$" } }, "response": { "$ref": "RemoveIamPolicyResponse" }, "request": { "$ref": "RemoveIamPolicyRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/{servicesId1}:removeIamPolicy", "description": "Removes the attached IAM policies for a resource", "httpMethod": "POST", "parameterOrder": [ "resource" ] }, "create": { "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "metastore.projects.locations.services.create", "request": { "$ref": "Service" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The relative resource name of the location in which to create a metastore service, in the following form:projects/{project_number}/locations/{location_id}.", "type": "string" }, "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "location": "query", "type": "string" }, "serviceId": { "description": "Required. The ID of the metastore service, which is used as the final component of the metastore service's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.", "location": "query", "type": "string" } }, "description": "Creates a metastore service in a project and location.", "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services", "path": "v1beta/{+parent}/services" }, "restore": { "id": "metastore.projects.locations.services.restore", "parameterOrder": [ "service" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+service}:restore", "response": { "$ref": "Operation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:restore", "parameters": { "service": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. The relative resource name of the metastore service to run restore, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}.", "location": "path", "required": true } }, "request": { "$ref": "RestoreServiceRequest" }, "description": "Restores a service from a backup." }, "completeMigration": { "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameterOrder": [ "service" ], "parameters": { "service": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. The relative resource name of the metastore service to complete the migration to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.", "location": "path", "required": true } }, "request": { "$ref": "CompleteMigrationRequest" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:completeMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration.", "id": "metastore.projects.locations.services.completeMigration", "path": "v1beta/{+service}:completeMigration" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "httpMethod": "GET", "id": "metastore.projects.locations.services.get", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "parameterOrder": [ "name" ], "description": "Gets the details of a single service.", "response": { "$ref": "Service" }, "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. The relative resource name of the metastore service to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" } } }, "getIamPolicy": { "parameters": { "options.requestedPolicyVersion": { "location": "query", "type": "integer", "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)." }, "resource": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "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.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Policy" }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1beta/{+resource}:getIamPolicy", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy", "httpMethod": "GET", "parameterOrder": [ "resource" ], "id": "metastore.projects.locations.services.getIamPolicy" }, "startMigration": { "path": "v1beta/{+service}:startMigration", "id": "metastore.projects.locations.services.startMigration", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:startMigration", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "service": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "required": true, "description": "Required. The relative resource name of the metastore service to start migrating to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}." } }, "parameterOrder": [ "service" ], "response": { "$ref": "Operation" }, "description": "Starts the Managed Migration process.", "httpMethod": "POST", "request": { "$ref": "StartMigrationRequest" } }, "testIamPermissions": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}: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/[^/]+/services/[^/]+$", "type": "string", "location": "path", "required": true } }, "request": { "$ref": "TestIamPermissionsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+resource}:testIamPermissions", "id": "metastore.projects.locations.services.testIamPermissions", "httpMethod": "POST", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameterOrder": [ "resource" ], "response": { "$ref": "TestIamPermissionsResponse" } }, "cancelMigration": { "request": { "$ref": "CancelMigrationRequest" }, "parameters": { "service": { "location": "path", "required": true, "description": "Required. The relative resource name of the metastore service to cancel the ongoing migration to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "type": "string" } }, "parameterOrder": [ "service" ], "response": { "$ref": "Operation" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:cancelMigration", "description": "Cancels the ongoing Managed Migration process.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+service}:cancelMigration", "id": "metastore.projects.locations.services.cancelMigration", "httpMethod": "POST" }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "httpMethod": "POST", "path": "v1beta/{+resource}:setIamPolicy", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "response": { "$ref": "Policy" }, "request": { "$ref": "SetIamPolicyRequest" }, "id": "metastore.projects.locations.services.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.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "required": true, "type": "string" } } }, "queryMetadata": { "httpMethod": "POST", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "QueryMetadataRequest" }, "parameters": { "service": { "type": "string", "description": "Required. The relative resource name of the metastore service to query metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "required": true } }, "id": "metastore.projects.locations.services.queryMetadata", "description": "Query Dataproc Metastore metadata.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:queryMetadata", "path": "v1beta/{+service}:queryMetadata", "parameterOrder": [ "service" ] }, "moveTableToDatabase": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "MoveTableToDatabaseRequest" }, "response": { "$ref": "Operation" }, "id": "metastore.projects.locations.services.moveTableToDatabase", "parameterOrder": [ "service" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:moveTableToDatabase", "path": "v1beta/{+service}:moveTableToDatabase", "parameters": { "service": { "location": "path", "required": true, "description": "Required. The relative resource name of the metastore service to mutate metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "type": "string" } }, "description": "Move a table to another database." }, "alterLocation": { "parameterOrder": [ "service" ], "response": { "$ref": "Operation" }, "httpMethod": "POST", "id": "metastore.projects.locations.services.alterLocation", "request": { "$ref": "AlterMetadataResourceLocationRequest" }, "path": "v1beta/{+service}:alterLocation", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterLocation", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.", "parameters": { "service": { "type": "string", "location": "path", "required": true, "description": "Required. The relative resource name of the metastore service to mutate metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$" } } }, "patch": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "required": true, "description": "Immutable. Identifier. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$" }, "requestId": { "type": "string", "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "location": "query" }, "updateMask": { "location": "query", "description": "Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.", "type": "string", "format": "google-fieldmask" } }, "path": "v1beta/{+name}", "description": "Updates the parameters of a single service.", "parameterOrder": [ "name" ], "id": "metastore.projects.locations.services.patch", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Service" } }, "alterTableProperties": { "response": { "$ref": "Operation" }, "description": "Alter metadata table properties.", "parameters": { "service": { "type": "string", "description": "Required. The relative resource name of the Dataproc Metastore service that's being used to mutate metadata table properties, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "required": true } }, "parameterOrder": [ "service" ], "path": "v1beta/{+service}:alterTableProperties", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "metastore.projects.locations.services.alterTableProperties", "request": { "$ref": "AlterTablePropertiesRequest" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterTableProperties" } } } }, "methods": { "get": { "path": "v1beta/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "Location" }, "description": "Gets information about a location.", "id": "metastore.projects.locations.get" }, "list": { "httpMethod": "GET", "path": "v1beta/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+$" }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in AIP-160 (https://google.aip.dev/160).", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" }, "extraLocationTypes": { "repeated": true, "type": "string", "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." }, "pageToken": { "description": "A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.", "type": "string", "location": "query" } }, "flatPath": "v1beta/projects/{projectsId}/locations", "description": "Lists information about the supported locations for this service.This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: Global locations: If name is empty, the method lists the public locations available to all projects. Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "id": "metastore.projects.locations.list", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "fullyEncodeReservedExpansion": true, "parameters": { "key": { "type": "string", "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.", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "enum": [ "json", "media", "proto" ], "type": "string", "default": "json", "description": "Data format for response." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "quotaUser": { "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.", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query" } }, "servicePath": "", "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", "kind": "discovery#restDescription", "schemas": { "CustomRegionMetadata": { "type": "object", "deprecated": true, "description": "Deprecated: Use a single region service instead. Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", "properties": { "witnessRegion": { "description": "The Spanner witness region for this custom region.", "type": "string" }, "optionalReadOnlyRegions": { "type": "array", "items": { "type": "string" }, "description": "The read-only regions for this custom region." }, "requiredReadWriteRegions": { "type": "array", "items": { "type": "string" }, "description": "The read-write regions for this custom region." } }, "id": "CustomRegionMetadata" }, "Status": { "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).", "id": "Status", "type": "object", "properties": { "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "type": "array" }, "message": { "type": "string", "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." }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } } }, "RootCACertificate": { "properties": { "expirationTime": { "type": "string", "format": "google-datetime", "description": "Deprecated: Use a single region service instead. The certificate expiration time in timestamp format.", "deprecated": true }, "certificate": { "type": "string", "description": "Deprecated: Use a single region service instead. The root CA certificate in PEM format. The maximum length is 65536 bytes.", "deprecated": true } }, "type": "object", "deprecated": true, "description": "Deprecated: Use a single region service instead. A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", "id": "RootCACertificate" }, "QueryMetadataResponse": { "id": "QueryMetadataResponse", "properties": { "resultManifestUri": { "type": "string", "description": "The manifest URI is link to a JSON instance in Cloud Storage. This instance manifests immediately along with QueryMetadataResponse. The content of the URI is not retriable until the long-running operation query against the metadata finishes." } }, "type": "object", "description": "Response message for DataprocMetastore.QueryMetadata." }, "CancelMigrationRequest": { "properties": {}, "description": "Request message for DataprocMetastore.CancelMigration.", "id": "CancelMigrationRequest", "type": "object" }, "Lake": { "id": "Lake", "type": "object", "properties": { "name": { "description": "The Lake resource name. Example: projects/{project_number}/locations/{location_id}/lakes/{lake_id}", "type": "string" } }, "description": "Represents a Lake resource" }, "CancelOperationRequest": { "id": "CancelOperationRequest", "properties": {}, "description": "The request message for Operations.CancelOperation.", "type": "object" }, "LatestBackup": { "properties": { "backupId": { "description": "Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.", "readOnly": true, "type": "string" }, "duration": { "type": "string", "readOnly": true, "description": "Output only. The duration of the backup completion.", "format": "google-duration" }, "state": { "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "SUCCEEDED", "FAILED" ], "enumDescriptions": [ "The state of the backup is unknown.", "The backup is in progress.", "The backup completed.", "The backup failed." ], "type": "string", "readOnly": true, "description": "Output only. The current state of the backup." }, "startTime": { "readOnly": true, "description": "Output only. The time when the backup was started.", "format": "google-datetime", "type": "string" } }, "type": "object", "id": "LatestBackup", "description": "The details of the latest scheduled backup." }, "StatusProto": { "description": "Wire-format for a Status object", "id": "StatusProto", "properties": { "canonicalCode": { "format": "int32", "type": "integer", "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;" }, "code": { "format": "int32", "type": "integer", "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;" }, "message": { "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", "type": "string" }, "space": { "type": "string", "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs" }, "messageSet": { "$ref": "MessageSet", "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" } }, "type": "object" }, "CompleteMigrationResponse": { "type": "object", "id": "CompleteMigrationResponse", "properties": { "migrationExecution": { "description": "The relative resource name of the migration execution, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.", "type": "string" } }, "description": "Response message for DataprocMetastore.CompleteMigration." }, "Service": { "properties": { "state": { "type": "string", "enumDescriptions": [ "The state of the metastore service is unknown.", "The metastore service is in the process of being created.", "The metastore service is running and ready to serve queries.", "The metastore service is entering suspension. Its query-serving availability may cease unexpectedly.", "The metastore service is suspended and unable to serve queries.", "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", "The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration.", "The metastore service has completed managed migration and is now proxying requests to the Lakehouse runtime catalog." ], "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "SUSPENDING", "SUSPENDED", "UPDATING", "DELETING", "ERROR", "AUTOSCALING", "MIGRATING", "PROXY" ], "description": "Output only. The current state of the metastore service." }, "multiRegionConfig": { "description": "Optional. Deprecated: Use a single region service instead. Specifies the multi-region configuration information for the Hive metastore service.", "deprecated": true, "$ref": "MultiRegionConfig" }, "telemetryConfig": { "description": "Optional. The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.", "$ref": "TelemetryConfig" }, "metadataManagementActivity": { "readOnly": true, "description": "Output only. The metadata management activities of the metastore service.", "$ref": "MetadataManagementActivity" }, "deletionProtection": { "type": "boolean", "description": "Optional. Indicates if the dataproc metastore should be protected against accidental deletions." }, "tier": { "enumDescriptions": [ "The tier is not set.", "The developer tier provides limited scalability and no fault tolerance. Good for low-cost proof-of-concept.", "The enterprise tier provides multi-zone high availability, and sufficient scalability for enterprise-level Dataproc Metastore workloads." ], "description": "Optional. The tier of the service.", "type": "string", "enum": [ "TIER_UNSPECIFIED", "DEVELOPER", "ENTERPRISE" ] }, "maintenanceWindow": { "description": "Optional. The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type.", "$ref": "MaintenanceWindow" }, "releaseChannel": { "type": "string", "enumDescriptions": [ "Release channel is not specified.", "The CANARY release channel contains the newest features, which may be unstable and subject to unresolved issues with no known workarounds. Services using the CANARY release channel are not subject to any SLAs.", "The STABLE release channel contains features that are considered stable and have been validated for production use." ], "enum": [ "RELEASE_CHANNEL_UNSPECIFIED", "CANARY", "STABLE" ], "description": "Immutable. The release channel of the service. If unspecified, defaults to STABLE." }, "hiveMetastoreConfig": { "description": "Configuration information specific to running Hive metastore software as the metastore service.", "$ref": "HiveMetastoreConfig" }, "stateMessage": { "description": "Output only. Additional information about the current state of the metastore service, if available.", "type": "string", "readOnly": true }, "scalingConfig": { "description": "Optional. Scaling configuration of the metastore service.", "$ref": "ScalingConfig" }, "artifactGcsUri": { "type": "string", "readOnly": true, "description": "Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored." }, "databaseType": { "enum": [ "DATABASE_TYPE_UNSPECIFIED", "MYSQL", "SPANNER" ], "type": "string", "enumDescriptions": [ "The DATABASE_TYPE is not set.", "MySQL is used to persist the metastore data.", "Spanner is used to persist the metastore data." ], "description": "Immutable. The database type that the Metastore service stores its data." }, "network": { "description": "Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.", "type": "string" }, "scheduledBackup": { "$ref": "ScheduledBackup", "description": "Optional. The configuration of scheduled backup for the metastore service." }, "tags": { "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "additionalProperties": { "type": "string" }, "type": "object" }, "endpointUri": { "type": "string", "readOnly": true, "description": "Output only. The URI of the endpoint used to access the metastore service." }, "labels": { "description": "User-defined labels for the metastore service.", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Immutable. Identifier. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" }, "networkConfig": { "description": "Optional. The configuration specifying the network settings for the Dataproc Metastore service.", "$ref": "NetworkConfig" }, "uid": { "type": "string", "readOnly": true, "description": "Output only. The globally unique resource identifier of the metastore service." }, "updateTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time when the metastore service was last updated." }, "port": { "format": "int32", "description": "Optional. The TCP port at which the metastore service is reached. Default: 9083.", "type": "integer" }, "encryptionConfig": { "description": "Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.", "$ref": "EncryptionConfig" }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time when the metastore service was created.", "type": "string" }, "lakehouseProxyConfig": { "$ref": "LakehouseProxyConfig", "description": "Output only. The Lakehouse proxy routing configuration for the metastore service.", "readOnly": true }, "metadataIntegration": { "description": "Optional. The setting that defines how metastore metadata should be integrated with external services and systems.", "$ref": "MetadataIntegration" } }, "type": "object", "description": "A managed metastore service that serves metadata queries.", "id": "Service" }, "AuxiliaryVersionConfig": { "properties": { "version": { "type": "string", "description": "Optional. The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version." }, "networkConfig": { "$ref": "NetworkConfig", "description": "Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service.", "readOnly": true }, "configOverrides": { "additionalProperties": { "type": "string" }, "description": "Optional. A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence.", "type": "object" } }, "id": "AuxiliaryVersionConfig", "type": "object", "description": "Configuration information for the auxiliary service versions." }, "DatabaseReport": { "id": "DatabaseReport", "description": "Aggregated report at the database level.", "properties": { "tableReports": { "type": "object", "description": "A map of table names to their respective reports.", "additionalProperties": { "$ref": "TableReport" } }, "executionPlan": { "description": "The discovered intent for the database (what we found and what we planned).", "$ref": "ExecutionPlan" }, "executionResult": { "description": "The actual outcome of the database migration.", "$ref": "ExecutionResult" }, "database": { "description": "The name of the database.", "type": "string" } }, "type": "object" }, "TableReport": { "description": "Aggregated report at the table level.", "id": "TableReport", "type": "object", "properties": { "table": { "description": "The name of the table.", "type": "string" }, "executionPlan": { "$ref": "ExecutionPlan", "description": "The discovered intent for the table (what we found and what we planned)." }, "partitionDiscoveredCount": { "format": "int64", "type": "string", "description": "The total number of partitions identified at the source during discovery. This is only relevant for Hive Partitioned tables." }, "executionResult": { "description": "The actual outcome of the table migration.", "$ref": "ExecutionResult" }, "partitionReport": { "description": "Report containing the results of partition migration for this table. This is only relevant for Hive Partitioned tables.", "$ref": "PartitionReport" } } }, "AlterTablePropertiesRequest": { "id": "AlterTablePropertiesRequest", "type": "object", "description": "Request message for DataprocMetastore.AlterTableProperties.", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map that describes the desired values to mutate. If update_mask is empty, the properties will not update. Otherwise, the properties only alters the value whose associated paths exist in the update mask" }, "tableName": { "description": "Required. The name of the table containing the properties you're altering in the following format.databases/{database_id}/tables/{table_id}", "type": "string" }, "updateMask": { "type": "string", "description": "A field mask that specifies the metadata table properties that are overwritten by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.For example, given the target properties: properties { a: 1 b: 2 } And an update properties: properties { a: 2 b: 3 c: 4 } then if the field mask is:paths: \"properties.b\", \"properties.c\"then the result will be: properties { a: 1 b: 3 c: 4 } ", "format": "google-fieldmask" } } }, "ValueDiff": { "id": "ValueDiff", "description": "A field-level metadata mismatch for a resource between the source and target.", "properties": { "targetValue": { "type": "string", "description": "The value of the field at the target." }, "sourceValue": { "type": "string", "description": "The value of the field at the source." } }, "type": "object" }, "MetadataManagementActivity": { "id": "MetadataManagementActivity", "properties": { "restores": { "items": { "$ref": "Restore" }, "description": "Output only. The latest restores of the metastore service.", "type": "array", "readOnly": true }, "metadataExports": { "type": "array", "items": { "$ref": "MetadataExport" }, "readOnly": true, "description": "Output only. The latest metadata exports of the metastore service." } }, "description": "The metadata management activities of the metastore service.", "type": "object" }, "RemoveIamPolicyResponse": { "description": "Response message for DataprocMetastore.RemoveIamPolicy.", "id": "RemoveIamPolicyResponse", "type": "object", "properties": { "success": { "type": "boolean", "description": "True if the policy is successfully removed." } } }, "MetadataIntegration": { "id": "MetadataIntegration", "properties": { "dataCatalogConfig": { "description": "Optional. The integration config for the Data Catalog service.", "$ref": "DataCatalogConfig" }, "dataplexConfig": { "description": "Optional. The integration config for the Dataplex service.", "$ref": "DataplexConfig" } }, "description": "Specifies how metastore metadata should be integrated with external services.", "type": "object" }, "Policy": { "type": "object", "properties": { "etag": { "type": "string", "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.", "format": "byte" }, "bindings": { "type": "array", "items": { "$ref": "Binding" }, "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." }, "version": { "type": "integer", "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 conditionsImportant: 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).", "format": "int32" }, "auditConfigs": { "items": { "$ref": "AuditConfig" }, "type": "array", "description": "Specifies cloud audit logging configuration for this policy." } }, "id": "Policy", "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/)." }, "ExecutionPlan": { "properties": { "reason": { "description": "A human-readable string explaining why the action was chosen.", "type": "string" }, "action": { "enum": [ "ACTION_UNSPECIFIED", "CREATE", "UPDATE", "SKIP", "DEPENDENCY_FAILURE", "ERROR" ], "type": "string", "description": "The action that will be taken for a resource during migration.", "enumDescriptions": [ "The action is unspecified.", "Resource missing; will be created.", "Resource exists at the target, but differs from the source; will be updated.", "Resource exists at the target; no changes will be made.", "Resource cannot be migrated due to a dependency failure (e.g., parent resource missing).", "Resource cannot be migrated due to an error during discovery." ] }, "diffs": { "type": "object", "additionalProperties": { "$ref": "ValueDiff" }, "description": "A map of field names to their respective value diff." } }, "type": "object", "id": "ExecutionPlan", "description": "Represents the migration plan for a specific resource (e.g. Database, Table)." }, "Consumer": { "properties": { "subnetwork": { "type": "string", "description": "Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}" }, "endpointUri": { "description": "Output only. The URI of the endpoint used to access the metastore service.", "readOnly": true, "type": "string" }, "endpointLocation": { "readOnly": true, "type": "string", "description": "Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}." } }, "type": "object", "id": "Consumer", "description": "Contains information of the customer's network configurations." }, "CustomRegionConfig": { "description": "Deprecated: Use a single region service instead. Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", "properties": { "readOnlyRegions": { "type": "array", "items": { "type": "string" }, "description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region." }, "readWriteRegions": { "items": { "type": "string" }, "type": "array", "description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region." } }, "deprecated": true, "id": "CustomRegionConfig", "type": "object" }, "LocationMetadata": { "type": "object", "properties": { "customRegionMetadata": { "type": "array", "items": { "$ref": "CustomRegionMetadata" }, "deprecated": true, "description": "Deprecated: Use a single region service instead. Possible configurations supported if the current region is a custom region." }, "supportedHiveMetastoreVersions": { "type": "array", "items": { "$ref": "HiveMetastoreVersion" }, "description": "The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default." }, "multiRegionMetadata": { "deprecated": true, "$ref": "MultiRegionMetadata", "description": "Deprecated: Use a single region service instead. The multi-region metadata if the current region is a multi-region." } }, "description": "Metadata about the service in a location.", "id": "LocationMetadata" }, "MaintenanceWindow": { "id": "MaintenanceWindow", "properties": { "hourOfDay": { "format": "int32", "type": "integer", "description": "Optional. The hour of day (0-23) when the window starts." }, "dayOfWeek": { "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "type": "string", "description": "Optional. The day of week, when the window starts." } }, "type": "object", "description": "Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service." }, "TableSummary": { "type": "object", "properties": { "partitionFailedCount": { "description": "Output only. The total number of partitions that failed to migrate at the target.", "format": "int64", "type": "string", "readOnly": true }, "resultCounts": { "description": "Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run.", "additionalProperties": { "type": "string", "format": "int64" }, "readOnly": true, "type": "object" }, "partitionSuccessCount": { "description": "Output only. The total number of partitions successfully migrated at the target.", "readOnly": true, "type": "string", "format": "int64" }, "planCounts": { "description": "Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.).", "additionalProperties": { "type": "string", "format": "int64" }, "readOnly": true, "type": "object" }, "partitionDiscoveredCount": { "description": "Output only. Partition migration summary across all Hive tables in the database.The total number of partitions discovered at the source.", "readOnly": true, "type": "string", "format": "int64" } }, "id": "TableSummary", "description": "Aggregated summary of results for all tables in a database." }, "ListServicesResponse": { "id": "ListServicesResponse", "properties": { "nextPageToken": { "description": "A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "services": { "type": "array", "items": { "$ref": "Service" }, "description": "The services in the specified location." }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "type": "object", "description": "Response message for DataprocMetastore.ListServices." }, "EncryptionConfig": { "description": "Encryption settings for the service.", "type": "object", "id": "EncryptionConfig", "properties": { "kmsKey": { "description": "Optional. The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.", "type": "string" }, "kmsKeys": { "description": "Optional. The list of fully qualified customer provided Cloud KMS key names for the multi-regional service. Each key must be in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.", "type": "array", "items": { "type": "string" } } } }, "TestIamPermissionsResponse": { "type": "object", "description": "Response message for TestIamPermissions method.", "id": "TestIamPermissionsResponse", "properties": { "permissions": { "description": "A subset of TestPermissionsRequest.permissions that the caller is allowed.", "items": { "type": "string" }, "type": "array" } } }, "MetadataExport": { "id": "MetadataExport", "type": "object", "description": "The details of a metadata export operation.", "properties": { "startTime": { "readOnly": true, "description": "Output only. The time when the export started.", "type": "string", "format": "google-datetime" }, "state": { "enum": [ "STATE_UNSPECIFIED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "enumDescriptions": [ "The state of the metadata export is unknown.", "The metadata export is running.", "The metadata export completed successfully.", "The metadata export failed.", "The metadata export is cancelled." ], "description": "Output only. The current state of the export.", "type": "string", "readOnly": true }, "destinationGcsUri": { "readOnly": true, "description": "Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of gs:////, where is automatically generated.", "type": "string" }, "databaseDumpType": { "description": "Output only. The type of the database dump.", "enumDescriptions": [ "The type of the database dump is unknown.", "Database dump is a MySQL dump file.", "Database dump contains Avro files." ], "type": "string", "readOnly": true, "enum": [ "TYPE_UNSPECIFIED", "MYSQL", "AVRO" ] }, "endTime": { "description": "Output only. The time when the export ended.", "type": "string", "readOnly": true, "format": "google-datetime" } } }, "Expr": { "id": "Expr", "properties": { "expression": { "type": "string", "description": "Textual representation of an expression in Common Expression Language syntax." }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "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" }, "title": { "type": "string", "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": "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." }, "LimitConfig": { "id": "LimitConfig", "type": "object", "properties": { "maxScalingFactor": { "type": "number", "format": "float", "description": "Optional. The highest scaling factor that the service should be autoscaled to." }, "minScalingFactor": { "format": "float", "description": "Optional. The lowest scaling factor that the service should be autoscaled to.", "type": "number" } }, "description": "Represents the autoscaling limit configuration of a metastore service." }, "AuditLogConfig": { "id": "AuditLogConfig", "type": "object", "properties": { "logType": { "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "description": "The log type that this config enables.", "type": "string", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ] }, "exemptedMembers": { "items": { "type": "string" }, "type": "array", "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members." } }, "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging." }, "ExportMetadataRequest": { "description": "Request message for DataprocMetastore.ExportMetadata.", "id": "ExportMetadataRequest", "type": "object", "properties": { "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string" }, "destinationGcsFolder": { "description": "A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing exported files will be created below it.", "type": "string" }, "databaseDumpType": { "enum": [ "TYPE_UNSPECIFIED", "MYSQL", "AVRO" ], "type": "string", "description": "Optional. The type of the database dump. If unspecified, defaults to MYSQL.", "enumDescriptions": [ "The type of the database dump is unknown.", "Database dump is a MySQL dump file.", "Database dump contains Avro files." ] } } }, "ErrorDetails": { "id": "ErrorDetails", "type": "object", "properties": { "details": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional structured details about this error.Keys define the failure items. Value describes the exception or details of the item." } }, "description": "Error details in public error message for DataprocMetastore.QueryMetadata." }, "KerberosConfig": { "id": "KerberosConfig", "description": "Configuration information for a Kerberos principal.", "properties": { "principal": { "description": "Optional. A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format.", "type": "string" }, "krb5ConfigGcsUri": { "description": "Optional. A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.", "type": "string" }, "keytab": { "description": "Optional. A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC).", "$ref": "Secret" } }, "type": "object" }, "BackendMetastore": { "description": "Represents a backend metastore for the federation.", "id": "BackendMetastore", "type": "object", "properties": { "metastoreType": { "enum": [ "METASTORE_TYPE_UNSPECIFIED", "DATAPLEX", "BIGQUERY", "DATAPROC_METASTORE" ], "type": "string", "description": "The type of the backend metastore.", "enumDescriptions": [ "The metastore type is not set.", "The backend metastore is Dataplex.", "The backend metastore is BigQuery.", "The backend metastore is Dataproc Metastore." ] }, "name": { "description": "The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: BigQuery projects/{project_id} Dataproc Metastore projects/{project_id}/locations/{location}/services/{service_id}", "type": "string" } } }, "DataplexConfig": { "id": "DataplexConfig", "properties": { "lakeResources": { "description": "Optional. A reference to the Lake resources that this metastore service is attached to. The key is the lake resource name. Example: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.", "additionalProperties": { "$ref": "Lake" }, "type": "object" } }, "type": "object", "description": "Specifies how metastore metadata should be integrated with the Dataplex service." }, "Binding": { "properties": { "role": { "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).", "type": "string" }, "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.", "items": { "type": "string" }, "type": "array" } }, "id": "Binding", "description": "Associates members, or principals, with a role.", "type": "object" }, "QueryMetadataRequest": { "id": "QueryMetadataRequest", "type": "object", "properties": { "query": { "description": "Required. A read-only SQL query to execute against the metadata database. The query cannot change or mutate the data.", "type": "string" } }, "description": "Request message for DataprocMetastore.QueryMetadata." }, "Federation": { "type": "object", "properties": { "endpointUri": { "readOnly": true, "type": "string", "description": "Output only. The federation endpoint." }, "backendMetastores": { "type": "object", "description": "A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.", "additionalProperties": { "$ref": "BackendMetastore" } }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time when the metastore federation was last updated." }, "state": { "type": "string", "readOnly": true, "description": "Output only. The current state of the federation.", "enumDescriptions": [ "The state of the metastore federation is unknown.", "The metastore federation is in the process of being created.", "The metastore federation is running and ready to serve queries.", "The metastore federation is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore federation is undergoing deletion. It cannot be used.", "The metastore federation has encountered an error and cannot be used. The metastore federation should be deleted." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING", "ERROR" ] }, "name": { "description": "Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.", "type": "string" }, "stateMessage": { "type": "string", "readOnly": true, "description": "Output only. Additional information about the current state of the metastore federation, if available." }, "version": { "type": "string", "description": "Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "User-defined labels for the metastore federation." }, "uid": { "readOnly": true, "type": "string", "description": "Output only. The globally unique resource identifier of the metastore federation." }, "tags": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"" }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time when the metastore federation was created." } }, "id": "Federation", "description": "Represents a federation of multiple backend metastores." }, "TelemetryConfig": { "type": "object", "id": "TelemetryConfig", "properties": { "logFormat": { "type": "string", "enumDescriptions": [ "The LOG_FORMAT is not set.", "Logging output uses the legacy textPayload format.", "Logging output uses the jsonPayload format." ], "enum": [ "LOG_FORMAT_UNSPECIFIED", "LEGACY", "JSON" ], "description": "Optional. The output format of the Dataproc Metastore service's logs." } }, "description": "Telemetry Configuration for the Dataproc Metastore service." }, "HiveConfig": { "id": "HiveConfig", "type": "object", "description": "Configuration for migrating Hive metadata.", "properties": { "catalog": { "description": "Required. The target catalog for migrated databases and tables. Format: \"projects/{project_id_or_number}/catalogs/{catalog_id}\"", "type": "string" }, "databases": { "description": "Required. The list of databases to migrate to the Hive catalog. Use \"*\" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if iceberg_config is also specified.", "items": { "type": "string" }, "type": "array" } } }, "ScheduledBackup": { "properties": { "latestBackup": { "readOnly": true, "$ref": "LatestBackup", "description": "Output only. The details of the latest scheduled backup." }, "cronSchedule": { "type": "string", "description": "Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups." }, "timeZone": { "type": "string", "description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC." }, "backupLocation": { "description": "Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.", "type": "string" }, "enabled": { "description": "Optional. Defines whether the scheduled backup is enabled. The default value is false.", "type": "boolean" }, "nextScheduledTime": { "description": "Output only. The time when the next backups execution is scheduled to start.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "description": "This specifies the configuration of scheduled backup.", "type": "object", "id": "ScheduledBackup" }, "AutoscalingConfig": { "description": "Represents the autoscaling configuration of a metastore service.", "id": "AutoscalingConfig", "type": "object", "properties": { "autoscalingFactor": { "description": "Output only. The scaling factor of a service with autoscaling enabled.", "readOnly": true, "format": "float", "type": "number" }, "limitConfig": { "description": "Optional. The LimitConfig of the service.", "$ref": "LimitConfig" }, "autoscalingEnabled": { "type": "boolean", "description": "Optional. Whether or not autoscaling is enabled for this service." } } }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", "type": "object", "properties": { "locationId": { "description": "The canonical id for this location. For example: \"us-east1\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"} ", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } } }, "StartMigrationRequest": { "description": "Request message for DataprocMetastore.StartMigration.", "properties": { "migrationExecutionId": { "type": "string", "description": "Optional. The ID to use for the migration execution, which will become the final component of the migration execution's resource name. If not specified, a UUID will be generated.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and valid characters are a-z0-9-." }, "requestId": { "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", "type": "string" }, "migrationExecution": { "description": "Required. The configuration details for the migration.", "$ref": "MigrationExecution" } }, "type": "object", "id": "StartMigrationRequest" }, "MoveTableToDatabaseResponse": { "properties": {}, "description": "Response message for DataprocMetastore.MoveTableToDatabase.", "type": "object", "id": "MoveTableToDatabaseResponse" }, "RemoveIamPolicyRequest": { "properties": { "asynchronous": { "description": "Optional. Removes IAM policy attached to database or table asynchronously when it is set. The default is false.", "type": "boolean" } }, "description": "Request message for DataprocMetastore.RemoveIamPolicy.", "type": "object", "id": "RemoveIamPolicyRequest" }, "HiveMetastoreVersion": { "type": "object", "id": "HiveMetastoreVersion", "properties": { "isDefault": { "type": "boolean", "description": "Whether version will be chosen by the server if a metastore service is created with a HiveMetastoreConfig that omits the version." }, "version": { "description": "The semantic version of the Hive Metastore software.", "type": "string" } }, "description": "A specification of a supported version of the Hive Metastore software." }, "MigrationExecution": { "type": "object", "description": "The details of a migration execution resource.", "properties": { "biglakeMetastoreMigrationConfig": { "$ref": "BigLakeMetastoreMigrationConfig", "description": "Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore." }, "endTime": { "format": "google-datetime", "description": "Output only. The time when the migration execution finished.", "readOnly": true, "type": "string" }, "name": { "readOnly": true, "type": "string", "description": "Output only. The relative resource name of the migration execution, in the following form: projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}" }, "stateMessage": { "readOnly": true, "description": "Output only. Additional information about the current state of the migration execution.", "type": "string" }, "createTime": { "type": "string", "description": "Output only. The time when the migration execution was started.", "readOnly": true, "format": "google-datetime" }, "state": { "description": "Output only. The current state of the migration execution.", "type": "string", "enumDescriptions": [ "The state of the migration execution is unknown.", "The migration execution is starting.", "The migration execution is running.", "The migration execution is in the process of being cancelled.", "The migration execution is awaiting user action.", "The migration execution has completed successfully.", "The migration execution has failed.", "The migration execution is cancelled.", "The migration execution is being deleted.", "The migration execution has been rolled back. This occurs when CancelMigration is invoked after the migration has completed and the metastore service is in the PROXY state, returning the service to the ACTIVE state. This enables rollback support when the customer wants to resume using DPMS after a successful migration." ], "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "STARTING", "RUNNING", "CANCELLING", "AWAITING_USER_ACTION", "SUCCEEDED", "FAILED", "CANCELLED", "DELETING", "ROLLED_BACK" ] }, "phase": { "readOnly": true, "enum": [ "PHASE_UNSPECIFIED", "REPLICATION", "CUTOVER" ], "type": "string", "description": "Output only. Deprecated: Phase was designed for incoming migrations to Dataproc Metastore, not applicable when migrating away from it. The current phase of the migration execution.", "enumDescriptions": [ "The phase of the migration execution is unknown.", "Replication phase refers to the migration phase when Dataproc Metastore is running a pipeline to replicate changes in the customer database to its backend database. During this phase, Dataproc Metastore uses the customer database as the hive metastore backend database.", "Cutover phase refers to the migration phase when Dataproc Metastore switches to using its own backend database. Migration enters this phase when customer is done migrating all their clusters/workloads to Dataproc Metastore and triggers CompleteMigration." ], "deprecated": true } }, "id": "MigrationExecution" }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.", "id": "AuditConfig", "type": "object", "properties": { "service": { "type": "string", "description": "Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services." }, "auditLogConfigs": { "items": { "$ref": "AuditLogConfig" }, "description": "The configuration for logging of each type of permission.", "type": "array" } } }, "BigLakeMetastoreMigrationConfig": { "id": "BigLakeMetastoreMigrationConfig", "properties": { "conflictPolicy": { "type": "string", "enum": [ "CONFLICT_POLICY_UNSPECIFIED", "SKIP", "OVERWRITE" ], "enumDescriptions": [ "The conflict policy is unspecified.", "Skip migrating resources that already exist in the target catalog.", "Update resources that already exist in the target catalog." ], "description": "Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified." }, "reportPath": { "description": "Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: \"gs://path/to/folder\"", "type": "string" }, "hiveConfig": { "description": "Optional. At least one of hive_config or iceberg_config must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated.Configuration for migrating Hive tables to a BigLake Hive catalog.", "$ref": "HiveConfig" }, "dryRun": { "type": "boolean", "description": "Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated." }, "mode": { "type": "string", "enum": [ "MIGRATION_MODE_UNSPECIFIED", "BACKFILL", "INCREMENTAL_SYNC" ], "enumDescriptions": [ "The migration mode is unspecified.", "Performs the metadata migration of requested resources. The migration completes once the backfill is finished.", "Performs the initial backfill, then transitions to an incremental synchronization state to replicate ongoing source writes. Requires an explicit CompleteMigration or CancelMigration call to end the migration. Note: Supported only for Iceberg migrations." ], "description": "Required. Defines the behavior of the migration execution." }, "icebergConfig": { "$ref": "IcebergConfig", "description": "Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog." }, "backfillStatus": { "$ref": "BackfillStatus", "readOnly": true, "description": "Output only. " } }, "description": "Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore.", "type": "object" }, "HiveMetastoreConfig": { "type": "object", "description": "Specifies configuration information specific to running Hive metastore software as the metastore service.", "id": "HiveMetastoreConfig", "properties": { "endpointProtocol": { "description": "Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.", "enumDescriptions": [ "The protocol is not set.", "Use the legacy Apache Thrift protocol for the metastore service endpoint.", "Use the modernized gRPC protocol for the metastore service endpoint." ], "type": "string", "enum": [ "ENDPOINT_PROTOCOL_UNSPECIFIED", "THRIFT", "GRPC" ] }, "kerberosConfig": { "description": "Optional. Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the UpdateService method and specify this field's path (hive_metastore_config.kerberos_config) in the request's update_mask while omitting this field from the request's service.", "$ref": "KerberosConfig" }, "auxiliaryVersions": { "type": "object", "additionalProperties": { "$ref": "AuxiliaryVersionConfig" }, "description": "Optional. A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen." }, "configOverrides": { "additionalProperties": { "type": "string" }, "description": "Optional. A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig.", "type": "object" }, "version": { "type": "string", "description": "Immutable. The Hive metastore schema version." } } }, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "properties": { "autoscalingConfig": { "description": "Optional. The autoscaling configuration.", "$ref": "AutoscalingConfig" }, "scalingFactor": { "type": "number", "description": "Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.", "format": "float" }, "instanceSize": { "type": "string", "enum": [ "INSTANCE_SIZE_UNSPECIFIED", "EXTRA_SMALL", "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE" ], "enumDescriptions": [ "Unspecified instance size", "Extra small instance size, maps to a scaling factor of 0.1.", "Small instance size, maps to a scaling factor of 0.5.", "Medium instance size, maps to a scaling factor of 1.0.", "Large instance size, maps to a scaling factor of 3.0.", "Extra large instance size, maps to a scaling factor of 6.0." ], "description": "An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))" } }, "id": "ScalingConfig", "type": "object" }, "ListLocationsResponse": { "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object" }, "ListOperationsResponse": { "properties": { "unreachable": { "type": "array", "items": { "type": "string" }, "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." }, "operations": { "type": "array", "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "IcebergConfig": { "description": "Configuration for migrating Iceberg metadata.", "properties": { "namespaces": { "items": { "type": "string" }, "type": "array", "description": "Required. The list of namespaces to migrate to the Iceberg REST catalog. Use \"*\" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if hive_config is also specified." }, "catalog": { "description": "Required. The target catalog for migrated Iceberg metadata. Format: \"projects/{project_id_or_number}/catalogs/{catalog_id}\"", "type": "string" } }, "type": "object", "id": "IcebergConfig" }, "SetIamPolicyRequest": { "description": "Request message for SetIamPolicy method.", "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" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: \"bindings, etag\"" } }, "type": "object", "id": "SetIamPolicyRequest" }, "AlterMetadataResourceLocationRequest": { "description": "Request message for DataprocMetastore.AlterMetadataResourceLocation.", "type": "object", "properties": { "locationUri": { "description": "Required. The new location URI for the metadata resource.", "type": "string" }, "resourceName": { "type": "string", "description": "Required. The relative metadata resource name in the following format.databases/{database_id} or databases/{database_id}/tables/{table_id} or databases/{database_id}/tables/{table_id}/partitions/{partition_id}" } }, "id": "AlterMetadataResourceLocationRequest" }, "CompleteMigrationRequest": { "description": "Request message for DataprocMetastore.CompleteMigration.", "id": "CompleteMigrationRequest", "properties": {}, "type": "object" }, "NetworkConfig": { "type": "object", "properties": { "consumers": { "description": "Immutable. The consumer-side network configuration for the Dataproc Metastore instance.", "type": "array", "items": { "$ref": "Consumer" } }, "customRoutesEnabled": { "description": "Optional. Enables custom routes to be imported and exported for the Dataproc Metastore service's peered VPC network.", "type": "boolean" } }, "description": "Network configuration for the Dataproc Metastore service.", "id": "NetworkConfig" }, "CancelMigrationResponse": { "properties": { "migrationExecution": { "description": "The relative resource name of the migration execution, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.", "type": "string" } }, "type": "object", "id": "CancelMigrationResponse", "description": "Response message for DataprocMetastore.CancelMigration." }, "TestIamPermissionsRequest": { "id": "TestIamPermissionsRequest", "type": "object", "description": "Request message for TestIamPermissions method.", "properties": { "permissions": { "type": "array", "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).", "items": { "type": "string" } } } }, "Operation": { "properties": { "name": { "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}.", "type": "string" }, "done": { "type": "boolean", "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." }, "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": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation" }, "BackfillStatus": { "type": "object", "id": "BackfillStatus", "properties": { "migrationSummary": { "readOnly": true, "description": "Output only. Summary of the migration results. This is populated after the backfill or dry run is finished.", "$ref": "MigrationSummary" }, "state": { "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" ], "readOnly": true, "type": "string", "description": "Output only. The current state of the backfill (or dry run).", "enumDescriptions": [ "The backfill state is unspecified.", "Waiting to start.", "Backfill in progress.", "Backfill complete, report is available", "Backfill failed; check report for details" ] }, "reportPath": { "description": "Output only. The Cloud Storage path where the backfill or dry run report is written. Format: \"gs://path-to-report\".", "type": "string", "readOnly": true } }, "description": "Backfill status for the migration execution." }, "ListFederationsResponse": { "type": "object", "description": "Response message for ListFederations", "id": "ListFederationsResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." }, "federations": { "items": { "$ref": "Federation" }, "type": "array", "description": "The services in the specified location." } } }, "ListMigrationExecutionsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "migrationExecutions": { "type": "array", "description": "The migration executions on the specified service.", "items": { "$ref": "MigrationExecution" } }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "type": "object", "description": "Response message for DataprocMetastore.ListMigrationExecutions.", "id": "ListMigrationExecutionsResponse" }, "DatabaseDump": { "description": "A specification of the location of and metadata about a database dump from a relational database management system.", "properties": { "databaseType": { "type": "string", "deprecated": true, "enumDescriptions": [ "The type of the source database is unknown.", "The type of the source database is MySQL." ], "enum": [ "DATABASE_TYPE_UNSPECIFIED", "MYSQL" ], "description": "The type of the database." }, "type": { "enumDescriptions": [ "The type of the database dump is unknown.", "Database dump is a MySQL dump file.", "Database dump contains Avro files." ], "description": "Optional. The type of the database dump. If unspecified, defaults to MYSQL.", "enum": [ "TYPE_UNSPECIFIED", "MYSQL", "AVRO" ], "type": "string" }, "gcsUri": { "description": "Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://.", "type": "string" }, "sourceDatabase": { "deprecated": true, "type": "string", "description": "Optional. The name of the source database." } }, "type": "object", "id": "DatabaseDump" }, "LakehouseProxyConfig": { "properties": { "catalog": { "type": "string", "readOnly": true, "description": "Output only. The Lakehouse Iceberg REST Catalog where requests are being proxied to. Format: projects/{project_id_or_number}/catalogs/{catalog_id}." }, "namespaces": { "items": { "type": "string" }, "description": "Output only. The list of namespaces currently proxied to the Lakehouse catalog. As each migration batch completes, newly migrated namespaces are added to this list.", "readOnly": true, "type": "array" } }, "id": "LakehouseProxyConfig", "type": "object", "description": "Configuration for Dataproc Metastore to Lakehouse proxy routing.In a phased migration, namespaces are migrated from Dataproc Metastore to a Lakehouse Iceberg REST Catalog in batches. Between and after migration phases, the metastore service operates in PROXY state where requests for migrated namespaces are forwarded to the Lakehouse catalog while unmigrated namespaces continue to be served locally by DPMS." }, "Secret": { "properties": { "cloudSecret": { "type": "string", "description": "Optional. The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}." } }, "type": "object", "description": "A securely stored value.", "id": "Secret" }, "MetadataImport": { "id": "MetadataImport", "description": "A metastore resource that imports metadata.", "type": "object", "properties": { "createTime": { "description": "Output only. The time when the metadata import was started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "description": { "description": "Optional. The description of the metadata import.", "type": "string" }, "endTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The time when the metadata import finished." }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time when the metadata import was last updated." }, "name": { "description": "Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.", "type": "string" }, "databaseDump": { "$ref": "DatabaseDump", "description": "Immutable. A database dump from a pre-existing metastore's database." }, "state": { "enumDescriptions": [ "The state of the metadata import is unknown.", "The metadata import is running.", "The metadata import completed successfully.", "The metadata import is being updated.", "The metadata import failed, and attempted metadata changes were rolled back." ], "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "RUNNING", "SUCCEEDED", "UPDATING", "FAILED" ], "description": "Output only. The current state of the metadata import." } } }, "CatalogReport": { "type": "object", "properties": { "catalog": { "type": "string", "description": "The name of the catalog (format: projects/*/catalogs/*)." }, "catalogType": { "enum": [ "CATALOG_TYPE_UNSPECIFIED", "HIVE", "ICEBERG" ], "type": "string", "enumDescriptions": [ "The catalog type is unspecified.", "BigLake Metastore Hive catalog.", "BigLake Metastore Iceberg REST catalog." ], "description": "The type of catalog." }, "databaseReports": { "description": "A map of database names to their respective reports.", "type": "object", "additionalProperties": { "$ref": "DatabaseReport" } } }, "id": "CatalogReport", "description": "Aggregated report at the catalog level." }, "Restore": { "id": "Restore", "description": "The details of a metadata restore operation.", "type": "object", "properties": { "details": { "description": "Output only. The restore details containing the revision of the service to be restored to, in format of JSON.", "readOnly": true, "type": "string" }, "backup": { "description": "Output only. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.", "type": "string", "readOnly": true }, "startTime": { "readOnly": true, "description": "Output only. The time when the restore started.", "format": "google-datetime", "type": "string" }, "type": { "enum": [ "RESTORE_TYPE_UNSPECIFIED", "FULL", "METADATA_ONLY" ], "enumDescriptions": [ "The restore type is unknown.", "The service's metadata and configuration are restored.", "Only the service's metadata is restored." ], "description": "Output only. The type of restore.", "readOnly": true, "type": "string" }, "backupLocation": { "type": "string", "description": "Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///." }, "state": { "enum": [ "STATE_UNSPECIFIED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "readOnly": true, "description": "Output only. The current state of the restore.", "enumDescriptions": [ "The state of the metadata restore is unknown.", "The metadata restore is running.", "The metadata restore completed successfully.", "The metadata restore failed.", "The metadata restore is cancelled." ], "type": "string" }, "endTime": { "format": "google-datetime", "description": "Output only. The time when the restore ended.", "readOnly": true, "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": {} }, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", "properties": { "enabled": { "description": "Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.", "type": "boolean" } }, "type": "object" }, "MessageSet": { "description": "This is proto2's version of MessageSet.DEPRECATED: DO NOT USE FOR NEW FIELDS.If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use Any instead.MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2.This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", "properties": {}, "type": "object", "deprecated": true, "id": "MessageSet" }, "AlterMetadataResourceLocationResponse": { "description": "Response message for DataprocMetastore.AlterMetadataResourceLocation.", "type": "object", "id": "AlterMetadataResourceLocationResponse", "properties": {} }, "DatabaseSummary": { "description": "Summary of results for a specific database in a catalog.", "id": "DatabaseSummary", "type": "object", "properties": { "resultStatus": { "description": "Output only. The migration result status for the database. This is only set if the migration is not a dry run.", "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED", "SKIPPED" ], "readOnly": true, "type": "string", "enumDescriptions": [ "The state is unspecified.", "The resource was migrated successfully.", "The resource failed to migrate.", "The resource was skipped and will not be migrated." ] }, "database": { "description": "Output only. The name of the database.", "readOnly": true, "type": "string" }, "planAction": { "enum": [ "ACTION_UNSPECIFIED", "CREATE", "UPDATE", "SKIP", "DEPENDENCY_FAILURE", "ERROR" ], "description": "Output only. The migration plan action for the database.", "enumDescriptions": [ "The action is unspecified.", "Resource missing; will be created.", "Resource exists at the target, but differs from the source; will be updated.", "Resource exists at the target; no changes will be made.", "Resource cannot be migrated due to a dependency failure (e.g., parent resource missing).", "Resource cannot be migrated due to an error during discovery." ], "readOnly": true, "type": "string" }, "tableSummary": { "readOnly": true, "description": "Output only. Aggregated summary of results for all tables in the database.", "$ref": "TableSummary" } } }, "PartitionReport": { "description": "Partition migration report for a Hive table.", "id": "PartitionReport", "properties": { "partitionSuccessCount": { "description": "The number of partitions successfully migrated at the target.", "format": "int64", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "PARTIALLY_SUCCEEDED", "FAILED" ], "enumDescriptions": [ "The state is unspecified.", "All partitions migrated successfully at the target.", "Some partitions migrated successfully at the target, but others failed.", "All partitions failed to migrate at the target." ], "type": "string", "readOnly": true, "description": "Output only. The state of the partition migration." }, "partitionFailedCount": { "format": "int64", "description": "The number of partitions that failed to migrate at the target.", "type": "string" } }, "type": "object" }, "OperationMetadata": { "type": "object", "properties": { "requestedCancellation": { "readOnly": true, "description": "Output only. Identifies whether the caller has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.", "type": "boolean" }, "verb": { "type": "string", "readOnly": true, "description": "Output only. Name of the verb executed by the operation." }, "createTime": { "readOnly": true, "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime" }, "endTime": { "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string", "format": "google-datetime" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true }, "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." }, "target": { "type": "string", "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation." } }, "id": "OperationMetadata", "description": "Represents the metadata of a long-running operation." }, "MigrationSummary": { "properties": { "dryRun": { "readOnly": true, "type": "boolean", "description": "Output only. Whether the migration was a dry run." }, "service": { "description": "Output only. The Dataproc Metastore service name (format: projects/*/locations/*/services/*) on which the migration was executed.", "readOnly": true, "type": "string" }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The UTC time when the report was written.", "format": "google-datetime" }, "catalogSummaries": { "readOnly": true, "items": { "$ref": "CatalogSummary" }, "description": "Output only. Summary of results for each catalog involved in the migration.", "type": "array" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The UTC time when the source metadata read was initiated.", "format": "google-datetime" } }, "type": "object", "id": "MigrationSummary", "description": "Summary of the migration results." }, "MigrationReport": { "properties": { "catalogReports": { "readOnly": true, "type": "array", "items": { "$ref": "CatalogReport" }, "description": "Output only. Detailed results for each catalog involved in the migration." }, "summary": { "readOnly": true, "description": "Output only. High-level summary of the migration results.", "$ref": "MigrationSummary" } }, "id": "MigrationReport", "type": "object", "description": "Report containing the results of a migration run. This report is generated at the specified path in the BigLakeMetastoreMigrationConfig after the backfill is complete, or when a dry run is executed." }, "ListBackupsResponse": { "type": "object", "properties": { "backups": { "description": "The backups of the specified service.", "type": "array", "items": { "$ref": "Backup" } }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for DataprocMetastore.ListBackups.", "id": "ListBackupsResponse" }, "CatalogSummary": { "properties": { "databaseSummaries": { "readOnly": true, "description": "Output only. Summary of results for each database in the catalog.", "type": "array", "items": { "$ref": "DatabaseSummary" } }, "catalog": { "readOnly": true, "description": "Output only. The catalog resource name (format: projects/*/catalogs/*).", "type": "string" }, "catalogType": { "description": "Output only. The type of the catalog.", "enumDescriptions": [ "The catalog type is unspecified.", "BigLake Metastore Hive catalog.", "BigLake Metastore Iceberg REST catalog." ], "enum": [ "CATALOG_TYPE_UNSPECIFIED", "HIVE", "ICEBERG" ], "readOnly": true, "type": "string" } }, "type": "object", "description": "Summary of results for a specific destination catalog.", "id": "CatalogSummary" }, "MultiRegionConfig": { "description": "Deprecated: Use a single region service instead. The multi-region config for the Dataproc Metastore service.", "deprecated": true, "properties": { "customRegionConfig": { "$ref": "CustomRegionConfig", "description": "Immutable. Deprecated: Use a single region service instead.", "deprecated": true }, "certificates": { "type": "array", "deprecated": true, "description": "Output only. Deprecated: Use a single region service instead. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", "items": { "$ref": "RootCACertificate" }, "readOnly": true } }, "id": "MultiRegionConfig", "type": "object" }, "MultiRegionMetadata": { "deprecated": true, "description": "Deprecated: Use a single region service instead. The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.", "id": "MultiRegionMetadata", "type": "object", "properties": { "continent": { "type": "string", "description": "The continent for this multi-region." }, "constituentRegions": { "items": { "type": "string" }, "description": "The regions constituting the multi-region.", "type": "array" }, "witnessRegion": { "description": "The Spanner witness region for this multi-region.", "type": "string" } } }, "MoveTableToDatabaseRequest": { "properties": { "destinationDbName": { "description": "Required. The name of the database where the table should be moved.", "type": "string" }, "tableName": { "description": "Required. The name of the table to be moved.", "type": "string" }, "dbName": { "description": "Required. The name of the database where the table resides.", "type": "string" } }, "id": "MoveTableToDatabaseRequest", "description": "Request message for DataprocMetastore.MoveTableToDatabase.", "type": "object" }, "ExecutionResult": { "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "SUCCEEDED", "FAILED", "SKIPPED" ], "readOnly": true, "description": "Output only. The state of the migration for a resource.", "type": "string", "enumDescriptions": [ "The state is unspecified.", "The resource was migrated successfully.", "The resource failed to migrate.", "The resource was skipped and will not be migrated." ] }, "errorMessage": { "type": "string", "description": "Description of the error if the state is FAILED." }, "remediation": { "description": "Remediation steps for the error if the state is FAILED.", "type": "string" } }, "type": "object", "id": "ExecutionResult", "description": "Represents the actual migration result for a specific resource (e.g. Database, Table)." }, "Backup": { "description": "The details of a backup resource.", "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time when the backup was started." }, "endTime": { "description": "Output only. The time when the backup finished creating.", "type": "string", "readOnly": true, "format": "google-datetime" }, "description": { "type": "string", "description": "Optional. The description of the backup." }, "restoringServices": { "type": "array", "items": { "type": "string" }, "description": "Output only. Services that are restoring from the backup.", "readOnly": true }, "name": { "type": "string", "description": "Immutable. Identifier. The relative resource name of the backup, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}" }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "DELETING", "ACTIVE", "FAILED", "RESTORING" ], "readOnly": true, "description": "Output only. The current state of the backup.", "type": "string", "enumDescriptions": [ "The state of the backup is unknown.", "The backup is being created.", "The backup is being deleted.", "The backup is active and ready to use.", "The backup failed.", "The backup is being restored." ] }, "serviceRevision": { "$ref": "Service", "description": "Output only. The revision of the service at the time of backup.", "readOnly": true } }, "id": "Backup" }, "ListMetadataImportsResponse": { "type": "object", "id": "ListMetadataImportsResponse", "description": "Response message for DataprocMetastore.ListMetadataImports.", "properties": { "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." }, "metadataImports": { "items": { "$ref": "MetadataImport" }, "description": "The imports in the specified service.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." } } }, "RestoreServiceRequest": { "properties": { "backup": { "description": "Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. Mutually exclusive with backup_location, and exactly one of the two must be set.", "type": "string" }, "requestId": { "type": "string", "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported." }, "backupLocation": { "description": "Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under \"avro/\", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set.", "type": "string" }, "restoreType": { "description": "Optional. The type of restore. If unspecified, defaults to METADATA_ONLY.", "type": "string", "enumDescriptions": [ "The restore type is unknown.", "The service's metadata and configuration are restored.", "Only the service's metadata is restored." ], "enum": [ "RESTORE_TYPE_UNSPECIFIED", "FULL", "METADATA_ONLY" ] } }, "type": "object", "id": "RestoreServiceRequest", "description": "Request message for DataprocMetastore.RestoreService." } } }