Cloud Spanner API (spanner:v1)

2022-04-07

4 new methods

Additions

    Methods
  • spanner.projects.instanceConfigs.operations.get

      Flat Path: v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}

      HTTP Method: GET

      Parameter Order: name

      Parameters:

        name

          Location: path

          Description: The name of the operation resource.

          Required: Yes

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

          Type: string

      Path: v1/{+name}

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/spanner.admin
    • 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.

  • spanner.projects.instanceConfigs.operations.list

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/spanner.admin
    • Flat Path: v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations

      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:

        name

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

          Location: path

          Required: Yes

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

          Type: string

        pageSize

          Description: The standard list page size.

          Type: integer

          Location: query

          Format: int32

        filter

          Type: string

          Description: The standard list filter.

          Location: query

        pageToken

          Type: string

          Location: query

          Description: The standard list page token.

      Parameter Order: name

      Path: v1/{+name}

      HTTP Method: GET

  • spanner.projects.instanceConfigs.operations.delete

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/spanner.admin
    • Flat Path: v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}

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

      Parameter Order: name

      HTTP Method: DELETE

      Path: v1/{+name}

      Parameters:

        name

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

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

          Location: path

          Type: string

          Required: Yes

  • spanner.projects.instanceConfigs.operations.cancel

      Path: v1/{+name}:cancel

      HTTP Method: POST

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/spanner.admin
    • Flat Path: v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}:cancel

      Parameter Order: name

      Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

      Parameters:

        name

          Location: path

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

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

          Required: Yes

          Type: string