Interface BareMetalSolutionGrpc.AsyncService (0.32.0)

public static interface BareMetalSolutionGrpc.AsyncService

Performs management operations on Bare Metal Solution servers. The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.

Methods

createNfsShare(CreateNfsShareRequest request, StreamObserver<Operation> responseObserver)

public default void createNfsShare(CreateNfsShareRequest request, StreamObserver<Operation> responseObserver)

Create an NFS share.

Parameters
NameDescription
requestCreateNfsShareRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

createProvisioningConfig(CreateProvisioningConfigRequest request, StreamObserver<ProvisioningConfig> responseObserver)

public default void createProvisioningConfig(CreateProvisioningConfigRequest request, StreamObserver<ProvisioningConfig> responseObserver)

Create new ProvisioningConfig.

Parameters
NameDescription
requestCreateProvisioningConfigRequest
responseObserverio.grpc.stub.StreamObserver<ProvisioningConfig>

createSSHKey(CreateSSHKeyRequest request, StreamObserver<SSHKey> responseObserver)

public default void createSSHKey(CreateSSHKeyRequest request, StreamObserver<SSHKey> responseObserver)

Register a public SSH key in the specified project for use with the interactive serial console feature.

Parameters
NameDescription
requestCreateSSHKeyRequest
responseObserverio.grpc.stub.StreamObserver<SSHKey>

createVolumeSnapshot(CreateVolumeSnapshotRequest request, StreamObserver<VolumeSnapshot> responseObserver)

public default void createVolumeSnapshot(CreateVolumeSnapshotRequest request, StreamObserver<VolumeSnapshot> responseObserver)

Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
NameDescription
requestCreateVolumeSnapshotRequest
responseObserverio.grpc.stub.StreamObserver<VolumeSnapshot>

deleteNfsShare(DeleteNfsShareRequest request, StreamObserver<Operation> responseObserver)

public default void deleteNfsShare(DeleteNfsShareRequest request, StreamObserver<Operation> responseObserver)

Delete an NFS share. The underlying volume is automatically deleted.

Parameters
NameDescription
requestDeleteNfsShareRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteSSHKey(DeleteSSHKeyRequest request, StreamObserver<Empty> responseObserver)

public default void deleteSSHKey(DeleteSSHKeyRequest request, StreamObserver<Empty> responseObserver)

Deletes a public SSH key registered in the specified project.

Parameters
NameDescription
requestDeleteSSHKeyRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request, StreamObserver<Empty> responseObserver)

public default void deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request, StreamObserver<Empty> responseObserver)

Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
NameDescription
requestDeleteVolumeSnapshotRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

detachLun(DetachLunRequest request, StreamObserver<Operation> responseObserver)

public default void detachLun(DetachLunRequest request, StreamObserver<Operation> responseObserver)

Detach LUN from Instance.

Parameters
NameDescription
requestDetachLunRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

disableInteractiveSerialConsole(DisableInteractiveSerialConsoleRequest request, StreamObserver<Operation> responseObserver)

public default void disableInteractiveSerialConsole(DisableInteractiveSerialConsoleRequest request, StreamObserver<Operation> responseObserver)

Disable the interactive serial console feature on an instance.

Parameters
NameDescription
requestDisableInteractiveSerialConsoleRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

enableInteractiveSerialConsole(EnableInteractiveSerialConsoleRequest request, StreamObserver<Operation> responseObserver)

public default void enableInteractiveSerialConsole(EnableInteractiveSerialConsoleRequest request, StreamObserver<Operation> responseObserver)

Enable the interactive serial console feature on an instance.

Parameters
NameDescription
requestEnableInteractiveSerialConsoleRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

evictLun(EvictLunRequest request, StreamObserver<Operation> responseObserver)

public default void evictLun(EvictLunRequest request, StreamObserver<Operation> responseObserver)

Skips lun's cooloff and deletes it now. Lun must be in cooloff state.

Parameters
NameDescription
requestEvictLunRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

evictVolume(EvictVolumeRequest request, StreamObserver<Operation> responseObserver)

public default void evictVolume(EvictVolumeRequest request, StreamObserver<Operation> responseObserver)

Skips volume's cooloff and deletes it now. Volume must be in cooloff state.

Parameters
NameDescription
requestEvictVolumeRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

public default void getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

Get details about a single server.

Parameters
NameDescription
requestGetInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Instance>

getLun(GetLunRequest request, StreamObserver<Lun> responseObserver)

public default void getLun(GetLunRequest request, StreamObserver<Lun> responseObserver)

Get details of a single storage logical unit number(LUN).

Parameters
NameDescription
requestGetLunRequest
responseObserverio.grpc.stub.StreamObserver<Lun>

getNetwork(GetNetworkRequest request, StreamObserver<Network> responseObserver)

public default void getNetwork(GetNetworkRequest request, StreamObserver<Network> responseObserver)

Get details of a single network.

