Class BareMetalSolutionGrpc.BareMetalSolutionBlockingStub (0.37.0)

public static final class BareMetalSolutionGrpc.BareMetalSolutionBlockingStub extends AbstractBlockingStub<BareMetalSolutionGrpc.BareMetalSolutionBlockingStub>

A stub to allow clients to do synchronous rpc calls to service BareMetalSolution.

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > BareMetalSolutionGrpc.BareMetalSolutionBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected BareMetalSolutionGrpc.BareMetalSolutionBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
BareMetalSolutionGrpc.BareMetalSolutionBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createNfsShare(CreateNfsShareRequest request)

public Operation createNfsShare(CreateNfsShareRequest request)

Create an NFS share.

Parameter
NameDescription
requestCreateNfsShareRequest
Returns
TypeDescription
Operation

createProvisioningConfig(CreateProvisioningConfigRequest request)

public ProvisioningConfig createProvisioningConfig(CreateProvisioningConfigRequest request)

Create new ProvisioningConfig.

Parameter
NameDescription
requestCreateProvisioningConfigRequest
Returns
TypeDescription
ProvisioningConfig

createSSHKey(CreateSSHKeyRequest request)

public SSHKey createSSHKey(CreateSSHKeyRequest request)

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

Parameter
NameDescription
requestCreateSSHKeyRequest
Returns
TypeDescription
SSHKey

createVolumeSnapshot(CreateVolumeSnapshotRequest request)

public VolumeSnapshot createVolumeSnapshot(CreateVolumeSnapshotRequest request)

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

Parameter
NameDescription
requestCreateVolumeSnapshotRequest
Returns
TypeDescription
VolumeSnapshot

deleteNfsShare(DeleteNfsShareRequest request)

public Operation deleteNfsShare(DeleteNfsShareRequest request)

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

Parameter
NameDescription
requestDeleteNfsShareRequest
Returns
TypeDescription
Operation

deleteSSHKey(DeleteSSHKeyRequest request)

public Empty deleteSSHKey(DeleteSSHKeyRequest request)

Deletes a public SSH key registered in the specified project.

Parameter
NameDescription
requestDeleteSSHKeyRequest
Returns
TypeDescription
Empty

deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request)

public Empty deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request)

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

Parameter
NameDescription
requestDeleteVolumeSnapshotRequest
Returns
TypeDescription
Empty

detachLun(DetachLunRequest request)

public Operation detachLun(DetachLunRequest request)

Detach LUN from Instance.

Parameter
NameDescription
requestDetachLunRequest
Returns
TypeDescription
Operation

disableInteractiveSerialConsole(DisableInteractiveSerialConsoleRequest request)

public Operation disableInteractiveSerialConsole(DisableInteractiveSerialConsoleRequest request)

Disable the interactive serial console feature on an instance.

Parameter
NameDescription
requestDisableInteractiveSerialConsoleRequest
Returns
TypeDescription
Operation

enableInteractiveSerialConsole(EnableInteractiveSerialConsoleRequest request)

public Operation enableInteractiveSerialConsole(EnableInteractiveSerialConsoleRequest request)

Enable the interactive serial console feature on an instance.

Parameter
NameDescription
requestEnableInteractiveSerialConsoleRequest
Returns
TypeDescription
Operation

evictLun(EvictLunRequest request)

public Operation evictLun(EvictLunRequest request)

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

Parameter
NameDescription
requestEvictLunRequest
Returns
TypeDescription
Operation

evictVolume(EvictVolumeRequest request)

public Operation evictVolume(EvictVolumeRequest request)

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

Parameter
NameDescription
requestEvictVolumeRequest
Returns
TypeDescription
Operation

getInstance(GetInstanceRequest request)

public Instance getInstance(GetInstanceRequest request)

Get details about a single server.

Parameter
NameDescription
requestGetInstanceRequest
Returns
TypeDescription
Instance

getLun(GetLunRequest request)

public Lun getLun(GetLunRequest request)

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

