Dataproc Metastore API (metastore:v1)

2022-11-17

34 new methods | New API

Additions

    Methods
  • metastore.projects.locations.operations.list

      HTTP Method : GET

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

      Parameters :

        filter

          Location : query

          Type : string

          Description : The standard list filter.

        pageToken

          Type : string

          Description : The standard list page token.

          Location : query

        pageSize

          Format : int32

          Location : query

          Description : The standard list page size.

          Type : integer

        name

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Description : The name of the operation's parent resource.

          Required : Yes

          Location : path

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      Path : v1/{+name}/operations

  • metastore.projects.locations.operations.delete

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Location : path

          Description : The name of the operation resource to be deleted.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Required : Yes

          Type : string

      Path : v1/{+name}

      Parameter Order : name

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : DELETE

      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.

  • metastore.projects.locations.operations.get

      Parameter Order : name

      HTTP Method : GET

      Path : v1/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      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.

      Parameters :

        name

          Required : Yes

          Description : The name of the operation resource.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Type : string

          Location : path

  • metastore.projects.locations.federations.create

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a metastore federation in a project and location.

      Path : v1/{+parent}/federations

      HTTP Method : POST

      Parameter Order : parent

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/federations

      Parameters :

        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.

        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

        parent

          Required : Yes

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+$

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

  • metastore.projects.locations.federations.delete

      Path : v1/{+name}

      Parameter Order : name

      HTTP Method : DELETE

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a single federation.

      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.

          Location : query

          Type : string

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Location : path

          Type : string

          Required : Yes

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

  • metastore.projects.locations.federations.testIamPermissions

      Parameter Order : resource

      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.

          Type : string

          Location : path

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/cloud-platform

      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.

  • metastore.projects.locations.federations.setIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}: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.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+resource}:setIamPolicy

      Parameters :

        resource

          Type : string

          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/[^/]+/federations/[^/]+$

          Required : Yes

          Location : path

      HTTP Method : POST

      Parameter Order : resource

  • metastore.projects.locations.federations.get

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

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

          Pattern : ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Location : path

          Type : string

      Description : Gets the details of a single federation.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+name}

      Parameter Order : name

  • metastore.projects.locations.federations.list

      Path : v1/{+parent}/federations

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/federations

      Parameter Order : parent

      Parameters :

        filter

          Location : query

          Description : Optional. The filter to apply to list results.

          Type : string

        pageToken

          Location : query

          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.

          Type : string

        pageSize

          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.

          Format : int32

        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.

          Location : query

          Type : string

        parent

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Required : Yes

          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

          Type : string

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : GET

      Description : Lists federations in a project and location.

  • metastore.projects.locations.federations.patch

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Updates the fields of a federation.

      HTTP Method : PATCH

      Parameters :

        name

          Description : Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Type : string

          Required : Yes

          Location : path

        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

          Format : google-fieldmask

          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.

          Location : query

          Type : string

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

      Parameter Order : name

  • metastore.projects.locations.federations.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      Parameters :

        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

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          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 : Yes

      Parameter Order : 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.

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:getIamPolicy

  • metastore.projects.locations.services.testIamPermissions

      Parameter Order : resource

      Parameters :

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Type : string

          Location : path

          Required : Yes

          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.

      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.

      HTTP Method : POST

      Path : v1/{+resource}:testIamPermissions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:testIamPermissions

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.services.create

      Path : v1/{+parent}/services

      HTTP Method : POST

      Parameters :

        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.

        serviceId

          Type : string

          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

        parent

          Type : string

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

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+$

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services

      Description : Creates a metastore service in a project and location.

  • metastore.projects.locations.services.patch

      Parameters :

        updateMask

          Location : query

          Format : google-fieldmask

          Type : string

          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.

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Type : string

          Required : Yes

          Description : Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.

          Location : path

        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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      Description : Updates the parameters of a single service.

      Path : v1/{+name}

      HTTP Method : PATCH

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

  • metastore.projects.locations.services.list

      Parameters :

        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

        orderBy

          Type : string

          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.

        pageSize

          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.

          Format : int32

          Type : integer

          Location : query

        parent

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Description : Required. The relative resource name of the location of metastore services to list, in the following form:projects/{project_number}/locations/{location_id}.

          Type : string

          Required : Yes

        filter

          Location : query

          Type : string

          Description : Optional. The filter to apply to list results.

      Description : Lists services in a project and location.

      Path : v1/{+parent}/services

      Parameter Order : parent

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.services.delete

      Description : Deletes a single service.

      Parameters :

        requestId

          Type : string

          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.

        name

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

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Required : Yes

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : DELETE

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      Path : v1/{+name}

  • metastore.projects.locations.services.setIamPolicy

      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.

      Parameter Order : resource

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      HTTP Method : POST

      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 : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Type : string

  • metastore.projects.locations.services.exportMetadata

      Parameters :

        service

          Required : Yes

          Location : path

          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/[^/]+$

          Type : string

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:exportMetadata

      Path : v1/{+service}:exportMetadata

      Parameter Order : service

      Description : Exports metadata from a service.

  • metastore.projects.locations.services.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location : path

          Type : string

        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

      Parameter Order : 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

  • metastore.projects.locations.services.get

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      Description : Gets the details of a single service.

      Path : v1/{+name}

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      Parameters :

        name

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

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Type : string

          Required : Yes

          Location : path

  • metastore.projects.locations.services.restore

      Parameters :

        service

          Required : Yes

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

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Type : string

          Location : path

      HTTP Method : POST

      Description : Restores a service from a backup.

      Parameter Order : service

      Path : v1/{+service}:restore

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:restore

  • metastore.projects.locations.services.backups.list

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups

      Description : Lists backups in a service.

      Parameters :

        filter

          Description : Optional. The filter to apply to list results.

          Location : query

          Type : string

        parent

          Location : path

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Required : Yes

          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.

        pageSize

          Format : int32

          Type : integer

          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.

          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

        pageToken

          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.

          Type : string

          Location : query

      Parameter Order : parent

      Path : v1/{+parent}/backups

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.services.backups.getIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}: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 :

        options.requestedPolicyVersion

          Type : integer

          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

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$

          Description : REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Required : Yes

          Type : string

          Location : path

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+resource}:getIamPolicy

      Parameter Order : resource

  • metastore.projects.locations.services.backups.create

      HTTP Method : POST

      Parameter Order : parent

      Path : v1/{+parent}/backups

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        parent

          Required : Yes

          Location : path

          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

        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

        requestId

          Type : string

          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.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups

      Description : Creates a new backup in a given project and location.

  • metastore.projects.locations.services.backups.get

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}

      Description : Gets details of a single backup.

      Parameter Order : name

      HTTP Method : GET

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$

          Location : path

          Type : string

          Required : Yes

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

      Path : v1/{+name}

  • metastore.projects.locations.services.backups.delete

      Description : Deletes a single backup.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : DELETE

      Path : v1/{+name}

      Parameter Order : name

      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.

          Location : query

          Type : string

        name

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

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}

  • metastore.projects.locations.services.backups.setIamPolicy

      HTTP Method : POST

      Parameters :

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$

          Type : string

          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 : Yes

      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.

      Path : v1/{+resource}:setIamPolicy

      Parameter Order : resource

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}:setIamPolicy

  • metastore.projects.locations.services.metadataImports.create

      HTTP Method : POST

      Parameters :

        metadataImportId

          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.

          Type : string

          Location : query

        parent

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

          Type : string

          Location : path

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

        requestId

          Type : string

          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.

      Path : v1/{+parent}/metadataImports

      Description : Creates a new MetadataImport in a given project and location.

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports

  • metastore.projects.locations.services.metadataImports.get

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports/{metadataImportsId}

      HTTP Method : GET

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets details of a single import.

      Path : v1/{+name}

      Parameters :

        name

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

          Type : string

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/metadataImports/[^/]+$

  • metastore.projects.locations.services.metadataImports.list

      Path : v1/{+parent}/metadataImports

      Parameters :

        pageSize

          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.

          Location : query

          Type : integer

          Format : int32

        filter

          Description : Optional. The filter to apply to list results.

          Type : string

          Location : query

        orderBy

          Type : string

          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.

        parent

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          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.

          Type : string

        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

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : GET

      Parameter Order : parent

      Description : Lists imports in a service.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports

  • metastore.projects.locations.services.metadataImports.patch

      Parameter Order : name

      Parameters :

        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

        updateMask

          Format : google-fieldmask

          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.

          Location : query

          Type : string

        name

          Location : path

          Type : string

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/metadataImports/[^/]+$

          Description : Immutable. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.

      HTTP Method : PATCH

      Path : v1/{+name}

      Description : Updates a single import. Only the description field of MetadataImport is supported to be updated.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports/{metadataImportsId}

  • metastore.projects.locations.get

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v1/{+name}

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Type : string

          Description : Resource name for the location.

          Required : Yes

      Parameter Order : name

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}

      Description : Gets information about a location.

  • metastore.projects.locations.list

      Flat Path : v1/projects/{projectsId}/locations

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists information about the supported locations for this service.

      Path : v1/{+name}/locations

      Parameter Order : name

      Parameters :

        pageSize

          Format : int32

          Description : The maximum number of results to return. If not set, the service selects a default.

          Type : integer

          Location : query

        pageToken

          Location : query

          Type : string

          Description : A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

        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

        name

          Required : Yes

          Pattern : ^projects/[^/]+$

          Location : path

          Description : The resource that owns the locations collection, if applicable.

          Type : string

      HTTP Method : GET

  • metastore.operations.cancel

      Parameters :

        name

          Type : string

          Description : The name of the operation resource to be cancelled.

          Location : path

          Pattern : ^operations/.*$

          Required : Yes

      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.

      Path : v1/{+name}:cancel

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : POST

      Parameter Order : name

      Flat Path : v1/operations/{operationsId}:cancel