Bare Metal Solution API (baremetalsolution:v2)

2021-12-08

26 new methods | New API

Additions

    Methods
  • baremetalsolution.projects.locations.operations.delete

      Parameters:

        name

          Required: Yes

          Location: path

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

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

          Type: string

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

      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

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Path: v2/{+name}

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

      HTTP Method: GET

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

      Parameter Order: name

      Path: v2/{+name}

      Parameters:

        name

          Description: The name of the operation resource.

          Required: Yes

          Type: string

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

          Location: path

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

  • baremetalsolution.projects.locations.operations.list

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: The standard list page token.

        pageSize

          Location: query

          Description: The standard list page size.

          Format: int32

          Type: integer

        filter

          Location: query

          Description: The standard list filter.

          Type: string

        name

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

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations

      HTTP Method: GET

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

      Parameter Order: name

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

  • baremetalsolution.projects.locations.operations.cancel

      Parameters:

        name

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

          Location: path

          Required: Yes

          Type: string

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

      HTTP Method: POST

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

      Path: v2/{+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: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

  • baremetalsolution.projects.locations.networks.list

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/networks

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

      Description: List network in a given project and location.

      Parameters:

        pageSize

          Location: query

          Description: Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

          Format: int32

          Type: integer

        pageToken

          Location: query

          Type: string

          Description: A token identifying a page of results from the server.

        parent

          Required: Yes

          Description: Required. Parent value for ListNetworksRequest.

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

      Parameter Order: parent

      HTTP Method: GET

      Path: v2/{+parent}/networks

  • baremetalsolution.projects.locations.networks.get

      Description: Get details of a single network.

      Parameters:

        name

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/networks/[^/]+$

          Required: Yes

          Description: Required. Name of the resource.

      Path: v2/{+name}

      Parameter Order: name

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

      HTTP Method: GET

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}

  • baremetalsolution.projects.locations.volumes.luns.get

      HTTP Method: GET

      Description: Get details of a single storage lun.

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

      Parameter Order: name

      Path: v2/{+name}

      Parameters:

        name

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/luns/[^/]+$

          Location: path

          Description: Required. Name of the resource.

          Type: string

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns/{lunsId}

  • baremetalsolution.projects.locations.volumes.luns.list

      Parameter Order: parent

      HTTP Method: GET

      Description: List storage volume luns for given storage volume.

      Path: v2/{+parent}/luns

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns

      Parameters:

        pageToken

          Description: A token identifying a page of results from the server.

          Type: string

          Location: query

        pageSize

          Type: integer

          Location: query

          Description: Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

          Format: int32

        parent

          Type: string

          Description: Required. Parent value for ListLunsRequest.

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$

          Location: path

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

  • baremetalsolution.projects.locations.volumes.snapshots.get

      Description: Get details of a single storage volume snapshot.

      Parameters:

        name

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$

          Location: path

          Description: Required. Name of the resource.

          Type: string

      Path: v2/{+name}

      Parameter Order: name

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}

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

      HTTP Method: GET

  • baremetalsolution.projects.locations.volumes.snapshots.create

      Parameter Order: parent

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

      Parameters:

        parent

          Required: Yes

          Location: path

          Description: Required. The volume to snapshot.

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$

          Type: string

      Description: Create a storage volume snapshot in a containing volume.

      HTTP Method: POST

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots

      Path: v2/{+parent}/snapshots

  • baremetalsolution.projects.locations.volumes.snapshots.delete

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

      Description: Deletes a storage volume snapshot for a given volume.

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}

      Parameters:

        name

          Required: Yes

          Location: path

          Type: string

          Description: Required. The name of the snapshot to delete.

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$

      Path: v2/{+name}

      Parameter Order: name

      HTTP Method: DELETE

  • baremetalsolution.projects.locations.volumes.snapshots.list

      Path: v2/{+parent}/snapshots

      HTTP Method: GET

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots

      Parameters:

        pageSize

          Description: Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

          Format: int32

          Location: query

          Type: integer

        pageToken

          Description: A token identifying a page of results from the server.

          Location: query

          Type: string

        parent

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$

          Location: path

          Required: Yes

          Type: string

          Description: Required. Parent value for ListVolumesRequest.

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

      Parameter Order: parent

      Description: List storage volume snapshots for given storage volume.

  • baremetalsolution.projects.locations.volumes.snapshots.restoreVolumeSnapshot

      Path: v2/{+volumeSnapshot}:restoreVolumeSnapshot

      HTTP Method: POST

      Parameters:

        volumeSnapshot

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+/snapshots/[^/]+$

          Type: string

          Required: Yes

          Location: path

          Description: Required. Name of the resource.

      Parameter Order: volumeSnapshot

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

      Description: Restore a storage volume snapshot to its containing volume.

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}:restoreVolumeSnapshot

  • baremetalsolution.projects.locations.volumes.get

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$

          Type: string

          Description: Required. Name of the resource.

          Required: Yes

          Location: path

      Description: Get details of a single storage volume.

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}

      HTTP Method: GET

      Parameter Order: name

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

      Path: v2/{+name}

  • baremetalsolution.projects.locations.volumes.list

      HTTP Method: GET

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

      Description: List storage volumes in a given project and location.

      Path: v2/{+parent}/volumes

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes

      Parameters:

        pageSize

          Type: integer

          Description: Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

          Format: int32

          Location: query

        parent

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Description: Required. Parent value for ListVolumesRequest.

          Required: Yes

        pageToken

          Location: query

          Type: string

          Description: A token identifying a page of results from the server.

      Parameter Order: parent

  • baremetalsolution.projects.locations.volumes.patch

      Parameters:

        name

          Description: Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}`

          Location: path

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/volumes/[^/]+$

        updateMask

          Description: The list of fields to update. The only currently supported fields are: `snapshot_auto_delete_behavior` `snapshot_schedule_policy_name`

          Format: google-fieldmask

          Type: string

          Location: query

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

      Parameter Order: name

      HTTP Method: PATCH

      Description: Update details of a single storage volume.

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}

      Path: v2/{+name}

  • baremetalsolution.projects.locations.snapshotSchedulePolicies.patch

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

      Parameter Order: name

      HTTP Method: PATCH

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}

      Description: Update a snapshot schedule policy in the specified project.

      Parameters:

        name

          Type: string

          Description: Output only. The name of the snapshot schedule policy.

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$

          Location: path

        updateMask

          Description: Required. The list of fields to update.

          Location: query

          Format: google-fieldmask

          Type: string

  • baremetalsolution.projects.locations.snapshotSchedulePolicies.create

      Description: Create a snapshot schedule policy in the specified project.

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies

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

      HTTP Method: POST

      Parameters:

        parent

          Location: path

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Description: Required. The parent project and location containing the SnapshotSchedulePolicy.

        snapshotSchedulePolicyId

          Type: string

          Location: query

          Description: Required. Snapshot policy ID

      Path: v2/{+parent}/snapshotSchedulePolicies

      Parameter Order: parent

  • baremetalsolution.projects.locations.snapshotSchedulePolicies.list

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies

      HTTP Method: GET

      Description: List snapshot schedule policies in a given project and location.

      Parameter Order: parent

      Parameters:

        pageToken

          Type: string

          Description: The next_page_token value returned from a previous List request, if any.

          Location: query

        parent

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

          Required: Yes

          Location: path

          Description: Required. The parent project containing the Snapshot Schedule Policies.

        pageSize

          Location: query

          Format: int32

          Type: integer

          Description: The maximum number of items to return.

      Path: v2/{+parent}/snapshotSchedulePolicies

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

  • baremetalsolution.projects.locations.snapshotSchedulePolicies.get

      Parameter Order: name

      HTTP Method: GET

      Path: v2/{+name}

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

      Description: Get details of a single snapshot schedule policy.

      Parameters:

        name

          Location: path

          Description: Required. Name of the resource.

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$

          Required: Yes

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}

  • baremetalsolution.projects.locations.snapshotSchedulePolicies.delete

      Parameter Order: name

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

      Path: v2/{+name}

      Parameters:

        name

          Required: Yes

          Description: Required. The name of the snapshot schedule policy to delete.

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/snapshotSchedulePolicies/[^/]+$

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/snapshotSchedulePolicies/{snapshotSchedulePoliciesId}

      Description: Delete a named snapshot schedule policy.

      HTTP Method: DELETE

  • baremetalsolution.projects.locations.instances.get

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

          Description: Required. Name of the resource.

          Location: path

          Type: string

          Required: Yes

      Parameter Order: name

      Description: Get details about a single server.

      HTTP Method: GET

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

  • baremetalsolution.projects.locations.instances.reset

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

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reset

      Parameter Order: name

      Description: Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.

      HTTP Method: POST

      Path: v2/{+name}:reset

      Parameters:

        name

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

          Required: Yes

          Description: Required. Name of the resource.

  • baremetalsolution.projects.locations.instances.list

      Path: v2/{+parent}/instances

      Parameters:

        pageSize

          Format: int32

          Type: integer

          Description: Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

          Location: query

        parent

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

          Location: path

          Required: Yes

          Description: Required. Parent value for ListInstancesRequest.

        pageToken

          Location: query

          Description: A token identifying a page of results from the server.

          Type: string

      Parameter Order: parent

      Description: List servers in a given project and location.

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances

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

      HTTP Method: GET

  • baremetalsolution.projects.locations.list

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

      Path: v2/{+name}/locations

      HTTP Method: GET

      Description: Lists information about the supported locations for this service.

      Flat Path: v2/projects/{projectsId}/locations

      Parameter Order: name

      Parameters:

        pageSize

          Location: query

          Description: The maximum number of results to return. If not set, the service selects a default.

          Type: integer

          Format: int32

        filter

          Location: query

          Type: string

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).

        name

          Required: Yes

          Description: The resource that owns the locations collection, if applicable.

          Location: path

          Pattern: ^projects/[^/]+$

          Type: string

        pageToken

          Type: string

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Location: query

  • baremetalsolution.projects.locations.get

      Parameters:

        name

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Type: string

          Description: Resource name for the location.

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}

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

      HTTP Method: GET

      Parameter Order: name

      Description: Gets information about a location.