Parameters
NameDescription
requestGetNetworkRequest
responseObserverio.grpc.stub.StreamObserver<Network>

getNfsShare(GetNfsShareRequest request, StreamObserver<NfsShare> responseObserver)

public default void getNfsShare(GetNfsShareRequest request, StreamObserver<NfsShare> responseObserver)

Get details of a single NFS share.

Parameters
NameDescription
requestGetNfsShareRequest
responseObserverio.grpc.stub.StreamObserver<NfsShare>

getProvisioningConfig(GetProvisioningConfigRequest request, StreamObserver<ProvisioningConfig> responseObserver)

public default void getProvisioningConfig(GetProvisioningConfigRequest request, StreamObserver<ProvisioningConfig> responseObserver)

Get ProvisioningConfig by name.

Parameters
NameDescription
requestGetProvisioningConfigRequest
responseObserverio.grpc.stub.StreamObserver<ProvisioningConfig>

getVolume(GetVolumeRequest request, StreamObserver<Volume> responseObserver)

public default void getVolume(GetVolumeRequest request, StreamObserver<Volume> responseObserver)

Get details of a single storage volume.

Parameters
NameDescription
requestGetVolumeRequest
responseObserverio.grpc.stub.StreamObserver<Volume>

getVolumeSnapshot(GetVolumeSnapshotRequest request, StreamObserver<VolumeSnapshot> responseObserver)

public default void getVolumeSnapshot(GetVolumeSnapshotRequest request, StreamObserver<VolumeSnapshot> responseObserver)

Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
NameDescription
requestGetVolumeSnapshotRequest
responseObserverio.grpc.stub.StreamObserver<VolumeSnapshot>

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

public default void listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

List servers in a given project and location.

Parameters
NameDescription
requestListInstancesRequest
responseObserverio.grpc.stub.StreamObserver<ListInstancesResponse>

listLuns(ListLunsRequest request, StreamObserver<ListLunsResponse> responseObserver)

public default void listLuns(ListLunsRequest request, StreamObserver<ListLunsResponse> responseObserver)

List storage volume luns for given storage volume.

Parameters
NameDescription
requestListLunsRequest
responseObserverio.grpc.stub.StreamObserver<ListLunsResponse>

listNetworkUsage(ListNetworkUsageRequest request, StreamObserver<ListNetworkUsageResponse> responseObserver)

public default void listNetworkUsage(ListNetworkUsageRequest request, StreamObserver<ListNetworkUsageResponse> responseObserver)

List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

Parameters
NameDescription
requestListNetworkUsageRequest
responseObserverio.grpc.stub.StreamObserver<ListNetworkUsageResponse>

listNetworks(ListNetworksRequest request, StreamObserver<ListNetworksResponse> responseObserver)

public default void listNetworks(ListNetworksRequest request, StreamObserver<ListNetworksResponse> responseObserver)

List network in a given project and location.

Parameters
NameDescription
requestListNetworksRequest
responseObserverio.grpc.stub.StreamObserver<ListNetworksResponse>

listNfsShares(ListNfsSharesRequest request, StreamObserver<ListNfsSharesResponse> responseObserver)

public default void listNfsShares(ListNfsSharesRequest request, StreamObserver<ListNfsSharesResponse> responseObserver)

List NFS shares.

Parameters
NameDescription
requestListNfsSharesRequest
responseObserverio.grpc.stub.StreamObserver<ListNfsSharesResponse>

listOSImages(ListOSImagesRequest request, StreamObserver<ListOSImagesResponse> responseObserver)

public default void listOSImages(ListOSImagesRequest request, StreamObserver<ListOSImagesResponse> responseObserver)

Retrieves the list of OS images which are currently approved.

Parameters
NameDescription
requestListOSImagesRequest
responseObserverio.grpc.stub.StreamObserver<ListOSImagesResponse>

listProvisioningQuotas(ListProvisioningQuotasRequest request, StreamObserver<ListProvisioningQuotasResponse> responseObserver)

public default void listProvisioningQuotas(ListProvisioningQuotasRequest request, StreamObserver<ListProvisioningQuotasResponse> responseObserver)

List the budget details to provision resources on a given project.

Parameters
NameDescription
requestListProvisioningQuotasRequest
responseObserverio.grpc.stub.StreamObserver<ListProvisioningQuotasResponse>

listSSHKeys(ListSSHKeysRequest request, StreamObserver<ListSSHKeysResponse> responseObserver)

public default void listSSHKeys(ListSSHKeysRequest request, StreamObserver<ListSSHKeysResponse> responseObserver)

Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.

Parameters
NameDescription
requestListSSHKeysRequest
responseObserverio.grpc.stub.StreamObserver<ListSSHKeysResponse>

listVolumeSnapshots(ListVolumeSnapshotsRequest request, StreamObserver<ListVolumeSnapshotsResponse> responseObserver)

public default void listVolumeSnapshots(ListVolumeSnapshotsRequest request, StreamObserver<ListVolumeSnapshotsResponse> responseObserver)

Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.

