Class BareMetalSolutionGrpc.BareMetalSolutionFutureStub (0.43.0)

public static final class BareMetalSolutionGrpc.BareMetalSolutionFutureStub extends AbstractFutureStub<BareMetalSolutionGrpc.BareMetalSolutionFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > BareMetalSolutionGrpc.BareMetalSolutionFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected BareMetalSolutionGrpc.BareMetalSolutionFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
BareMetalSolutionGrpc.BareMetalSolutionFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createNfsShare(CreateNfsShareRequest request)

public ListenableFuture<Operation> createNfsShare(CreateNfsShareRequest request)

Create an NFS share.

Parameter
Name Description
request CreateNfsShareRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createProvisioningConfig(CreateProvisioningConfigRequest request)

public ListenableFuture<ProvisioningConfig> createProvisioningConfig(CreateProvisioningConfigRequest request)

Create new ProvisioningConfig.

Parameter
Name Description
request CreateProvisioningConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ProvisioningConfig>

createSSHKey(CreateSSHKeyRequest request)

public ListenableFuture<SSHKey> createSSHKey(CreateSSHKeyRequest request)

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

Parameter
Name Description
request CreateSSHKeyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SSHKey>

createVolumeSnapshot(CreateVolumeSnapshotRequest request)

public ListenableFuture<VolumeSnapshot> createVolumeSnapshot(CreateVolumeSnapshotRequest request)

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

Parameter
Name Description
request CreateVolumeSnapshotRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<VolumeSnapshot>

deleteNfsShare(DeleteNfsShareRequest request)

public ListenableFuture<Operation> deleteNfsShare(DeleteNfsShareRequest request)

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

Parameter
Name Description
request DeleteNfsShareRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteSSHKey(DeleteSSHKeyRequest request)

public ListenableFuture<Empty> deleteSSHKey(DeleteSSHKeyRequest request)

Deletes a public SSH key registered in the specified project.

Parameter
Name Description
request DeleteSSHKeyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request)

public ListenableFuture<Empty> deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request)

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

Parameter
Name Description
request DeleteVolumeSnapshotRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

detachLun(DetachLunRequest request)

public ListenableFuture<Operation> detachLun(DetachLunRequest request)

Detach LUN from Instance.

Parameter
Name Description
request DetachLunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

disableInteractiveSerialConsole(DisableInteractiveSerialConsoleRequest request)

public ListenableFuture<Operation> disableInteractiveSerialConsole(DisableInteractiveSerialConsoleRequest request)

Disable the interactive serial console feature on an instance.

Parameter
Name Description
request DisableInteractiveSerialConsoleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

enableInteractiveSerialConsole(EnableInteractiveSerialConsoleRequest request)

public ListenableFuture<Operation> enableInteractiveSerialConsole(EnableInteractiveSerialConsoleRequest request)

Enable the interactive serial console feature on an instance.

Parameter
Name Description
request EnableInteractiveSerialConsoleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

evictLun(EvictLunRequest request)

public ListenableFuture<Operation> evictLun(EvictLunRequest request)

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

Parameter
Name Description
request EvictLunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

evictVolume(EvictVolumeRequest request)

public ListenableFuture<Operation> evictVolume(EvictVolumeRequest request)

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

Parameter
Name Description
request EvictVolumeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getInstance(GetInstanceRequest request)

public ListenableFuture<Instance> getInstance(GetInstanceRequest request)

Get details about a single server.

Parameter
Name Description
request GetInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Instance>

getLun(GetLunRequest request)

public ListenableFuture<Lun> getLun(GetLunRequest request)

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

Parameter
Name Description
request GetLunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Lun>

getNetwork(GetNetworkRequest request)

public ListenableFuture<Network> getNetwork(GetNetworkRequest request)

Get details of a single network.

Parameter
Name Description
request GetNetworkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Network>

getNfsShare(GetNfsShareRequest request)

public ListenableFuture<NfsShare> getNfsShare(GetNfsShareRequest request)

Get details of a single NFS share.

Parameter
Name Description
request GetNfsShareRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<NfsShare>

getProvisioningConfig(GetProvisioningConfigRequest request)

public ListenableFuture<ProvisioningConfig> getProvisioningConfig(GetProvisioningConfigRequest request)

Get ProvisioningConfig by name.

Parameter
Name Description
request GetProvisioningConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ProvisioningConfig>

getVolume(GetVolumeRequest request)

public ListenableFuture<Volume> getVolume(GetVolumeRequest request)

Get details of a single storage volume.

Parameter
Name Description
request GetVolumeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Volume>

getVolumeSnapshot(GetVolumeSnapshotRequest request)

public ListenableFuture<VolumeSnapshot> getVolumeSnapshot(GetVolumeSnapshotRequest request)

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

Parameter
Name Description
request GetVolumeSnapshotRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<VolumeSnapshot>

listInstances(ListInstancesRequest request)

public ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)

List servers in a given project and location.

Parameter
Name Description
request ListInstancesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse>

listLuns(ListLunsRequest request)

public ListenableFuture<ListLunsResponse> listLuns(ListLunsRequest request)

List storage volume luns for given storage volume.

Parameter
Name Description
request ListLunsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListLunsResponse>

