Bare Metal Solution API (baremetalsolution:v1)

2023-01-01

4 new methods | New API

Additions

    Methods
  • baremetalsolution.operations.get

      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.

      Parameter Order : name

      Path : v1/{+name}

      Flat Path : v1/operations/{operationsId}

      HTTP Method : GET

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

      Parameters :

        name

          Description : The name of the operation resource.

          Pattern : ^operations/.*$

          Type : string

          Required : Yes

          Location : path

  • baremetalsolution.operations.cancel

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

      HTTP Method : POST

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

      Parameters :

        name

          Required : Yes

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

          Type : string

          Pattern : ^operations/.*$

          Location : path

      Parameter Order : name

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

  • baremetalsolution.operations.list

      Parameters :

        pageSize

          Location : query

          Description : The standard list page size.

          Format : int32

          Type : integer

        pageToken

          Type : string

          Location : query

          Description : The standard list page token.

        name

          Pattern : ^operations$

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

          Location : path

          Required : Yes

          Type : string

        filter

          Location : query

          Description : The standard list filter.

          Type : string

      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.

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

      HTTP Method : GET

      Path : v1/{+name}

      Flat Path : v1/operations

      Parameter Order : name

  • baremetalsolution.operations.delete

      Path : v1/{+name}

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

      Parameter Order : name

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

      Parameters :

        name

          Type : string

          Required : Yes

          Pattern : ^operations/.*$

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

          Location : path