Parameters
NameDescription
requestListVolumeSnapshotsRequest
responseObserverio.grpc.stub.StreamObserver<ListVolumeSnapshotsResponse>

listVolumes(ListVolumesRequest request, StreamObserver<ListVolumesResponse> responseObserver)

public default void listVolumes(ListVolumesRequest request, StreamObserver<ListVolumesResponse> responseObserver)

List storage volumes in a given project and location.

Parameters
NameDescription
requestListVolumesRequest
responseObserverio.grpc.stub.StreamObserver<ListVolumesResponse>

renameInstance(RenameInstanceRequest request, StreamObserver<Instance> responseObserver)

public default void renameInstance(RenameInstanceRequest request, StreamObserver<Instance> responseObserver)

RenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.

Parameters
NameDescription
requestRenameInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Instance>

renameNetwork(RenameNetworkRequest request, StreamObserver<Network> responseObserver)

public default void renameNetwork(RenameNetworkRequest request, StreamObserver<Network> responseObserver)

RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated.

Parameters
NameDescription
requestRenameNetworkRequest
responseObserverio.grpc.stub.StreamObserver<Network>

renameNfsShare(RenameNfsShareRequest request, StreamObserver<NfsShare> responseObserver)

public default void renameNfsShare(RenameNfsShareRequest request, StreamObserver<NfsShare> responseObserver)

RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.

Parameters
NameDescription
requestRenameNfsShareRequest
responseObserverio.grpc.stub.StreamObserver<NfsShare>

renameVolume(RenameVolumeRequest request, StreamObserver<Volume> responseObserver)

public default void renameVolume(RenameVolumeRequest request, StreamObserver<Volume> responseObserver)

RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.

Parameters
NameDescription
requestRenameVolumeRequest
responseObserverio.grpc.stub.StreamObserver<Volume>

resetInstance(ResetInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void resetInstance(ResetInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
NameDescription
requestResetInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

resizeVolume(ResizeVolumeRequest request, StreamObserver<Operation> responseObserver)

public default void resizeVolume(ResizeVolumeRequest request, StreamObserver<Operation> responseObserver)

Emergency Volume resize.

Parameters
NameDescription
requestResizeVolumeRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

restoreVolumeSnapshot(RestoreVolumeSnapshotRequest request, StreamObserver<Operation> responseObserver)

public default void restoreVolumeSnapshot(RestoreVolumeSnapshotRequest request, StreamObserver<Operation> responseObserver)

Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters
NameDescription
requestRestoreVolumeSnapshotRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

startInstance(StartInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void startInstance(StartInstanceRequest request, StreamObserver<Operation> responseObserver)

Starts a server that was shutdown.

Parameters
NameDescription
requestStartInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

stopInstance(StopInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void stopInstance(StopInstanceRequest request, StreamObserver<Operation> responseObserver)

Stop a running server.

Parameters
NameDescription
requestStopInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

submitProvisioningConfig(SubmitProvisioningConfigRequest request, StreamObserver<SubmitProvisioningConfigResponse> responseObserver)

public default void submitProvisioningConfig(SubmitProvisioningConfigRequest request, StreamObserver<SubmitProvisioningConfigResponse> responseObserver)

Submit a provisiong configuration for a given project.

Parameters
NameDescription
requestSubmitProvisioningConfigRequest
responseObserverio.grpc.stub.StreamObserver<SubmitProvisioningConfigResponse>

updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

Update details of a single server.

Parameters
NameDescription
requestUpdateInstanceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

updateNetwork(UpdateNetworkRequest request, StreamObserver<Operation> responseObserver)

public default void updateNetwork(UpdateNetworkRequest request, StreamObserver<Operation> responseObserver)

Update details of a single network.

Parameters
NameDescription
requestUpdateNetworkRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

updateNfsShare(UpdateNfsShareRequest request, StreamObserver<Operation> responseObserver)

public default void updateNfsShare(UpdateNfsShareRequest request, StreamObserver<Operation> responseObserver)

Update details of a single NFS share.

Parameters
NameDescription
requestUpdateNfsShareRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

updateProvisioningConfig(UpdateProvisioningConfigRequest request, StreamObserver<ProvisioningConfig> responseObserver)

public default void updateProvisioningConfig(UpdateProvisioningConfigRequest request, StreamObserver<ProvisioningConfig> responseObserver)

Update existing ProvisioningConfig.

Parameters
NameDescription
requestUpdateProvisioningConfigRequest
responseObserverio.grpc.stub.StreamObserver<ProvisioningConfig>

updateVolume(UpdateVolumeRequest request, StreamObserver<Operation> responseObserver)

public default void updateVolume(UpdateVolumeRequest request, StreamObserver<Operation> responseObserver)

Update details of a single storage volume.

Parameters
NameDescription
requestUpdateVolumeRequest
responseObserverio.grpc.stub.StreamObserver<Operation>