listNetworkUsage(ListNetworkUsageRequest request)

public ListenableFuture<ListNetworkUsageResponse> listNetworkUsage(ListNetworkUsageRequest request)

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

Parameter
Name Description
request ListNetworkUsageRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListNetworkUsageResponse>

listNetworks(ListNetworksRequest request)

public ListenableFuture<ListNetworksResponse> listNetworks(ListNetworksRequest request)

List network in a given project and location.

Parameter
Name Description
request ListNetworksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListNetworksResponse>

listNfsShares(ListNfsSharesRequest request)

public ListenableFuture<ListNfsSharesResponse> listNfsShares(ListNfsSharesRequest request)

List NFS shares.

Parameter
Name Description
request ListNfsSharesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListNfsSharesResponse>

listOSImages(ListOSImagesRequest request)

public ListenableFuture<ListOSImagesResponse> listOSImages(ListOSImagesRequest request)

Retrieves the list of OS images which are currently approved.

Parameter
Name Description
request ListOSImagesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListOSImagesResponse>

listProvisioningQuotas(ListProvisioningQuotasRequest request)

public ListenableFuture<ListProvisioningQuotasResponse> listProvisioningQuotas(ListProvisioningQuotasRequest request)

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

Parameter
Name Description
request ListProvisioningQuotasRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListProvisioningQuotasResponse>

listSSHKeys(ListSSHKeysRequest request)

public ListenableFuture<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
Name Description
request ListSSHKeysRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListSSHKeysResponse>

listVolumeSnapshots(ListVolumeSnapshotsRequest request)

public ListenableFuture<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
Name Description
request ListVolumeSnapshotsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListVolumeSnapshotsResponse>

listVolumes(ListVolumesRequest request)

public ListenableFuture<ListVolumesResponse> listVolumes(ListVolumesRequest request)

List storage volumes in a given project and location.

Parameter
Name Description
request ListVolumesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListVolumesResponse>

renameInstance(RenameInstanceRequest request)

public ListenableFuture<Instance> renameInstance(RenameInstanceRequest request)

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

Parameter
Name Description
request RenameInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Instance>

renameNetwork(RenameNetworkRequest request)

public ListenableFuture<Network> renameNetwork(RenameNetworkRequest request)

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

Parameter
Name Description
request RenameNetworkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Network>

renameNfsShare(RenameNfsShareRequest request)

public ListenableFuture<NfsShare> renameNfsShare(RenameNfsShareRequest request)

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

Parameter
Name Description
request RenameNfsShareRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<NfsShare>

renameVolume(RenameVolumeRequest request)

public ListenableFuture<Volume> renameVolume(RenameVolumeRequest request)

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

Parameter
Name Description
request RenameVolumeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Volume>

resetInstance(ResetInstanceRequest request)

public ListenableFuture<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
Name Description
request ResetInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

resizeVolume(ResizeVolumeRequest request)

public ListenableFuture<Operation> resizeVolume(ResizeVolumeRequest request)

Emergency Volume resize.

Parameter
Name Description
request ResizeVolumeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

restoreVolumeSnapshot(RestoreVolumeSnapshotRequest request)

public ListenableFuture<Operation> restoreVolumeSnapshot(RestoreVolumeSnapshotRequest request)

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

Parameter
Name Description
request RestoreVolumeSnapshotRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

startInstance(StartInstanceRequest request)

public ListenableFuture<Operation> startInstance(StartInstanceRequest request)

Starts a server that was shutdown.

Parameter
Name Description
request StartInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

stopInstance(StopInstanceRequest request)

public ListenableFuture<Operation> stopInstance(StopInstanceRequest request)

Stop a running server.

Parameter
Name Description
request StopInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

submitProvisioningConfig(SubmitProvisioningConfigRequest request)

public ListenableFuture<SubmitProvisioningConfigResponse> submitProvisioningConfig(SubmitProvisioningConfigRequest request)

Submit a provisiong configuration for a given project.

Parameter
Name Description
request SubmitProvisioningConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SubmitProvisioningConfigResponse>

updateInstance(UpdateInstanceRequest request)

public ListenableFuture<Operation> updateInstance(UpdateInstanceRequest request)

Update details of a single server.

Parameter
Name Description
request UpdateInstanceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateNetwork(UpdateNetworkRequest request)

public ListenableFuture<Operation> updateNetwork(UpdateNetworkRequest request)

Update details of a single network.

Parameter
Name Description
request UpdateNetworkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateNfsShare(UpdateNfsShareRequest request)

public ListenableFuture<Operation> updateNfsShare(UpdateNfsShareRequest request)

Update details of a single NFS share.

Parameter
Name Description
request UpdateNfsShareRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateProvisioningConfig(UpdateProvisioningConfigRequest request)

public ListenableFuture<ProvisioningConfig> updateProvisioningConfig(UpdateProvisioningConfigRequest request)

Update existing ProvisioningConfig.

Parameter
Name Description
request UpdateProvisioningConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ProvisioningConfig>

updateVolume(UpdateVolumeRequest request)

public ListenableFuture<Operation> updateVolume(UpdateVolumeRequest request)

Update details of a single storage volume.

Parameter
Name Description
request UpdateVolumeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>