Parameter
NameDescription
requestGetLunRequest
Returns
TypeDescription
Lun

getNetwork(GetNetworkRequest request)

public Network getNetwork(GetNetworkRequest request)

Get details of a single network.

Parameter
NameDescription
requestGetNetworkRequest
Returns
TypeDescription
Network

getNfsShare(GetNfsShareRequest request)

public NfsShare getNfsShare(GetNfsShareRequest request)

Get details of a single NFS share.

Parameter
NameDescription
requestGetNfsShareRequest
Returns
TypeDescription
NfsShare

getProvisioningConfig(GetProvisioningConfigRequest request)

public ProvisioningConfig getProvisioningConfig(GetProvisioningConfigRequest request)

Get ProvisioningConfig by name.

Parameter
NameDescription
requestGetProvisioningConfigRequest
Returns
TypeDescription
ProvisioningConfig

getVolume(GetVolumeRequest request)

public Volume getVolume(GetVolumeRequest request)

Get details of a single storage volume.

Parameter
NameDescription
requestGetVolumeRequest
Returns
TypeDescription
Volume

getVolumeSnapshot(GetVolumeSnapshotRequest request)

public VolumeSnapshot getVolumeSnapshot(GetVolumeSnapshotRequest request)

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

Parameter
NameDescription
requestGetVolumeSnapshotRequest
Returns
TypeDescription
VolumeSnapshot

listInstances(ListInstancesRequest request)

public ListInstancesResponse listInstances(ListInstancesRequest request)

List servers in a given project and location.

Parameter
NameDescription
requestListInstancesRequest
Returns
TypeDescription
ListInstancesResponse

listLuns(ListLunsRequest request)

public ListLunsResponse listLuns(ListLunsRequest request)

List storage volume luns for given storage volume.

Parameter
NameDescription
requestListLunsRequest
Returns
TypeDescription
ListLunsResponse

listNetworkUsage(ListNetworkUsageRequest request)

public ListNetworkUsageResponse listNetworkUsage(ListNetworkUsageRequest request)

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

Parameter
NameDescription
requestListNetworkUsageRequest
Returns
TypeDescription
ListNetworkUsageResponse

listNetworks(ListNetworksRequest request)

public ListNetworksResponse listNetworks(ListNetworksRequest request)

List network in a given project and location.

Parameter
NameDescription
requestListNetworksRequest
Returns
TypeDescription
ListNetworksResponse

listNfsShares(ListNfsSharesRequest request)

public ListNfsSharesResponse listNfsShares(ListNfsSharesRequest request)

List NFS shares.

Parameter
NameDescription
requestListNfsSharesRequest
Returns
TypeDescription
ListNfsSharesResponse

listOSImages(ListOSImagesRequest request)

public ListOSImagesResponse listOSImages(ListOSImagesRequest request)

Retrieves the list of OS images which are currently approved.

Parameter
NameDescription
requestListOSImagesRequest
Returns
TypeDescription
ListOSImagesResponse

listProvisioningQuotas(ListProvisioningQuotasRequest request)

public ListProvisioningQuotasResponse listProvisioningQuotas(ListProvisioningQuotasRequest request)

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

Parameter
NameDescription
requestListProvisioningQuotasRequest
Returns
TypeDescription
ListProvisioningQuotasResponse

listSSHKeys(ListSSHKeysRequest request)

public ListSSHKeysResponse listSSHKeys(ListSSHKeysRequest request)

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

Parameter
NameDescription
requestListSSHKeysRequest
Returns
TypeDescription
ListSSHKeysResponse

listVolumeSnapshots(ListVolumeSnapshotsRequest request)

public ListVolumeSnapshotsResponse listVolumeSnapshots(ListVolumeSnapshotsRequest request)

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.

Parameter
NameDescription
requestListVolumeSnapshotsRequest
Returns
TypeDescription
ListVolumeSnapshotsResponse

listVolumes(ListVolumesRequest request)

