Bare Metal Solution API (baremetalsolution:v1)

2022-01-24

4 new methods

Additions

    Methods
  • baremetalsolution.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`.

      Parameter Order : name

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

      Parameters :

        name

          Required : Yes

          Location : path

          Pattern : ^operations/.*$

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

          Type : string

      Path : v1/{+name}:cancel

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

      HTTP Method : POST

  • baremetalsolution.operations.get

      Parameters :

        name

          Pattern : ^operations/.*$

          Location : path

          Description : The name of the operation resource.

          Required : Yes

          Type : string

      Flat Path : v1/operations/{operationsId}

      HTTP Method : GET

      Path : v1/{+name}

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

      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.

  • baremetalsolution.operations.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

      Parameters :

        name

          Location : path

          Required : Yes

          Pattern : ^operations/.*$

          Type : string

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

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

      Path : v1/{+name}

      Flat Path : v1/operations/{operationsId}

      HTTP Method : DELETE

  • baremetalsolution.operations.list

      HTTP Method : GET

      Parameters :

        pageToken

          Location : query

          Type : string

          Description : The standard list page token.

        filter

          Location : query

          Description : The standard list filter.

          Type : string

        pageSize

          Location : query

          Type : integer

          Description : The standard list page size.

          Format : int32

        name

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

          Type : string

          Pattern : ^operations$

          Required : Yes

          Location : path

      Parameter Order : name

      Flat Path : v1/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.

      Path : v1/{+name}

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