Bare Metal Solution API (baremetalsolution:v1)

2022-12-24

4 new methods | New API

Additions

    Methods
  • baremetalsolution.operations.get

      Path: v1/{+name}

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

      Parameters:

        name

          Pattern: ^operations/.*$

          Required: Yes

          Type: string

          Location: path

          Description: The name of the operation resource.

      Flat Path: v1/operations/{operationsId}

      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

      HTTP Method: GET

  • baremetalsolution.operations.cancel

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

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

      Parameters:

        name

          Type: string

          Pattern: ^operations/.*$

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

          Required: Yes

          Location: path

      HTTP Method: POST

      Parameter Order: name

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

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

      Path: v1/{+name}

      Parameter Order: name

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

      Parameters:

        name

          Pattern: ^operations$

          Required: Yes

          Location: path

          Type: string

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

        pageToken

          Type: string

          Description: The standard list page token.

          Location: query

        filter

          Description: The standard list filter.

          Type: string

          Location: query

        pageSize

          Location: query

          Type: integer

          Description: The standard list page size.

          Format: int32

      Flat Path: v1/operations

      HTTP Method: GET

  • baremetalsolution.operations.delete

      Flat Path: v1/operations/{operationsId}

      Parameter Order: name

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

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

      HTTP Method: DELETE

      Parameters:

        name

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

          Pattern: ^operations/.*$

          Type: string

          Required: Yes

          Location: path

4 removed methods | Removed API

Deletions

    Methods
  • baremetalsolution.operations.delete

      Parameter Order: name

      Parameters:

        name

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

          Required: Yes

          Type: string

          Location: path

          Pattern: ^operations/.*$

      Path: v1/{+name}

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

      HTTP Method: DELETE

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

  • baremetalsolution.operations.cancel

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

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

      Parameters:

        name

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

          Pattern: ^operations/.*$

          Type: string

          Required: Yes

          Location: path

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

      HTTP Method: POST

  • baremetalsolution.operations.list

      HTTP Method: GET

      Path: v1/{+name}

      Parameters:

        pageSize

          Type: integer

          Location: query

          Format: int32

          Description: The standard list page size.

        filter

          Type: string

          Location: query

          Description: The standard list filter.

        pageToken

          Location: query

          Type: string

          Description: The standard list page token.

        name

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

          Required: Yes

          Type: string

          Location: path

          Pattern: ^operations$

      Parameter Order: name

      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

      Flat Path: v1/operations

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

      Parameters:

        name

          Description: The name of the operation resource.

          Required: Yes

          Pattern: ^operations/.*$

          Type: string

          Location: path

      Parameter Order: name

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

      Path: v1/{+name}

      Flat Path: v1/operations/{operationsId}

      HTTP Method: GET