public ListVolumesResponse listVolumes(ListVolumesRequest request)

List storage volumes in a given project and location.

Parameter
NameDescription
requestListVolumesRequest
Returns
TypeDescription
ListVolumesResponse

renameInstance(RenameInstanceRequest request)

public Instance renameInstance(RenameInstanceRequest request)

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

Parameter
NameDescription
requestRenameInstanceRequest
Returns
TypeDescription
Instance

renameNetwork(RenameNetworkRequest request)

public Network renameNetwork(RenameNetworkRequest request)

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

Parameter
NameDescription
requestRenameNetworkRequest
Returns
TypeDescription
Network

renameNfsShare(RenameNfsShareRequest request)

public NfsShare renameNfsShare(RenameNfsShareRequest request)

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

Parameter
NameDescription
requestRenameNfsShareRequest
Returns
TypeDescription
NfsShare

renameVolume(RenameVolumeRequest request)

public Volume renameVolume(RenameVolumeRequest request)

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

Parameter
NameDescription
requestRenameVolumeRequest
Returns
TypeDescription
Volume

resetInstance(ResetInstanceRequest request)

public Operation resetInstance(ResetInstanceRequest request)

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

Parameter
NameDescription
requestResetInstanceRequest
Returns
TypeDescription
Operation

resizeVolume(ResizeVolumeRequest request)

public Operation resizeVolume(ResizeVolumeRequest request)

Emergency Volume resize.

Parameter
NameDescription
requestResizeVolumeRequest
Returns
TypeDescription
Operation

restoreVolumeSnapshot(RestoreVolumeSnapshotRequest request)

public Operation restoreVolumeSnapshot(RestoreVolumeSnapshotRequest request)

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

Parameter
NameDescription
requestRestoreVolumeSnapshotRequest
Returns
TypeDescription
Operation

startInstance(StartInstanceRequest request)

public Operation startInstance(StartInstanceRequest request)

Starts a server that was shutdown.

Parameter
NameDescription
requestStartInstanceRequest
Returns
TypeDescription
Operation

stopInstance(StopInstanceRequest request)

public Operation stopInstance(StopInstanceRequest request)

Stop a running server.

Parameter
NameDescription
requestStopInstanceRequest
Returns
TypeDescription
Operation

submitProvisioningConfig(SubmitProvisioningConfigRequest request)

public SubmitProvisioningConfigResponse submitProvisioningConfig(SubmitProvisioningConfigRequest request)

Submit a provisiong configuration for a given project.

Parameter
NameDescription
requestSubmitProvisioningConfigRequest
Returns
TypeDescription
SubmitProvisioningConfigResponse

updateInstance(UpdateInstanceRequest request)

public Operation updateInstance(UpdateInstanceRequest request)

Update details of a single server.

Parameter
NameDescription
requestUpdateInstanceRequest
Returns
TypeDescription
Operation

updateNetwork(UpdateNetworkRequest request)

public Operation updateNetwork(UpdateNetworkRequest request)

Update details of a single network.

Parameter
NameDescription
requestUpdateNetworkRequest
Returns
TypeDescription
Operation

updateNfsShare(UpdateNfsShareRequest request)

public Operation updateNfsShare(UpdateNfsShareRequest request)

Update details of a single NFS share.

Parameter
NameDescription
requestUpdateNfsShareRequest
Returns
TypeDescription
Operation

updateProvisioningConfig(UpdateProvisioningConfigRequest request)

public ProvisioningConfig updateProvisioningConfig(UpdateProvisioningConfigRequest request)

Update existing ProvisioningConfig.

Parameter
NameDescription
requestUpdateProvisioningConfigRequest
Returns
TypeDescription
ProvisioningConfig

updateVolume(UpdateVolumeRequest request)

public Operation updateVolume(UpdateVolumeRequest request)

Update details of a single storage volume.

Parameter
NameDescription
requestUpdateVolumeRequest
Returns
TypeDescription
Operation