Cloud Spanner API (spanner:v1)

2023-04-30

4 new methods

Additions

    Methods
  • spanner.projects.instances.instancePartitions.operations.get

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+/operations/[^/]+$

          Required : Yes

          Description : The name of the operation resource.

          Type : string

      Parameter Order : name

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/spanner.admin
    • Path : v1/{+name}

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}

  • spanner.projects.instances.instancePartitions.operations.cancel

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

      HTTP Method : POST

      Parameters :

        name

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

          Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+/operations/[^/]+$

          Type : string

          Location : path

          Required : Yes

      Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}:cancel

      Path : v1/{+name}:cancel

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/spanner.admin
    • Parameter Order : name

  • spanner.projects.instances.instancePartitions.operations.list

      Path : v1/{+name}

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/spanner.admin
    • Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations

      Parameter Order : name

      Parameters :

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        name

          Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+/operations$

          Required : Yes

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

          Type : string

          Location : path

        pageToken

          Location : query

          Type : string

          Description : The standard list page token.

        pageSize

          Location : query

          Description : The standard list page size.

          Type : integer

          Format : int32

  • spanner.projects.instances.instancePartitions.operations.delete

      Parameter Order : name

      Flat Path : v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/spanner.admin
    • Parameters :

        name

          Pattern : ^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+/operations/[^/]+$

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

          Location : path

          Required : Yes

          Type : string

      HTTP Method : DELETE

      Path : v1/{+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`.