Cloud Spanner API (spanner:v1)

2022-04-08

4 new methods

Additions

    Methods
  • spanner.projects.instanceConfigs.operations.list

      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:

        pageToken

          Type: string

          Location: query

          Description: The standard list page token.

        name

          Location: path

          Type: string

          Required: Yes

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

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

        pageSize

          Description: The standard list page size.

          Location: query

          Type: integer

          Format: int32

        filter

          Description: The standard list filter.

          Location: query

          Type: string

      HTTP Method: GET

      Scopes:

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

      Parameter Order: name

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

  • spanner.projects.instanceConfigs.operations.delete

      Parameter Order: name

      Path: v1/{+name}

      Parameters:

        name

          Type: string

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

          Required: Yes

          Location: path

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

      HTTP Method: 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`.

  • spanner.projects.instanceConfigs.operations.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`.

      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

      HTTP Method: POST

      Path: v1/{+name}:cancel

      Parameters:

        name

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

          Required: Yes

          Type: string

          Location: path

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

  • spanner.projects.instanceConfigs.operations.get

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

      Path: v1/{+name}

      Parameters:

        name

          Type: string

          Location: path

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

          Description: The name of the operation resource.

          Required: Yes

      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.

      HTTP Method: GET

      Scopes:

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

4 removed methods

Deletions

    Methods
  • 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}

      Path: v1/{+name}

      Parameters:

        name

          Location: path

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

          Type: string

          Required: Yes

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

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

      Parameter Order: name

  • spanner.projects.instanceConfigs.operations.list

      Parameters:

        name

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

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

          Required: Yes

          Location: path

          Type: string

        filter

          Location: query

          Type: string

          Description: The standard list filter.

        pageToken

          Type: string

          Description: The standard list page token.

          Location: query

        pageSize

          Type: integer

          Location: query

          Description: The standard list page size.

          Format: int32

      Scopes:

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

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

      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.

      Path: v1/{+name}

  • spanner.projects.instanceConfigs.operations.cancel

      Path: v1/{+name}:cancel

      Parameters:

        name

          Required: Yes

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

          Location: path

          Type: string

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

      Flat Path: v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}: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

      Scopes:

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

  • spanner.projects.instanceConfigs.operations.get

      Path: v1/{+name}

      Parameters:

        name

          Location: path

          Required: Yes

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

          Description: The name of the operation resource.

          Type: string

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

      HTTP Method: GET

      Scopes:

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