Class BareMetalSolutionClient (0.43.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = bareMetalSolutionClient.getInstance(name);
 }
 

Note: close() needs to be called on the BareMetalSolutionClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListInstances

List servers in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInstances(ListInstancesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listInstances(LocationName parent)

  • listInstances(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listInstancesPagedCallable()

  • listInstancesCallable()

GetInstance

Get details about a single server.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getInstance(GetInstanceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getInstance(InstanceName name)

  • getInstance(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getInstanceCallable()

UpdateInstance

Update details of a single server.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateInstanceAsync(UpdateInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateInstanceAsync(Instance instance, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateInstanceOperationCallable()

  • updateInstanceCallable()

RenameInstance

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • renameInstance(RenameInstanceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • renameInstance(InstanceName name, String newInstanceId)

  • renameInstance(String name, String newInstanceId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • renameInstanceCallable()

ResetInstance

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resetInstanceAsync(ResetInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • resetInstanceAsync(InstanceName name)

  • resetInstanceAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resetInstanceOperationCallable()

  • resetInstanceCallable()

StartInstance

Starts a server that was shutdown.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • startInstanceAsync(StartInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • startInstanceAsync(InstanceName name)

  • startInstanceAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • startInstanceOperationCallable()

  • startInstanceCallable()

StopInstance

Stop a running server.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • stopInstanceAsync(StopInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • stopInstanceAsync(InstanceName name)

  • stopInstanceAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • stopInstanceOperationCallable()

  • stopInstanceCallable()

EnableInteractiveSerialConsole

Enable the interactive serial console feature on an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • enableInteractiveSerialConsoleAsync(EnableInteractiveSerialConsoleRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • enableInteractiveSerialConsoleAsync(InstanceName name)

  • enableInteractiveSerialConsoleAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • enableInteractiveSerialConsoleOperationCallable()

  • enableInteractiveSerialConsoleCallable()

DisableInteractiveSerialConsole

Disable the interactive serial console feature on an instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • disableInteractiveSerialConsoleAsync(DisableInteractiveSerialConsoleRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • disableInteractiveSerialConsoleAsync(InstanceName name)

  • disableInteractiveSerialConsoleAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • disableInteractiveSerialConsoleOperationCallable()

  • disableInteractiveSerialConsoleCallable()

DetachLun

Detach LUN from Instance.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • detachLunAsync(DetachLunRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • detachLunAsync(InstanceName instance, LunName lun)

  • detachLunAsync(InstanceName instance, String lun)

  • detachLunAsync(String instance, LunName lun)

  • detachLunAsync(String instance, String lun)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • detachLunOperationCallable()

  • detachLunCallable()

ListSSHKeys

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSSHKeys(ListSSHKeysRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSSHKeys(LocationName parent)

  • listSSHKeys(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSSHKeysPagedCallable()

  • listSSHKeysCallable()

CreateSSHKey

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSSHKey(CreateSSHKeyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createSSHKey(LocationName parent, SSHKey sshKey, String sshKeyId)

  • createSSHKey(String parent, SSHKey sshKey, String sshKeyId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSSHKeyCallable()

DeleteSSHKey

Deletes a public SSH key registered in the specified project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSSHKey(DeleteSSHKeyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteSSHKey(SshKeyName name)

  • deleteSSHKey(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSSHKeyCallable()

ListVolumes

List storage volumes in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listVolumes(ListVolumesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listVolumes(LocationName parent)

  • listVolumes(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listVolumesPagedCallable()

  • listVolumesCallable()

GetVolume

Get details of a single storage volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getVolume(GetVolumeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getVolume(VolumeName name)

  • getVolume(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getVolumeCallable()

UpdateVolume

Update details of a single storage volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateVolumeAsync(UpdateVolumeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateVolumeAsync(Volume volume, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateVolumeOperationCallable()

  • updateVolumeCallable()

RenameVolume

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • renameVolume(RenameVolumeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • renameVolume(VolumeName name, String newVolumeId)

  • renameVolume(String name, String newVolumeId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • renameVolumeCallable()

EvictVolume

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • evictVolumeAsync(EvictVolumeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • evictVolumeAsync(VolumeName name)

  • evictVolumeAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • evictVolumeOperationCallable()

  • evictVolumeCallable()

ResizeVolume

Emergency Volume resize.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resizeVolumeAsync(ResizeVolumeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • resizeVolumeAsync(VolumeName volume, long sizeGib)

  • resizeVolumeAsync(String volume, long sizeGib)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resizeVolumeOperationCallable()

  • resizeVolumeCallable()

ListNetworks

List network in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listNetworks(ListNetworksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listNetworks(LocationName parent)

  • listNetworks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listNetworksPagedCallable()

  • listNetworksCallable()

ListNetworkUsage

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listNetworkUsage(ListNetworkUsageRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listNetworkUsage(LocationName location)

  • listNetworkUsage(String location)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listNetworkUsageCallable()

GetNetwork

Get details of a single network.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getNetwork(GetNetworkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNetwork(NetworkName name)

  • getNetwork(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getNetworkCallable()

UpdateNetwork

Update details of a single network.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateNetworkAsync(UpdateNetworkRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateNetworkAsync(Network network, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateNetworkOperationCallable()

  • updateNetworkCallable()

CreateVolumeSnapshot

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createVolumeSnapshot(CreateVolumeSnapshotRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createVolumeSnapshot(VolumeName parent, VolumeSnapshot volumeSnapshot)

  • createVolumeSnapshot(String parent, VolumeSnapshot volumeSnapshot)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createVolumeSnapshotCallable()

RestoreVolumeSnapshot

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • restoreVolumeSnapshotAsync(RestoreVolumeSnapshotRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • restoreVolumeSnapshotAsync(VolumeSnapshotName volumeSnapshot)

  • restoreVolumeSnapshotAsync(String volumeSnapshot)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • restoreVolumeSnapshotOperationCallable()

  • restoreVolumeSnapshotCallable()

DeleteVolumeSnapshot

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteVolumeSnapshot(VolumeSnapshotName name)

  • deleteVolumeSnapshot(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteVolumeSnapshotCallable()

GetVolumeSnapshot

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getVolumeSnapshot(GetVolumeSnapshotRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getVolumeSnapshot(VolumeSnapshotName name)

  • getVolumeSnapshot(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getVolumeSnapshotCallable()

ListVolumeSnapshots

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listVolumeSnapshots(ListVolumeSnapshotsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listVolumeSnapshots(VolumeName parent)

  • listVolumeSnapshots(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listVolumeSnapshotsPagedCallable()

  • listVolumeSnapshotsCallable()

GetLun

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLun(GetLunRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getLun(LunName name)

  • getLun(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLunCallable()

ListLuns

List storage volume luns for given storage volume.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLuns(ListLunsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listLuns(VolumeName parent)

  • listLuns(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLunsPagedCallable()

  • listLunsCallable()

EvictLun

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • evictLunAsync(EvictLunRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • evictLunAsync(LunName name)

  • evictLunAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • evictLunOperationCallable()

  • evictLunCallable()

GetNfsShare

Get details of a single NFS share.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getNfsShare(GetNfsShareRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNfsShare(NFSShareName name)

  • getNfsShare(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getNfsShareCallable()

ListNfsShares

List NFS shares.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listNfsShares(ListNfsSharesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listNfsShares(LocationName parent)

  • listNfsShares(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listNfsSharesPagedCallable()

  • listNfsSharesCallable()

UpdateNfsShare

Update details of a single NFS share.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateNfsShareAsync(UpdateNfsShareRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateNfsShareAsync(NfsShare nfsShare, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateNfsShareOperationCallable()

  • updateNfsShareCallable()

CreateNfsShare

Create an NFS share.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createNfsShareAsync(CreateNfsShareRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createNfsShareAsync(LocationName parent, NfsShare nfsShare)

  • createNfsShareAsync(String parent, NfsShare nfsShare)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createNfsShareOperationCallable()

  • createNfsShareCallable()

RenameNfsShare

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • renameNfsShare(RenameNfsShareRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • renameNfsShare(NFSShareName name, String newNfsshareId)

  • renameNfsShare(String name, String newNfsshareId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • renameNfsShareCallable()

DeleteNfsShare

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteNfsShareAsync(DeleteNfsShareRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteNfsShareAsync(NFSShareName name)

  • deleteNfsShareAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteNfsShareOperationCallable()

  • deleteNfsShareCallable()

ListProvisioningQuotas

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listProvisioningQuotas(ListProvisioningQuotasRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listProvisioningQuotas(LocationName parent)

  • listProvisioningQuotas(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listProvisioningQuotasPagedCallable()

  • listProvisioningQuotasCallable()

SubmitProvisioningConfig

Submit a provisiong configuration for a given project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • submitProvisioningConfig(SubmitProvisioningConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • submitProvisioningConfig(LocationName parent, ProvisioningConfig provisioningConfig)

  • submitProvisioningConfig(String parent, ProvisioningConfig provisioningConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • submitProvisioningConfigCallable()

GetProvisioningConfig

Get ProvisioningConfig by name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getProvisioningConfig(GetProvisioningConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getProvisioningConfig(ProvisioningConfigName name)

  • getProvisioningConfig(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getProvisioningConfigCallable()

CreateProvisioningConfig

Create new ProvisioningConfig.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createProvisioningConfig(CreateProvisioningConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createProvisioningConfig(LocationName parent, ProvisioningConfig provisioningConfig)

  • createProvisioningConfig(String parent, ProvisioningConfig provisioningConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createProvisioningConfigCallable()

UpdateProvisioningConfig

Update existing ProvisioningConfig.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateProvisioningConfig(UpdateProvisioningConfigRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateProvisioningConfig(ProvisioningConfig provisioningConfig, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateProvisioningConfigCallable()

RenameNetwork

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • renameNetwork(RenameNetworkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • renameNetwork(NetworkName name, String newNetworkId)

  • renameNetwork(String name, String newNetworkId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • renameNetworkCallable()

ListOSImages

Retrieves the list of OS images which are currently approved.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listOSImages(ListOSImagesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listOSImages(LocationName parent)

  • listOSImages(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listOSImagesPagedCallable()

  • listOSImagesCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of BareMetalSolutionSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BareMetalSolutionSettings bareMetalSolutionSettings =
     BareMetalSolutionSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BareMetalSolutionClient bareMetalSolutionClient =
     BareMetalSolutionClient.create(bareMetalSolutionSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BareMetalSolutionSettings bareMetalSolutionSettings =
     BareMetalSolutionSettings.newBuilder().setEndpoint(myEndpoint).build();
 BareMetalSolutionClient bareMetalSolutionClient =
     BareMetalSolutionClient.create(bareMetalSolutionSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BareMetalSolutionSettings bareMetalSolutionSettings =
     BareMetalSolutionSettings.newHttpJsonBuilder().build();
 BareMetalSolutionClient bareMetalSolutionClient =
     BareMetalSolutionClient.create(bareMetalSolutionSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > BareMetalSolutionClient

Static Methods

create()

public static final BareMetalSolutionClient create()

Constructs an instance of BareMetalSolutionClient with default settings.

Returns
Type Description
BareMetalSolutionClient
Exceptions
Type Description
IOException

create(BareMetalSolutionSettings settings)

public static final BareMetalSolutionClient create(BareMetalSolutionSettings settings)

Constructs an instance of BareMetalSolutionClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings BareMetalSolutionSettings
Returns
Type Description
BareMetalSolutionClient
Exceptions
Type Description
IOException

create(BareMetalSolutionStub stub)

public static final BareMetalSolutionClient create(BareMetalSolutionStub stub)

Constructs an instance of BareMetalSolutionClient, using the given stub for making calls. This is for advanced usage - prefer using create(BareMetalSolutionSettings).

Parameter
Name Description
stub BareMetalSolutionStub
Returns
Type Description
BareMetalSolutionClient

Constructors

BareMetalSolutionClient(BareMetalSolutionSettings settings)

protected BareMetalSolutionClient(BareMetalSolutionSettings settings)

Constructs an instance of BareMetalSolutionClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings BareMetalSolutionSettings

BareMetalSolutionClient(BareMetalSolutionStub stub)

protected BareMetalSolutionClient(BareMetalSolutionStub stub)
Parameter
Name Description
stub BareMetalSolutionStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createNfsShareAsync(CreateNfsShareRequest request)

public final OperationFuture<NfsShare,OperationMetadata> createNfsShareAsync(CreateNfsShareRequest request)

Create an NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateNfsShareRequest request =
       CreateNfsShareRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNfsShare(NfsShare.newBuilder().build())
           .build();
   NfsShare response = bareMetalSolutionClient.createNfsShareAsync(request).get();
 }
 
Parameter
Name Description
request CreateNfsShareRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<NfsShare,OperationMetadata>

createNfsShareAsync(LocationName parent, NfsShare nfsShare)

public final OperationFuture<NfsShare,OperationMetadata> createNfsShareAsync(LocationName parent, NfsShare nfsShare)

Create an NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   NfsShare nfsShare = NfsShare.newBuilder().build();
   NfsShare response = bareMetalSolutionClient.createNfsShareAsync(parent, nfsShare).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent project and location.

nfsShare NfsShare

Required. The NfsShare to create.

Returns
Type Description
OperationFuture<NfsShare,OperationMetadata>

createNfsShareAsync(String parent, NfsShare nfsShare)

public final OperationFuture<NfsShare,OperationMetadata> createNfsShareAsync(String parent, NfsShare nfsShare)

Create an NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   NfsShare nfsShare = NfsShare.newBuilder().build();
   NfsShare response = bareMetalSolutionClient.createNfsShareAsync(parent, nfsShare).get();
 }
 
Parameters
Name Description
parent String

Required. The parent project and location.

nfsShare NfsShare

Required. The NfsShare to create.

Returns
Type Description
OperationFuture<NfsShare,OperationMetadata>

createNfsShareCallable()

public final UnaryCallable<CreateNfsShareRequest,Operation> createNfsShareCallable()

Create an NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateNfsShareRequest request =
       CreateNfsShareRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNfsShare(NfsShare.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.createNfsShareCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateNfsShareRequest,Operation>

createNfsShareOperationCallable()

public final OperationCallable<CreateNfsShareRequest,NfsShare,OperationMetadata> createNfsShareOperationCallable()

Create an NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateNfsShareRequest request =
       CreateNfsShareRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNfsShare(NfsShare.newBuilder().build())
           .build();
   OperationFuture<NfsShare, OperationMetadata> future =
       bareMetalSolutionClient.createNfsShareOperationCallable().futureCall(request);
   // Do something.
   NfsShare response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateNfsShareRequest,NfsShare,OperationMetadata>

createProvisioningConfig(CreateProvisioningConfigRequest request)

public final ProvisioningConfig createProvisioningConfig(CreateProvisioningConfigRequest request)

Create new ProvisioningConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateProvisioningConfigRequest request =
       CreateProvisioningConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProvisioningConfig(ProvisioningConfig.newBuilder().build())
           .setEmail("email96619420")
           .build();
   ProvisioningConfig response = bareMetalSolutionClient.createProvisioningConfig(request);
 }
 
Parameter
Name Description
request CreateProvisioningConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ProvisioningConfig

createProvisioningConfig(LocationName parent, ProvisioningConfig provisioningConfig)

public final ProvisioningConfig createProvisioningConfig(LocationName parent, ProvisioningConfig provisioningConfig)

Create new ProvisioningConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProvisioningConfig provisioningConfig = ProvisioningConfig.newBuilder().build();
   ProvisioningConfig response =
       bareMetalSolutionClient.createProvisioningConfig(parent, provisioningConfig);
 }
 
Parameters
Name Description
parent LocationName

Required. The parent project and location containing the ProvisioningConfig.

provisioningConfig ProvisioningConfig

Required. The ProvisioningConfig to create.

Returns
Type Description
ProvisioningConfig

createProvisioningConfig(String parent, ProvisioningConfig provisioningConfig)

public final ProvisioningConfig createProvisioningConfig(String parent, ProvisioningConfig provisioningConfig)

Create new ProvisioningConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ProvisioningConfig provisioningConfig = ProvisioningConfig.newBuilder().build();
   ProvisioningConfig response =
       bareMetalSolutionClient.createProvisioningConfig(parent, provisioningConfig);
 }
 
Parameters
Name Description
parent String

Required. The parent project and location containing the ProvisioningConfig.

provisioningConfig ProvisioningConfig

Required. The ProvisioningConfig to create.

Returns
Type Description
ProvisioningConfig

createProvisioningConfigCallable()

public final UnaryCallable<CreateProvisioningConfigRequest,ProvisioningConfig> createProvisioningConfigCallable()

Create new ProvisioningConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateProvisioningConfigRequest request =
       CreateProvisioningConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProvisioningConfig(ProvisioningConfig.newBuilder().build())
           .setEmail("email96619420")
           .build();
   ApiFuture<ProvisioningConfig> future =
       bareMetalSolutionClient.createProvisioningConfigCallable().futureCall(request);
   // Do something.
   ProvisioningConfig response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateProvisioningConfigRequest,ProvisioningConfig>

createSSHKey(CreateSSHKeyRequest request)

public final SSHKey createSSHKey(CreateSSHKeyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateSSHKeyRequest request =
       CreateSSHKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSshKey(SSHKey.newBuilder().build())
           .setSshKeyId("sshKeyId593257138")
           .build();
   SSHKey response = bareMetalSolutionClient.createSSHKey(request);
 }
 
Parameter
Name Description
request CreateSSHKeyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SSHKey

createSSHKey(LocationName parent, SSHKey sshKey, String sshKeyId)

public final SSHKey createSSHKey(LocationName parent, SSHKey sshKey, String sshKeyId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SSHKey sshKey = SSHKey.newBuilder().build();
   String sshKeyId = "sshKeyId593257138";
   SSHKey response = bareMetalSolutionClient.createSSHKey(parent, sshKey, sshKeyId);
 }
 
Parameters
Name Description
parent LocationName

Required. The parent containing the SSH keys.

sshKey SSHKey

Required. The SSH key to register.

sshKeyId String

Required. The ID to use for the key, which will become the final component of the key's resource name.

This value must match the regex: [a-zA-Z0-9@.-_]{1,64}

Returns
Type Description
SSHKey

createSSHKey(String parent, SSHKey sshKey, String sshKeyId)

public final SSHKey createSSHKey(String parent, SSHKey sshKey, String sshKeyId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   SSHKey sshKey = SSHKey.newBuilder().build();
   String sshKeyId = "sshKeyId593257138";
   SSHKey response = bareMetalSolutionClient.createSSHKey(parent, sshKey, sshKeyId);
 }
 
Parameters
Name Description
parent String

Required. The parent containing the SSH keys.

sshKey SSHKey

Required. The SSH key to register.

sshKeyId String

Required. The ID to use for the key, which will become the final component of the key's resource name.

This value must match the regex: [a-zA-Z0-9@.-_]{1,64}

Returns
Type Description
SSHKey

createSSHKeyCallable()

public final UnaryCallable<CreateSSHKeyRequest,SSHKey> createSSHKeyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateSSHKeyRequest request =
       CreateSSHKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSshKey(SSHKey.newBuilder().build())
           .setSshKeyId("sshKeyId593257138")
           .build();
   ApiFuture<SSHKey> future = bareMetalSolutionClient.createSSHKeyCallable().futureCall(request);
   // Do something.
   SSHKey response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateSSHKeyRequest,SSHKey>

createVolumeSnapshot(CreateVolumeSnapshotRequest request)

public final VolumeSnapshot createVolumeSnapshot(CreateVolumeSnapshotRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateVolumeSnapshotRequest request =
       CreateVolumeSnapshotRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setVolumeSnapshot(VolumeSnapshot.newBuilder().build())
           .build();
   VolumeSnapshot response = bareMetalSolutionClient.createVolumeSnapshot(request);
 }
 
Parameter
Name Description
request CreateVolumeSnapshotRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VolumeSnapshot

createVolumeSnapshot(VolumeName parent, VolumeSnapshot volumeSnapshot)

public final VolumeSnapshot createVolumeSnapshot(VolumeName parent, VolumeSnapshot volumeSnapshot)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeName parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   VolumeSnapshot volumeSnapshot = VolumeSnapshot.newBuilder().build();
   VolumeSnapshot response =
       bareMetalSolutionClient.createVolumeSnapshot(parent, volumeSnapshot);
 }
 
Parameters
Name Description
parent VolumeName

Required. The volume to snapshot.

volumeSnapshot VolumeSnapshot

Required. The snapshot to create.

Returns
Type Description
VolumeSnapshot

createVolumeSnapshot(String parent, VolumeSnapshot volumeSnapshot)

public final VolumeSnapshot createVolumeSnapshot(String parent, VolumeSnapshot volumeSnapshot)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   VolumeSnapshot volumeSnapshot = VolumeSnapshot.newBuilder().build();
   VolumeSnapshot response =
       bareMetalSolutionClient.createVolumeSnapshot(parent, volumeSnapshot);
 }
 
Parameters
Name Description
parent String

Required. The volume to snapshot.

volumeSnapshot VolumeSnapshot

Required. The snapshot to create.

Returns
Type Description
VolumeSnapshot

createVolumeSnapshotCallable()

public final UnaryCallable<CreateVolumeSnapshotRequest,VolumeSnapshot> createVolumeSnapshotCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   CreateVolumeSnapshotRequest request =
       CreateVolumeSnapshotRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setVolumeSnapshot(VolumeSnapshot.newBuilder().build())
           .build();
   ApiFuture<VolumeSnapshot> future =
       bareMetalSolutionClient.createVolumeSnapshotCallable().futureCall(request);
   // Do something.
   VolumeSnapshot response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateVolumeSnapshotRequest,VolumeSnapshot>

deleteNfsShareAsync(DeleteNfsShareRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteNfsShareAsync(DeleteNfsShareRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DeleteNfsShareRequest request =
       DeleteNfsShareRequest.newBuilder()
           .setName(NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString())
           .build();
   bareMetalSolutionClient.deleteNfsShareAsync(request).get();
 }
 
Parameter
Name Description
request DeleteNfsShareRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNfsShareAsync(NFSShareName name)

public final OperationFuture<Empty,OperationMetadata> deleteNfsShareAsync(NFSShareName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   NFSShareName name = NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]");
   bareMetalSolutionClient.deleteNfsShareAsync(name).get();
 }
 
Parameter
Name Description
name NFSShareName

Required. The name of the NFS share to delete.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNfsShareAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteNfsShareAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString();
   bareMetalSolutionClient.deleteNfsShareAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The name of the NFS share to delete.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteNfsShareCallable()

public final UnaryCallable<DeleteNfsShareRequest,Operation> deleteNfsShareCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DeleteNfsShareRequest request =
       DeleteNfsShareRequest.newBuilder()
           .setName(NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.deleteNfsShareCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteNfsShareRequest,Operation>

deleteNfsShareOperationCallable()

public final OperationCallable<DeleteNfsShareRequest,Empty,OperationMetadata> deleteNfsShareOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DeleteNfsShareRequest request =
       DeleteNfsShareRequest.newBuilder()
           .setName(NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       bareMetalSolutionClient.deleteNfsShareOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteNfsShareRequest,Empty,OperationMetadata>

deleteSSHKey(DeleteSSHKeyRequest request)

public final void deleteSSHKey(DeleteSSHKeyRequest request)

Deletes a public SSH key registered in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DeleteSSHKeyRequest request =
       DeleteSSHKeyRequest.newBuilder()
           .setName(SshKeyName.of("[PROJECT]", "[LOCATION]", "[SSH_KEY]").toString())
           .build();
   bareMetalSolutionClient.deleteSSHKey(request);
 }
 
Parameter
Name Description
request DeleteSSHKeyRequest

The request object containing all of the parameters for the API call.

deleteSSHKey(SshKeyName name)

public final void deleteSSHKey(SshKeyName name)

Deletes a public SSH key registered in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   SshKeyName name = SshKeyName.of("[PROJECT]", "[LOCATION]", "[SSH_KEY]");
   bareMetalSolutionClient.deleteSSHKey(name);
 }
 
Parameter
Name Description
name SshKeyName

Required. The name of the SSH key to delete. Currently, the only valid value for the location is "global".

deleteSSHKey(String name)

public final void deleteSSHKey(String name)

Deletes a public SSH key registered in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = SshKeyName.of("[PROJECT]", "[LOCATION]", "[SSH_KEY]").toString();
   bareMetalSolutionClient.deleteSSHKey(name);
 }
 
Parameter
Name Description
name String

Required. The name of the SSH key to delete. Currently, the only valid value for the location is "global".

deleteSSHKeyCallable()

public final UnaryCallable<DeleteSSHKeyRequest,Empty> deleteSSHKeyCallable()

Deletes a public SSH key registered in the specified project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DeleteSSHKeyRequest request =
       DeleteSSHKeyRequest.newBuilder()
           .setName(SshKeyName.of("[PROJECT]", "[LOCATION]", "[SSH_KEY]").toString())
           .build();
   ApiFuture<Empty> future = bareMetalSolutionClient.deleteSSHKeyCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteSSHKeyRequest,Empty>

deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request)

public final void deleteVolumeSnapshot(DeleteVolumeSnapshotRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DeleteVolumeSnapshotRequest request =
       DeleteVolumeSnapshotRequest.newBuilder()
           .setName(
               VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]")
                   .toString())
           .build();
   bareMetalSolutionClient.deleteVolumeSnapshot(request);
 }
 
Parameter
Name Description
request DeleteVolumeSnapshotRequest

The request object containing all of the parameters for the API call.

deleteVolumeSnapshot(VolumeSnapshotName name)

public final void deleteVolumeSnapshot(VolumeSnapshotName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeSnapshotName name =
       VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]");
   bareMetalSolutionClient.deleteVolumeSnapshot(name);
 }
 
Parameter
Name Description
name VolumeSnapshotName

Required. The name of the snapshot to delete.

deleteVolumeSnapshot(String name)

public final void deleteVolumeSnapshot(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name =
       VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString();
   bareMetalSolutionClient.deleteVolumeSnapshot(name);
 }
 
Parameter
Name Description
name String

Required. The name of the snapshot to delete.

deleteVolumeSnapshotCallable()

public final UnaryCallable<DeleteVolumeSnapshotRequest,Empty> deleteVolumeSnapshotCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DeleteVolumeSnapshotRequest request =
       DeleteVolumeSnapshotRequest.newBuilder()
           .setName(
               VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       bareMetalSolutionClient.deleteVolumeSnapshotCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteVolumeSnapshotRequest,Empty>

detachLunAsync(DetachLunRequest request)

public final OperationFuture<Instance,OperationMetadata> detachLunAsync(DetachLunRequest request)

Detach LUN from Instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DetachLunRequest request =
       DetachLunRequest.newBuilder()
           .setInstance(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setLun(LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString())
           .setSkipReboot(true)
           .build();
   Instance response = bareMetalSolutionClient.detachLunAsync(request).get();
 }
 
Parameter
Name Description
request DetachLunRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

detachLunAsync(InstanceName instance, LunName lun)

public final OperationFuture<Instance,OperationMetadata> detachLunAsync(InstanceName instance, LunName lun)

Detach LUN from Instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName instance = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   LunName lun = LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]");
   Instance response = bareMetalSolutionClient.detachLunAsync(instance, lun).get();
 }
 
Parameters
Name Description
instance InstanceName

Required. Name of the instance.

lun LunName

Required. Name of the Lun to detach.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

detachLunAsync(InstanceName instance, String lun)

public final OperationFuture<Instance,OperationMetadata> detachLunAsync(InstanceName instance, String lun)

Detach LUN from Instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName instance = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   String lun = LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString();
   Instance response = bareMetalSolutionClient.detachLunAsync(instance, lun).get();
 }
 
Parameters
Name Description
instance InstanceName

Required. Name of the instance.

lun String

Required. Name of the Lun to detach.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

detachLunAsync(String instance, LunName lun)

public final OperationFuture<Instance,OperationMetadata> detachLunAsync(String instance, LunName lun)

Detach LUN from Instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String instance = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   LunName lun = LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]");
   Instance response = bareMetalSolutionClient.detachLunAsync(instance, lun).get();
 }
 
Parameters
Name Description
instance String

Required. Name of the instance.

lun LunName

Required. Name of the Lun to detach.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

detachLunAsync(String instance, String lun)

public final OperationFuture<Instance,OperationMetadata> detachLunAsync(String instance, String lun)

Detach LUN from Instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String instance = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   String lun = LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString();
   Instance response = bareMetalSolutionClient.detachLunAsync(instance, lun).get();
 }
 
Parameters
Name Description
instance String

Required. Name of the instance.

lun String

Required. Name of the Lun to detach.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

detachLunCallable()

public final UnaryCallable<DetachLunRequest,Operation> detachLunCallable()

Detach LUN from Instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DetachLunRequest request =
       DetachLunRequest.newBuilder()
           .setInstance(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setLun(LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString())
           .setSkipReboot(true)
           .build();
   ApiFuture<Operation> future = bareMetalSolutionClient.detachLunCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<DetachLunRequest,Operation>

detachLunOperationCallable()

public final OperationCallable<DetachLunRequest,Instance,OperationMetadata> detachLunOperationCallable()

Detach LUN from Instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DetachLunRequest request =
       DetachLunRequest.newBuilder()
           .setInstance(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setLun(LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString())
           .setSkipReboot(true)
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       bareMetalSolutionClient.detachLunOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
OperationCallable<DetachLunRequest,Instance,OperationMetadata>

disableInteractiveSerialConsoleAsync(DisableInteractiveSerialConsoleRequest request)

public final OperationFuture<DisableInteractiveSerialConsoleResponse,OperationMetadata> disableInteractiveSerialConsoleAsync(DisableInteractiveSerialConsoleRequest request)

Disable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DisableInteractiveSerialConsoleRequest request =
       DisableInteractiveSerialConsoleRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   DisableInteractiveSerialConsoleResponse response =
       bareMetalSolutionClient.disableInteractiveSerialConsoleAsync(request).get();
 }
 
Parameter
Name Description
request DisableInteractiveSerialConsoleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<DisableInteractiveSerialConsoleResponse,OperationMetadata>

disableInteractiveSerialConsoleAsync(InstanceName name)

public final OperationFuture<DisableInteractiveSerialConsoleResponse,OperationMetadata> disableInteractiveSerialConsoleAsync(InstanceName name)

Disable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   DisableInteractiveSerialConsoleResponse response =
       bareMetalSolutionClient.disableInteractiveSerialConsoleAsync(name).get();
 }
 
Parameter
Name Description
name InstanceName

Required. Name of the resource.

Returns
Type Description
OperationFuture<DisableInteractiveSerialConsoleResponse,OperationMetadata>

disableInteractiveSerialConsoleAsync(String name)

public final OperationFuture<DisableInteractiveSerialConsoleResponse,OperationMetadata> disableInteractiveSerialConsoleAsync(String name)

Disable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   DisableInteractiveSerialConsoleResponse response =
       bareMetalSolutionClient.disableInteractiveSerialConsoleAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
OperationFuture<DisableInteractiveSerialConsoleResponse,OperationMetadata>

disableInteractiveSerialConsoleCallable()

public final UnaryCallable<DisableInteractiveSerialConsoleRequest,Operation> disableInteractiveSerialConsoleCallable()

Disable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DisableInteractiveSerialConsoleRequest request =
       DisableInteractiveSerialConsoleRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.disableInteractiveSerialConsoleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<DisableInteractiveSerialConsoleRequest,Operation>

disableInteractiveSerialConsoleOperationCallable()

public final OperationCallable<DisableInteractiveSerialConsoleRequest,DisableInteractiveSerialConsoleResponse,OperationMetadata> disableInteractiveSerialConsoleOperationCallable()

Disable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   DisableInteractiveSerialConsoleRequest request =
       DisableInteractiveSerialConsoleRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   OperationFuture<DisableInteractiveSerialConsoleResponse, OperationMetadata> future =
       bareMetalSolutionClient
           .disableInteractiveSerialConsoleOperationCallable()
           .futureCall(request);
   // Do something.
   DisableInteractiveSerialConsoleResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<DisableInteractiveSerialConsoleRequest,DisableInteractiveSerialConsoleResponse,OperationMetadata>

enableInteractiveSerialConsoleAsync(EnableInteractiveSerialConsoleRequest request)

public final OperationFuture<EnableInteractiveSerialConsoleResponse,OperationMetadata> enableInteractiveSerialConsoleAsync(EnableInteractiveSerialConsoleRequest request)

Enable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EnableInteractiveSerialConsoleRequest request =
       EnableInteractiveSerialConsoleRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   EnableInteractiveSerialConsoleResponse response =
       bareMetalSolutionClient.enableInteractiveSerialConsoleAsync(request).get();
 }
 
Parameter
Name Description
request EnableInteractiveSerialConsoleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<EnableInteractiveSerialConsoleResponse,OperationMetadata>

enableInteractiveSerialConsoleAsync(InstanceName name)

public final OperationFuture<EnableInteractiveSerialConsoleResponse,OperationMetadata> enableInteractiveSerialConsoleAsync(InstanceName name)

Enable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   EnableInteractiveSerialConsoleResponse response =
       bareMetalSolutionClient.enableInteractiveSerialConsoleAsync(name).get();
 }
 
Parameter
Name Description
name InstanceName

Required. Name of the resource.

Returns
Type Description
OperationFuture<EnableInteractiveSerialConsoleResponse,OperationMetadata>

enableInteractiveSerialConsoleAsync(String name)

public final OperationFuture<EnableInteractiveSerialConsoleResponse,OperationMetadata> enableInteractiveSerialConsoleAsync(String name)

Enable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   EnableInteractiveSerialConsoleResponse response =
       bareMetalSolutionClient.enableInteractiveSerialConsoleAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
OperationFuture<EnableInteractiveSerialConsoleResponse,OperationMetadata>

enableInteractiveSerialConsoleCallable()

public final UnaryCallable<EnableInteractiveSerialConsoleRequest,Operation> enableInteractiveSerialConsoleCallable()

Enable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EnableInteractiveSerialConsoleRequest request =
       EnableInteractiveSerialConsoleRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.enableInteractiveSerialConsoleCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<EnableInteractiveSerialConsoleRequest,Operation>

enableInteractiveSerialConsoleOperationCallable()

public final OperationCallable<EnableInteractiveSerialConsoleRequest,EnableInteractiveSerialConsoleResponse,OperationMetadata> enableInteractiveSerialConsoleOperationCallable()

Enable the interactive serial console feature on an instance.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EnableInteractiveSerialConsoleRequest request =
       EnableInteractiveSerialConsoleRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   OperationFuture<EnableInteractiveSerialConsoleResponse, OperationMetadata> future =
       bareMetalSolutionClient
           .enableInteractiveSerialConsoleOperationCallable()
           .futureCall(request);
   // Do something.
   EnableInteractiveSerialConsoleResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<EnableInteractiveSerialConsoleRequest,EnableInteractiveSerialConsoleResponse,OperationMetadata>

evictLunAsync(EvictLunRequest request)

public final OperationFuture<Empty,OperationMetadata> evictLunAsync(EvictLunRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EvictLunRequest request =
       EvictLunRequest.newBuilder()
           .setName(LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString())
           .build();
   bareMetalSolutionClient.evictLunAsync(request).get();
 }
 
Parameter
Name Description
request EvictLunRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

evictLunAsync(LunName name)

public final OperationFuture<Empty,OperationMetadata> evictLunAsync(LunName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LunName name = LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]");
   bareMetalSolutionClient.evictLunAsync(name).get();
 }
 
Parameter
Name Description
name LunName

Required. The name of the lun.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

evictLunAsync(String name)

public final OperationFuture<Empty,OperationMetadata> evictLunAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString();
   bareMetalSolutionClient.evictLunAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The name of the lun.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

evictLunCallable()

public final UnaryCallable<EvictLunRequest,Operation> evictLunCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EvictLunRequest request =
       EvictLunRequest.newBuilder()
           .setName(LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString())
           .build();
   ApiFuture<Operation> future = bareMetalSolutionClient.evictLunCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<EvictLunRequest,Operation>

evictLunOperationCallable()

public final OperationCallable<EvictLunRequest,Empty,OperationMetadata> evictLunOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EvictLunRequest request =
       EvictLunRequest.newBuilder()
           .setName(LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       bareMetalSolutionClient.evictLunOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<EvictLunRequest,Empty,OperationMetadata>

evictVolumeAsync(EvictVolumeRequest request)

public final OperationFuture<Empty,OperationMetadata> evictVolumeAsync(EvictVolumeRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EvictVolumeRequest request =
       EvictVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .build();
   bareMetalSolutionClient.evictVolumeAsync(request).get();
 }
 
Parameter
Name Description
request EvictVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

evictVolumeAsync(VolumeName name)

public final OperationFuture<Empty,OperationMetadata> evictVolumeAsync(VolumeName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeName name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   bareMetalSolutionClient.evictVolumeAsync(name).get();
 }
 
Parameter
Name Description
name VolumeName

Required. The name of the Volume.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

evictVolumeAsync(String name)

public final OperationFuture<Empty,OperationMetadata> evictVolumeAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   bareMetalSolutionClient.evictVolumeAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The name of the Volume.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

evictVolumeCallable()

public final UnaryCallable<EvictVolumeRequest,Operation> evictVolumeCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EvictVolumeRequest request =
       EvictVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.evictVolumeCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<EvictVolumeRequest,Operation>

evictVolumeOperationCallable()

public final OperationCallable<EvictVolumeRequest,Empty,OperationMetadata> evictVolumeOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   EvictVolumeRequest request =
       EvictVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       bareMetalSolutionClient.evictVolumeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<EvictVolumeRequest,Empty,OperationMetadata>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getInstance(GetInstanceRequest request)

public final Instance getInstance(GetInstanceRequest request)

Get details about a single server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = bareMetalSolutionClient.getInstance(request);
 }
 
Parameter
Name Description
request GetInstanceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Instance

getInstance(InstanceName name)

public final Instance getInstance(InstanceName name)

Get details about a single server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = bareMetalSolutionClient.getInstance(name);
 }
 
Parameter
Name Description
name InstanceName

Required. Name of the resource.

Returns
Type Description
Instance

getInstance(String name)

public final Instance getInstance(String name)

Get details about a single server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = bareMetalSolutionClient.getInstance(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
Instance

getInstanceCallable()

public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()

Get details about a single server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Instance> future =
       bareMetalSolutionClient.getInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetInstanceRequest,Instance>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = bareMetalSolutionClient.getLocation(request);
 }
 
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       bareMetalSolutionClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getLun(GetLunRequest request)

public final Lun getLun(GetLunRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetLunRequest request =
       GetLunRequest.newBuilder()
           .setName(LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString())
           .build();
   Lun response = bareMetalSolutionClient.getLun(request);
 }
 
Parameter
Name Description
request GetLunRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Lun

getLun(LunName name)

public final Lun getLun(LunName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LunName name = LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]");
   Lun response = bareMetalSolutionClient.getLun(name);
 }
 
Parameter
Name Description
name LunName

Required. Name of the resource.

Returns
Type Description
Lun

getLun(String name)

public final Lun getLun(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString();
   Lun response = bareMetalSolutionClient.getLun(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
Lun

getLunCallable()

public final UnaryCallable<GetLunRequest,Lun> getLunCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetLunRequest request =
       GetLunRequest.newBuilder()
           .setName(LunName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[LUN]").toString())
           .build();
   ApiFuture<Lun> future = bareMetalSolutionClient.getLunCallable().futureCall(request);
   // Do something.
   Lun response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetLunRequest,Lun>

getNetwork(GetNetworkRequest request)

public final Network getNetwork(GetNetworkRequest request)

Get details of a single network.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetNetworkRequest request =
       GetNetworkRequest.newBuilder()
           .setName(NetworkName.of("[PROJECT]", "[LOCATION]", "[NETWORK]").toString())
           .build();
   Network response = bareMetalSolutionClient.getNetwork(request);
 }
 
Parameter
Name Description
request GetNetworkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Network

getNetwork(NetworkName name)

public final Network getNetwork(NetworkName name)

Get details of a single network.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   NetworkName name = NetworkName.of("[PROJECT]", "[LOCATION]", "[NETWORK]");
   Network response = bareMetalSolutionClient.getNetwork(name);
 }
 
Parameter
Name Description
name NetworkName

Required. Name of the resource.

Returns
Type Description
Network

getNetwork(String name)

public final Network getNetwork(String name)

Get details of a single network.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = NetworkName.of("[PROJECT]", "[LOCATION]", "[NETWORK]").toString();
   Network response = bareMetalSolutionClient.getNetwork(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
Network

getNetworkCallable()

public final UnaryCallable<GetNetworkRequest,Network> getNetworkCallable()

Get details of a single network.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetNetworkRequest request =
       GetNetworkRequest.newBuilder()
           .setName(NetworkName.of("[PROJECT]", "[LOCATION]", "[NETWORK]").toString())
           .build();
   ApiFuture<Network> future = bareMetalSolutionClient.getNetworkCallable().futureCall(request);
   // Do something.
   Network response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetNetworkRequest,Network>

getNfsShare(GetNfsShareRequest request)

public final NfsShare getNfsShare(GetNfsShareRequest request)

Get details of a single NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetNfsShareRequest request =
       GetNfsShareRequest.newBuilder()
           .setName(NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString())
           .build();
   NfsShare response = bareMetalSolutionClient.getNfsShare(request);
 }
 
Parameter
Name Description
request GetNfsShareRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NfsShare

getNfsShare(NFSShareName name)

public final NfsShare getNfsShare(NFSShareName name)

Get details of a single NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   NFSShareName name = NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]");
   NfsShare response = bareMetalSolutionClient.getNfsShare(name);
 }
 
Parameter
Name Description
name NFSShareName

Required. Name of the resource.

Returns
Type Description
NfsShare

getNfsShare(String name)

public final NfsShare getNfsShare(String name)

Get details of a single NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString();
   NfsShare response = bareMetalSolutionClient.getNfsShare(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
NfsShare

getNfsShareCallable()

public final UnaryCallable<GetNfsShareRequest,NfsShare> getNfsShareCallable()

Get details of a single NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetNfsShareRequest request =
       GetNfsShareRequest.newBuilder()
           .setName(NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString())
           .build();
   ApiFuture<NfsShare> future =
       bareMetalSolutionClient.getNfsShareCallable().futureCall(request);
   // Do something.
   NfsShare response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetNfsShareRequest,NfsShare>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getProvisioningConfig(GetProvisioningConfigRequest request)

public final ProvisioningConfig getProvisioningConfig(GetProvisioningConfigRequest request)

Get ProvisioningConfig by name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetProvisioningConfigRequest request =
       GetProvisioningConfigRequest.newBuilder()
           .setName(
               ProvisioningConfigName.of("[PROJECT]", "[LOCATION]", "[PROVISIONING_CONFIG]")
                   .toString())
           .build();
   ProvisioningConfig response = bareMetalSolutionClient.getProvisioningConfig(request);
 }
 
Parameter
Name Description
request GetProvisioningConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ProvisioningConfig

getProvisioningConfig(ProvisioningConfigName name)

public final ProvisioningConfig getProvisioningConfig(ProvisioningConfigName name)

Get ProvisioningConfig by name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ProvisioningConfigName name =
       ProvisioningConfigName.of("[PROJECT]", "[LOCATION]", "[PROVISIONING_CONFIG]");
   ProvisioningConfig response = bareMetalSolutionClient.getProvisioningConfig(name);
 }
 
Parameter
Name Description
name ProvisioningConfigName

Required. Name of the ProvisioningConfig.

Returns
Type Description
ProvisioningConfig

getProvisioningConfig(String name)

public final ProvisioningConfig getProvisioningConfig(String name)

Get ProvisioningConfig by name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name =
       ProvisioningConfigName.of("[PROJECT]", "[LOCATION]", "[PROVISIONING_CONFIG]").toString();
   ProvisioningConfig response = bareMetalSolutionClient.getProvisioningConfig(name);
 }
 
Parameter
Name Description
name String

Required. Name of the ProvisioningConfig.

Returns
Type Description
ProvisioningConfig

getProvisioningConfigCallable()

public final UnaryCallable<GetProvisioningConfigRequest,ProvisioningConfig> getProvisioningConfigCallable()

Get ProvisioningConfig by name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetProvisioningConfigRequest request =
       GetProvisioningConfigRequest.newBuilder()
           .setName(
               ProvisioningConfigName.of("[PROJECT]", "[LOCATION]", "[PROVISIONING_CONFIG]")
                   .toString())
           .build();
   ApiFuture<ProvisioningConfig> future =
       bareMetalSolutionClient.getProvisioningConfigCallable().futureCall(request);
   // Do something.
   ProvisioningConfig response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetProvisioningConfigRequest,ProvisioningConfig>

getSettings()

public final BareMetalSolutionSettings getSettings()
Returns
Type Description
BareMetalSolutionSettings

getStub()

public BareMetalSolutionStub getStub()
Returns
Type Description
BareMetalSolutionStub

getVolume(GetVolumeRequest request)

public final Volume getVolume(GetVolumeRequest request)

Get details of a single storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetVolumeRequest request =
       GetVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .build();
   Volume response = bareMetalSolutionClient.getVolume(request);
 }
 
Parameter
Name Description
request GetVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Volume

getVolume(VolumeName name)

public final Volume getVolume(VolumeName name)

Get details of a single storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeName name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   Volume response = bareMetalSolutionClient.getVolume(name);
 }
 
Parameter
Name Description
name VolumeName

Required. Name of the resource.

Returns
Type Description
Volume

getVolume(String name)

public final Volume getVolume(String name)

Get details of a single storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   Volume response = bareMetalSolutionClient.getVolume(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
Volume

getVolumeCallable()

public final UnaryCallable<GetVolumeRequest,Volume> getVolumeCallable()

Get details of a single storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetVolumeRequest request =
       GetVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .build();
   ApiFuture<Volume> future = bareMetalSolutionClient.getVolumeCallable().futureCall(request);
   // Do something.
   Volume response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetVolumeRequest,Volume>

getVolumeSnapshot(GetVolumeSnapshotRequest request)

public final VolumeSnapshot getVolumeSnapshot(GetVolumeSnapshotRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetVolumeSnapshotRequest request =
       GetVolumeSnapshotRequest.newBuilder()
           .setName(
               VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]")
                   .toString())
           .build();
   VolumeSnapshot response = bareMetalSolutionClient.getVolumeSnapshot(request);
 }
 
Parameter
Name Description
request GetVolumeSnapshotRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
VolumeSnapshot

getVolumeSnapshot(VolumeSnapshotName name)

public final VolumeSnapshot getVolumeSnapshot(VolumeSnapshotName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeSnapshotName name =
       VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]");
   VolumeSnapshot response = bareMetalSolutionClient.getVolumeSnapshot(name);
 }
 
Parameter
Name Description
name VolumeSnapshotName

Required. The name of the snapshot.

Returns
Type Description
VolumeSnapshot

getVolumeSnapshot(String name)

public final VolumeSnapshot getVolumeSnapshot(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name =
       VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString();
   VolumeSnapshot response = bareMetalSolutionClient.getVolumeSnapshot(name);
 }
 
Parameter
Name Description
name String

Required. The name of the snapshot.

Returns
Type Description
VolumeSnapshot

getVolumeSnapshotCallable()

public final UnaryCallable<GetVolumeSnapshotRequest,VolumeSnapshot> getVolumeSnapshotCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   GetVolumeSnapshotRequest request =
       GetVolumeSnapshotRequest.newBuilder()
           .setName(
               VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]")
                   .toString())
           .build();
   ApiFuture<VolumeSnapshot> future =
       bareMetalSolutionClient.getVolumeSnapshotCallable().futureCall(request);
   // Do something.
   VolumeSnapshot response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetVolumeSnapshotRequest,VolumeSnapshot>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listInstances(ListInstancesRequest request)

public final BareMetalSolutionClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)

List servers in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Instance element : bareMetalSolutionClient.listInstances(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListInstancesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListInstancesPagedResponse

listInstances(LocationName parent)

public final BareMetalSolutionClient.ListInstancesPagedResponse listInstances(LocationName parent)

List servers in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Instance element : bareMetalSolutionClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListInstancesRequest.

Returns
Type Description
BareMetalSolutionClient.ListInstancesPagedResponse

listInstances(String parent)

public final BareMetalSolutionClient.ListInstancesPagedResponse listInstances(String parent)

List servers in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Instance element : bareMetalSolutionClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListInstancesRequest.

Returns
Type Description
BareMetalSolutionClient.ListInstancesPagedResponse

listInstancesCallable()

public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()

List servers in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListInstancesResponse response =
         bareMetalSolutionClient.listInstancesCallable().call(request);
     for (Instance element : response.getInstancesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListInstancesRequest,ListInstancesResponse>

listInstancesPagedCallable()

public final UnaryCallable<ListInstancesRequest,BareMetalSolutionClient.ListInstancesPagedResponse> listInstancesPagedCallable()

List servers in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Instance> future =
       bareMetalSolutionClient.listInstancesPagedCallable().futureCall(request);
   // Do something.
   for (Instance element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse>

listLocations(ListLocationsRequest request)

public final BareMetalSolutionClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : bareMetalSolutionClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         bareMetalSolutionClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,BareMetalSolutionClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       bareMetalSolutionClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listLuns(ListLunsRequest request)

public final BareMetalSolutionClient.ListLunsPagedResponse listLuns(ListLunsRequest request)

List storage volume luns for given storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListLunsRequest request =
       ListLunsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Lun element : bareMetalSolutionClient.listLuns(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListLunsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListLunsPagedResponse

listLuns(VolumeName parent)

public final BareMetalSolutionClient.ListLunsPagedResponse listLuns(VolumeName parent)

List storage volume luns for given storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeName parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   for (Lun element : bareMetalSolutionClient.listLuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent VolumeName

Required. Parent value for ListLunsRequest.

Returns
Type Description
BareMetalSolutionClient.ListLunsPagedResponse

listLuns(String parent)

public final BareMetalSolutionClient.ListLunsPagedResponse listLuns(String parent)

List storage volume luns for given storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   for (Lun element : bareMetalSolutionClient.listLuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListLunsRequest.

Returns
Type Description
BareMetalSolutionClient.ListLunsPagedResponse

listLunsCallable()

public final UnaryCallable<ListLunsRequest,ListLunsResponse> listLunsCallable()

List storage volume luns for given storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListLunsRequest request =
       ListLunsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLunsResponse response = bareMetalSolutionClient.listLunsCallable().call(request);
     for (Lun element : response.getLunsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListLunsRequest,ListLunsResponse>

listLunsPagedCallable()

public final UnaryCallable<ListLunsRequest,BareMetalSolutionClient.ListLunsPagedResponse> listLunsPagedCallable()

List storage volume luns for given storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListLunsRequest request =
       ListLunsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Lun> future = bareMetalSolutionClient.listLunsPagedCallable().futureCall(request);
   // Do something.
   for (Lun element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListLunsRequest,ListLunsPagedResponse>

listNetworkUsage(ListNetworkUsageRequest request)

public final ListNetworkUsageResponse listNetworkUsage(ListNetworkUsageRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListNetworkUsageRequest request =
       ListNetworkUsageRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ListNetworkUsageResponse response = bareMetalSolutionClient.listNetworkUsage(request);
 }
 
Parameter
Name Description
request ListNetworkUsageRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ListNetworkUsageResponse

listNetworkUsage(LocationName location)

public final ListNetworkUsageResponse listNetworkUsage(LocationName location)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
   ListNetworkUsageResponse response = bareMetalSolutionClient.listNetworkUsage(location);
 }
 
Parameter
Name Description
location LocationName

Required. Parent value (project and location).

Returns
Type Description
ListNetworkUsageResponse

listNetworkUsage(String location)

public final ListNetworkUsageResponse listNetworkUsage(String location)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ListNetworkUsageResponse response = bareMetalSolutionClient.listNetworkUsage(location);
 }
 
Parameter
Name Description
location String

Required. Parent value (project and location).

Returns
Type Description
ListNetworkUsageResponse

listNetworkUsageCallable()

public final UnaryCallable<ListNetworkUsageRequest,ListNetworkUsageResponse> listNetworkUsageCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListNetworkUsageRequest request =
       ListNetworkUsageRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<ListNetworkUsageResponse> future =
       bareMetalSolutionClient.listNetworkUsageCallable().futureCall(request);
   // Do something.
   ListNetworkUsageResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ListNetworkUsageRequest,ListNetworkUsageResponse>

listNetworks(ListNetworksRequest request)

public final BareMetalSolutionClient.ListNetworksPagedResponse listNetworks(ListNetworksRequest request)

List network in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListNetworksRequest request =
       ListNetworksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Network element : bareMetalSolutionClient.listNetworks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListNetworksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListNetworksPagedResponse

listNetworks(LocationName parent)

public final BareMetalSolutionClient.ListNetworksPagedResponse listNetworks(LocationName parent)

List network in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Network element : bareMetalSolutionClient.listNetworks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListNetworksRequest.

Returns
Type Description
BareMetalSolutionClient.ListNetworksPagedResponse

listNetworks(String parent)

public final BareMetalSolutionClient.ListNetworksPagedResponse listNetworks(String parent)

List network in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Network element : bareMetalSolutionClient.listNetworks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListNetworksRequest.

Returns
Type Description
BareMetalSolutionClient.ListNetworksPagedResponse

listNetworksCallable()

public final UnaryCallable<ListNetworksRequest,ListNetworksResponse> listNetworksCallable()

List network in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListNetworksRequest request =
       ListNetworksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListNetworksResponse response =
         bareMetalSolutionClient.listNetworksCallable().call(request);
     for (Network element : response.getNetworksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListNetworksRequest,ListNetworksResponse>

listNetworksPagedCallable()

public final UnaryCallable<ListNetworksRequest,BareMetalSolutionClient.ListNetworksPagedResponse> listNetworksPagedCallable()

List network in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListNetworksRequest request =
       ListNetworksRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Network> future =
       bareMetalSolutionClient.listNetworksPagedCallable().futureCall(request);
   // Do something.
   for (Network element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListNetworksRequest,ListNetworksPagedResponse>

listNfsShares(ListNfsSharesRequest request)

public final BareMetalSolutionClient.ListNfsSharesPagedResponse listNfsShares(ListNfsSharesRequest request)

List NFS shares.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListNfsSharesRequest request =
       ListNfsSharesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (NfsShare element : bareMetalSolutionClient.listNfsShares(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListNfsSharesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListNfsSharesPagedResponse

listNfsShares(LocationName parent)

public final BareMetalSolutionClient.ListNfsSharesPagedResponse listNfsShares(LocationName parent)

List NFS shares.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (NfsShare element : bareMetalSolutionClient.listNfsShares(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListNfsSharesRequest.

Returns
Type Description
BareMetalSolutionClient.ListNfsSharesPagedResponse

listNfsShares(String parent)

public final BareMetalSolutionClient.ListNfsSharesPagedResponse listNfsShares(String parent)

List NFS shares.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (NfsShare element : bareMetalSolutionClient.listNfsShares(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListNfsSharesRequest.

Returns
Type Description
BareMetalSolutionClient.ListNfsSharesPagedResponse

listNfsSharesCallable()

public final UnaryCallable<ListNfsSharesRequest,ListNfsSharesResponse> listNfsSharesCallable()

List NFS shares.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListNfsSharesRequest request =
       ListNfsSharesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListNfsSharesResponse response =
         bareMetalSolutionClient.listNfsSharesCallable().call(request);
     for (NfsShare element : response.getNfsSharesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListNfsSharesRequest,ListNfsSharesResponse>

listNfsSharesPagedCallable()

public final UnaryCallable<ListNfsSharesRequest,BareMetalSolutionClient.ListNfsSharesPagedResponse> listNfsSharesPagedCallable()

List NFS shares.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListNfsSharesRequest request =
       ListNfsSharesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<NfsShare> future =
       bareMetalSolutionClient.listNfsSharesPagedCallable().futureCall(request);
   // Do something.
   for (NfsShare element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListNfsSharesRequest,ListNfsSharesPagedResponse>

listOSImages(ListOSImagesRequest request)

public final BareMetalSolutionClient.ListOSImagesPagedResponse listOSImages(ListOSImagesRequest request)

Retrieves the list of OS images which are currently approved.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListOSImagesRequest request =
       ListOSImagesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (OSImage element : bareMetalSolutionClient.listOSImages(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListOSImagesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListOSImagesPagedResponse

listOSImages(LocationName parent)

public final BareMetalSolutionClient.ListOSImagesPagedResponse listOSImages(LocationName parent)

Retrieves the list of OS images which are currently approved.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (OSImage element : bareMetalSolutionClient.listOSImages(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListProvisioningQuotasRequest.

Returns
Type Description
BareMetalSolutionClient.ListOSImagesPagedResponse

listOSImages(String parent)

public final BareMetalSolutionClient.ListOSImagesPagedResponse listOSImages(String parent)

Retrieves the list of OS images which are currently approved.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (OSImage element : bareMetalSolutionClient.listOSImages(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListProvisioningQuotasRequest.

Returns
Type Description
BareMetalSolutionClient.ListOSImagesPagedResponse

listOSImagesCallable()

public final UnaryCallable<ListOSImagesRequest,ListOSImagesResponse> listOSImagesCallable()

Retrieves the list of OS images which are currently approved.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListOSImagesRequest request =
       ListOSImagesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListOSImagesResponse response =
         bareMetalSolutionClient.listOSImagesCallable().call(request);
     for (OSImage element : response.getOsImagesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListOSImagesRequest,ListOSImagesResponse>

listOSImagesPagedCallable()

public final UnaryCallable<ListOSImagesRequest,BareMetalSolutionClient.ListOSImagesPagedResponse> listOSImagesPagedCallable()

Retrieves the list of OS images which are currently approved.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListOSImagesRequest request =
       ListOSImagesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<OSImage> future =
       bareMetalSolutionClient.listOSImagesPagedCallable().futureCall(request);
   // Do something.
   for (OSImage element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListOSImagesRequest,ListOSImagesPagedResponse>

listProvisioningQuotas(ListProvisioningQuotasRequest request)

public final BareMetalSolutionClient.ListProvisioningQuotasPagedResponse listProvisioningQuotas(ListProvisioningQuotasRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListProvisioningQuotasRequest request =
       ListProvisioningQuotasRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ProvisioningQuota element :
       bareMetalSolutionClient.listProvisioningQuotas(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListProvisioningQuotasRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListProvisioningQuotasPagedResponse

listProvisioningQuotas(LocationName parent)

public final BareMetalSolutionClient.ListProvisioningQuotasPagedResponse listProvisioningQuotas(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ProvisioningQuota element :
       bareMetalSolutionClient.listProvisioningQuotas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListProvisioningQuotasRequest.

Returns
Type Description
BareMetalSolutionClient.ListProvisioningQuotasPagedResponse

listProvisioningQuotas(String parent)

public final BareMetalSolutionClient.ListProvisioningQuotasPagedResponse listProvisioningQuotas(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ProvisioningQuota element :
       bareMetalSolutionClient.listProvisioningQuotas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListProvisioningQuotasRequest.

Returns
Type Description
BareMetalSolutionClient.ListProvisioningQuotasPagedResponse

listProvisioningQuotasCallable()

public final UnaryCallable<ListProvisioningQuotasRequest,ListProvisioningQuotasResponse> listProvisioningQuotasCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListProvisioningQuotasRequest request =
       ListProvisioningQuotasRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListProvisioningQuotasResponse response =
         bareMetalSolutionClient.listProvisioningQuotasCallable().call(request);
     for (ProvisioningQuota element : response.getProvisioningQuotasList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListProvisioningQuotasRequest,ListProvisioningQuotasResponse>

listProvisioningQuotasPagedCallable()

public final UnaryCallable<ListProvisioningQuotasRequest,BareMetalSolutionClient.ListProvisioningQuotasPagedResponse> listProvisioningQuotasPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListProvisioningQuotasRequest request =
       ListProvisioningQuotasRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ProvisioningQuota> future =
       bareMetalSolutionClient.listProvisioningQuotasPagedCallable().futureCall(request);
   // Do something.
   for (ProvisioningQuota element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListProvisioningQuotasRequest,ListProvisioningQuotasPagedResponse>

listSSHKeys(ListSSHKeysRequest request)

public final BareMetalSolutionClient.ListSSHKeysPagedResponse 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListSSHKeysRequest request =
       ListSSHKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SSHKey element : bareMetalSolutionClient.listSSHKeys(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListSSHKeysRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListSSHKeysPagedResponse

listSSHKeys(LocationName parent)

public final BareMetalSolutionClient.ListSSHKeysPagedResponse listSSHKeys(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (SSHKey element : bareMetalSolutionClient.listSSHKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The parent containing the SSH keys. Currently, the only valid value for the location is "global".

Returns
Type Description
BareMetalSolutionClient.ListSSHKeysPagedResponse

listSSHKeys(String parent)

public final BareMetalSolutionClient.ListSSHKeysPagedResponse listSSHKeys(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (SSHKey element : bareMetalSolutionClient.listSSHKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent containing the SSH keys. Currently, the only valid value for the location is "global".

Returns
Type Description
BareMetalSolutionClient.ListSSHKeysPagedResponse

listSSHKeysCallable()

public final UnaryCallable<ListSSHKeysRequest,ListSSHKeysResponse> listSSHKeysCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListSSHKeysRequest request =
       ListSSHKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSSHKeysResponse response = bareMetalSolutionClient.listSSHKeysCallable().call(request);
     for (SSHKey element : response.getSshKeysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListSSHKeysRequest,ListSSHKeysResponse>

listSSHKeysPagedCallable()

public final UnaryCallable<ListSSHKeysRequest,BareMetalSolutionClient.ListSSHKeysPagedResponse> listSSHKeysPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListSSHKeysRequest request =
       ListSSHKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SSHKey> future =
       bareMetalSolutionClient.listSSHKeysPagedCallable().futureCall(request);
   // Do something.
   for (SSHKey element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListSSHKeysRequest,ListSSHKeysPagedResponse>

listVolumeSnapshots(ListVolumeSnapshotsRequest request)

public final BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListVolumeSnapshotsRequest request =
       ListVolumeSnapshotsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (VolumeSnapshot element :
       bareMetalSolutionClient.listVolumeSnapshots(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListVolumeSnapshotsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse

listVolumeSnapshots(VolumeName parent)

public final BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse listVolumeSnapshots(VolumeName parent)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeName parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   for (VolumeSnapshot element :
       bareMetalSolutionClient.listVolumeSnapshots(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent VolumeName

Required. Parent value for ListVolumesRequest.

Returns
Type Description
BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse

listVolumeSnapshots(String parent)

public final BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse listVolumeSnapshots(String parent)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   for (VolumeSnapshot element :
       bareMetalSolutionClient.listVolumeSnapshots(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListVolumesRequest.

Returns
Type Description
BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse

listVolumeSnapshotsCallable()

public final UnaryCallable<ListVolumeSnapshotsRequest,ListVolumeSnapshotsResponse> listVolumeSnapshotsCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListVolumeSnapshotsRequest request =
       ListVolumeSnapshotsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListVolumeSnapshotsResponse response =
         bareMetalSolutionClient.listVolumeSnapshotsCallable().call(request);
     for (VolumeSnapshot element : response.getVolumeSnapshotsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListVolumeSnapshotsRequest,ListVolumeSnapshotsResponse>

listVolumeSnapshotsPagedCallable()

public final UnaryCallable<ListVolumeSnapshotsRequest,BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse> listVolumeSnapshotsPagedCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListVolumeSnapshotsRequest request =
       ListVolumeSnapshotsRequest.newBuilder()
           .setParent(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<VolumeSnapshot> future =
       bareMetalSolutionClient.listVolumeSnapshotsPagedCallable().futureCall(request);
   // Do something.
   for (VolumeSnapshot element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListVolumeSnapshotsRequest,ListVolumeSnapshotsPagedResponse>

listVolumes(ListVolumesRequest request)

public final BareMetalSolutionClient.ListVolumesPagedResponse listVolumes(ListVolumesRequest request)

List storage volumes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListVolumesRequest request =
       ListVolumesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Volume element : bareMetalSolutionClient.listVolumes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListVolumesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BareMetalSolutionClient.ListVolumesPagedResponse

listVolumes(LocationName parent)

public final BareMetalSolutionClient.ListVolumesPagedResponse listVolumes(LocationName parent)

List storage volumes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Volume element : bareMetalSolutionClient.listVolumes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. Parent value for ListVolumesRequest.

Returns
Type Description
BareMetalSolutionClient.ListVolumesPagedResponse

listVolumes(String parent)

public final BareMetalSolutionClient.ListVolumesPagedResponse listVolumes(String parent)

List storage volumes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Volume element : bareMetalSolutionClient.listVolumes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Parent value for ListVolumesRequest.

Returns
Type Description
BareMetalSolutionClient.ListVolumesPagedResponse

listVolumesCallable()

public final UnaryCallable<ListVolumesRequest,ListVolumesResponse> listVolumesCallable()

List storage volumes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListVolumesRequest request =
       ListVolumesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListVolumesResponse response = bareMetalSolutionClient.listVolumesCallable().call(request);
     for (Volume element : response.getVolumesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListVolumesRequest,ListVolumesResponse>

listVolumesPagedCallable()

public final UnaryCallable<ListVolumesRequest,BareMetalSolutionClient.ListVolumesPagedResponse> listVolumesPagedCallable()

List storage volumes in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ListVolumesRequest request =
       ListVolumesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Volume> future =
       bareMetalSolutionClient.listVolumesPagedCallable().futureCall(request);
   // Do something.
   for (Volume element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListVolumesRequest,ListVolumesPagedResponse>

renameInstance(InstanceName name, String newInstanceId)

public final Instance renameInstance(InstanceName name, String newInstanceId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   String newInstanceId = "newInstanceId1749535312";
   Instance response = bareMetalSolutionClient.renameInstance(name, newInstanceId);
 }
 
Parameters
Name Description
name InstanceName

Required. The name field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}

newInstanceId String

Required. The new id of the instance.

Returns
Type Description
Instance

renameInstance(RenameInstanceRequest request)

public final Instance renameInstance(RenameInstanceRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RenameInstanceRequest request =
       RenameInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setNewInstanceId("newInstanceId1749535312")
           .build();
   Instance response = bareMetalSolutionClient.renameInstance(request);
 }
 
Parameter
Name Description
request RenameInstanceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Instance

renameInstance(String name, String newInstanceId)

public final Instance renameInstance(String name, String newInstanceId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   String newInstanceId = "newInstanceId1749535312";
   Instance response = bareMetalSolutionClient.renameInstance(name, newInstanceId);
 }
 
Parameters
Name Description
name String

Required. The name field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}

newInstanceId String

Required. The new id of the instance.

Returns
Type Description
Instance

renameInstanceCallable()

public final UnaryCallable<RenameInstanceRequest,Instance> renameInstanceCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RenameInstanceRequest request =
       RenameInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setNewInstanceId("newInstanceId1749535312")
           .build();
   ApiFuture<Instance> future =
       bareMetalSolutionClient.renameInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RenameInstanceRequest,Instance>

renameNetwork(NetworkName name, String newNetworkId)

public final Network renameNetwork(NetworkName name, String newNetworkId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   NetworkName name = NetworkName.of("[PROJECT]", "[LOCATION]", "[NETWORK]");
   String newNetworkId = "newNetworkId-1927751127";
   Network response = bareMetalSolutionClient.renameNetwork(name, newNetworkId);
 }
 
Parameters
Name Description
name NetworkName

Required. The name field is used to identify the network. Format: projects/{project}/locations/{location}/networks/{network}

newNetworkId String

Required. The new id of the network.

Returns
Type Description
Network

renameNetwork(RenameNetworkRequest request)

public final Network renameNetwork(RenameNetworkRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RenameNetworkRequest request =
       RenameNetworkRequest.newBuilder()
           .setName(NetworkName.of("[PROJECT]", "[LOCATION]", "[NETWORK]").toString())
           .setNewNetworkId("newNetworkId-1927751127")
           .build();
   Network response = bareMetalSolutionClient.renameNetwork(request);
 }
 
Parameter
Name Description
request RenameNetworkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Network

renameNetwork(String name, String newNetworkId)

public final Network renameNetwork(String name, String newNetworkId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = NetworkName.of("[PROJECT]", "[LOCATION]", "[NETWORK]").toString();
   String newNetworkId = "newNetworkId-1927751127";
   Network response = bareMetalSolutionClient.renameNetwork(name, newNetworkId);
 }
 
Parameters
Name Description
name String

Required. The name field is used to identify the network. Format: projects/{project}/locations/{location}/networks/{network}

newNetworkId String

Required. The new id of the network.

Returns
Type Description
Network

renameNetworkCallable()

public final UnaryCallable<RenameNetworkRequest,Network> renameNetworkCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RenameNetworkRequest request =
       RenameNetworkRequest.newBuilder()
           .setName(NetworkName.of("[PROJECT]", "[LOCATION]", "[NETWORK]").toString())
           .setNewNetworkId("newNetworkId-1927751127")
           .build();
   ApiFuture<Network> future =
       bareMetalSolutionClient.renameNetworkCallable().futureCall(request);
   // Do something.
   Network response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RenameNetworkRequest,Network>

renameNfsShare(NFSShareName name, String newNfsshareId)

public final NfsShare renameNfsShare(NFSShareName name, String newNfsshareId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   NFSShareName name = NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]");
   String newNfsshareId = "newNfsshareId1643043071";
   NfsShare response = bareMetalSolutionClient.renameNfsShare(name, newNfsshareId);
 }
 
Parameters
Name Description
name NFSShareName

Required. The name field is used to identify the nfsshare. Format: projects/{project}/locations/{location}/nfsshares/{nfsshare}

newNfsshareId String

Required. The new id of the nfsshare.

Returns
Type Description
NfsShare

renameNfsShare(RenameNfsShareRequest request)

public final NfsShare renameNfsShare(RenameNfsShareRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RenameNfsShareRequest request =
       RenameNfsShareRequest.newBuilder()
           .setName(NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString())
           .setNewNfsshareId("newNfsshareId1643043071")
           .build();
   NfsShare response = bareMetalSolutionClient.renameNfsShare(request);
 }
 
Parameter
Name Description
request RenameNfsShareRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
NfsShare

renameNfsShare(String name, String newNfsshareId)

public final NfsShare renameNfsShare(String name, String newNfsshareId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString();
   String newNfsshareId = "newNfsshareId1643043071";
   NfsShare response = bareMetalSolutionClient.renameNfsShare(name, newNfsshareId);
 }
 
Parameters
Name Description
name String

Required. The name field is used to identify the nfsshare. Format: projects/{project}/locations/{location}/nfsshares/{nfsshare}

newNfsshareId String

Required. The new id of the nfsshare.

Returns
Type Description
NfsShare

renameNfsShareCallable()

public final UnaryCallable<RenameNfsShareRequest,NfsShare> renameNfsShareCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RenameNfsShareRequest request =
       RenameNfsShareRequest.newBuilder()
           .setName(NFSShareName.of("[PROJECT]", "[LOCATION]", "[NFS_SHARE]").toString())
           .setNewNfsshareId("newNfsshareId1643043071")
           .build();
   ApiFuture<NfsShare> future =
       bareMetalSolutionClient.renameNfsShareCallable().futureCall(request);
   // Do something.
   NfsShare response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RenameNfsShareRequest,NfsShare>

renameVolume(RenameVolumeRequest request)

public final Volume renameVolume(RenameVolumeRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RenameVolumeRequest request =
       RenameVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setNewVolumeId("newVolumeId-613023851")
           .build();
   Volume response = bareMetalSolutionClient.renameVolume(request);
 }
 
Parameter
Name Description
request RenameVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Volume

renameVolume(VolumeName name, String newVolumeId)

public final Volume renameVolume(VolumeName name, String newVolumeId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeName name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   String newVolumeId = "newVolumeId-613023851";
   Volume response = bareMetalSolutionClient.renameVolume(name, newVolumeId);
 }
 
Parameters
Name Description
name VolumeName

Required. The name field is used to identify the volume. Format: projects/{project}/locations/{location}/volumes/{volume}

newVolumeId String

Required. The new id of the volume.

Returns
Type Description
Volume

renameVolume(String name, String newVolumeId)

public final Volume renameVolume(String name, String newVolumeId)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   String newVolumeId = "newVolumeId-613023851";
   Volume response = bareMetalSolutionClient.renameVolume(name, newVolumeId);
 }
 
Parameters
Name Description
name String

Required. The name field is used to identify the volume. Format: projects/{project}/locations/{location}/volumes/{volume}

newVolumeId String

Required. The new id of the volume.

Returns
Type Description
Volume

renameVolumeCallable()

public final UnaryCallable<RenameVolumeRequest,Volume> renameVolumeCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RenameVolumeRequest request =
       RenameVolumeRequest.newBuilder()
           .setName(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setNewVolumeId("newVolumeId-613023851")
           .build();
   ApiFuture<Volume> future = bareMetalSolutionClient.renameVolumeCallable().futureCall(request);
   // Do something.
   Volume response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RenameVolumeRequest,Volume>

resetInstanceAsync(InstanceName name)

public final OperationFuture<ResetInstanceResponse,OperationMetadata> resetInstanceAsync(InstanceName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   ResetInstanceResponse response = bareMetalSolutionClient.resetInstanceAsync(name).get();
 }
 
Parameter
Name Description
name InstanceName

Required. Name of the resource.

Returns
Type Description
OperationFuture<ResetInstanceResponse,OperationMetadata>

resetInstanceAsync(ResetInstanceRequest request)

public final OperationFuture<ResetInstanceResponse,OperationMetadata> resetInstanceAsync(ResetInstanceRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ResetInstanceRequest request =
       ResetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ResetInstanceResponse response = bareMetalSolutionClient.resetInstanceAsync(request).get();
 }
 
Parameter
Name Description
request ResetInstanceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ResetInstanceResponse,OperationMetadata>

resetInstanceAsync(String name)

public final OperationFuture<ResetInstanceResponse,OperationMetadata> resetInstanceAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   ResetInstanceResponse response = bareMetalSolutionClient.resetInstanceAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
OperationFuture<ResetInstanceResponse,OperationMetadata>

resetInstanceCallable()

public final UnaryCallable<ResetInstanceRequest,Operation> resetInstanceCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ResetInstanceRequest request =
       ResetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.resetInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ResetInstanceRequest,Operation>

resetInstanceOperationCallable()

public final OperationCallable<ResetInstanceRequest,ResetInstanceResponse,OperationMetadata> resetInstanceOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ResetInstanceRequest request =
       ResetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   OperationFuture<ResetInstanceResponse, OperationMetadata> future =
       bareMetalSolutionClient.resetInstanceOperationCallable().futureCall(request);
   // Do something.
   ResetInstanceResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ResetInstanceRequest,ResetInstanceResponse,OperationMetadata>

resizeVolumeAsync(ResizeVolumeRequest request)

public final OperationFuture<Volume,OperationMetadata> resizeVolumeAsync(ResizeVolumeRequest request)

Emergency Volume resize.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ResizeVolumeRequest request =
       ResizeVolumeRequest.newBuilder()
           .setVolume(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSizeGib(847296130)
           .build();
   Volume response = bareMetalSolutionClient.resizeVolumeAsync(request).get();
 }
 
Parameter
Name Description
request ResizeVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

resizeVolumeAsync(VolumeName volume, long sizeGib)

public final OperationFuture<Volume,OperationMetadata> resizeVolumeAsync(VolumeName volume, long sizeGib)

Emergency Volume resize.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeName volume = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]");
   long sizeGib = 847296130;
   Volume response = bareMetalSolutionClient.resizeVolumeAsync(volume, sizeGib).get();
 }
 
Parameters
Name Description
volume VolumeName

Required. Volume to resize.

sizeGib long

New Volume size, in GiB.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

resizeVolumeAsync(String volume, long sizeGib)

public final OperationFuture<Volume,OperationMetadata> resizeVolumeAsync(String volume, long sizeGib)

Emergency Volume resize.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String volume = VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString();
   long sizeGib = 847296130;
   Volume response = bareMetalSolutionClient.resizeVolumeAsync(volume, sizeGib).get();
 }
 
Parameters
Name Description
volume String

Required. Volume to resize.

sizeGib long

New Volume size, in GiB.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

resizeVolumeCallable()

public final UnaryCallable<ResizeVolumeRequest,Operation> resizeVolumeCallable()

Emergency Volume resize.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ResizeVolumeRequest request =
       ResizeVolumeRequest.newBuilder()
           .setVolume(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSizeGib(847296130)
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.resizeVolumeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ResizeVolumeRequest,Operation>

resizeVolumeOperationCallable()

public final OperationCallable<ResizeVolumeRequest,Volume,OperationMetadata> resizeVolumeOperationCallable()

Emergency Volume resize.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ResizeVolumeRequest request =
       ResizeVolumeRequest.newBuilder()
           .setVolume(VolumeName.of("[PROJECT]", "[LOCATION]", "[VOLUME]").toString())
           .setSizeGib(847296130)
           .build();
   OperationFuture<Volume, OperationMetadata> future =
       bareMetalSolutionClient.resizeVolumeOperationCallable().futureCall(request);
   // Do something.
   Volume response = future.get();
 }
 
Returns
Type Description
OperationCallable<ResizeVolumeRequest,Volume,OperationMetadata>

restoreVolumeSnapshotAsync(RestoreVolumeSnapshotRequest request)

public final OperationFuture<VolumeSnapshot,OperationMetadata> restoreVolumeSnapshotAsync(RestoreVolumeSnapshotRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RestoreVolumeSnapshotRequest request =
       RestoreVolumeSnapshotRequest.newBuilder()
           .setVolumeSnapshot(
               VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]")
                   .toString())
           .build();
   VolumeSnapshot response = bareMetalSolutionClient.restoreVolumeSnapshotAsync(request).get();
 }
 
Parameter
Name Description
request RestoreVolumeSnapshotRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<VolumeSnapshot,OperationMetadata>

restoreVolumeSnapshotAsync(VolumeSnapshotName volumeSnapshot)

public final OperationFuture<VolumeSnapshot,OperationMetadata> restoreVolumeSnapshotAsync(VolumeSnapshotName volumeSnapshot)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   VolumeSnapshotName volumeSnapshot =
       VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]");
   VolumeSnapshot response =
       bareMetalSolutionClient.restoreVolumeSnapshotAsync(volumeSnapshot).get();
 }
 
Parameter
Name Description
volumeSnapshot VolumeSnapshotName

Required. Name of the snapshot which will be used to restore its parent volume.

Returns
Type Description
OperationFuture<VolumeSnapshot,OperationMetadata>

restoreVolumeSnapshotAsync(String volumeSnapshot)

public final OperationFuture<VolumeSnapshot,OperationMetadata> restoreVolumeSnapshotAsync(String volumeSnapshot)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String volumeSnapshot =
       VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]").toString();
   VolumeSnapshot response =
       bareMetalSolutionClient.restoreVolumeSnapshotAsync(volumeSnapshot).get();
 }
 
Parameter
Name Description
volumeSnapshot String

Required. Name of the snapshot which will be used to restore its parent volume.

Returns
Type Description
OperationFuture<VolumeSnapshot,OperationMetadata>

restoreVolumeSnapshotCallable()

public final UnaryCallable<RestoreVolumeSnapshotRequest,Operation> restoreVolumeSnapshotCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RestoreVolumeSnapshotRequest request =
       RestoreVolumeSnapshotRequest.newBuilder()
           .setVolumeSnapshot(
               VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.restoreVolumeSnapshotCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RestoreVolumeSnapshotRequest,Operation>

restoreVolumeSnapshotOperationCallable()

public final OperationCallable<RestoreVolumeSnapshotRequest,VolumeSnapshot,OperationMetadata> restoreVolumeSnapshotOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   RestoreVolumeSnapshotRequest request =
       RestoreVolumeSnapshotRequest.newBuilder()
           .setVolumeSnapshot(
               VolumeSnapshotName.of("[PROJECT]", "[LOCATION]", "[VOLUME]", "[SNAPSHOT]")
                   .toString())
           .build();
   OperationFuture<VolumeSnapshot, OperationMetadata> future =
       bareMetalSolutionClient.restoreVolumeSnapshotOperationCallable().futureCall(request);
   // Do something.
   VolumeSnapshot response = future.get();
 }
 
Returns
Type Description
OperationCallable<RestoreVolumeSnapshotRequest,VolumeSnapshot,OperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

startInstanceAsync(InstanceName name)

public final OperationFuture<StartInstanceResponse,OperationMetadata> startInstanceAsync(InstanceName name)

Starts a server that was shutdown.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   StartInstanceResponse response = bareMetalSolutionClient.startInstanceAsync(name).get();
 }
 
Parameter
Name Description
name InstanceName

Required. Name of the resource.

Returns
Type Description
OperationFuture<StartInstanceResponse,OperationMetadata>

startInstanceAsync(StartInstanceRequest request)

public final OperationFuture<StartInstanceResponse,OperationMetadata> startInstanceAsync(StartInstanceRequest request)

Starts a server that was shutdown.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   StartInstanceRequest request =
       StartInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   StartInstanceResponse response = bareMetalSolutionClient.startInstanceAsync(request).get();
 }
 
Parameter
Name Description
request StartInstanceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<StartInstanceResponse,OperationMetadata>

startInstanceAsync(String name)

public final OperationFuture<StartInstanceResponse,OperationMetadata> startInstanceAsync(String name)

Starts a server that was shutdown.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   StartInstanceResponse response = bareMetalSolutionClient.startInstanceAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
OperationFuture<StartInstanceResponse,OperationMetadata>

startInstanceCallable()

public final UnaryCallable<StartInstanceRequest,Operation> startInstanceCallable()

Starts a server that was shutdown.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   StartInstanceRequest request =
       StartInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.startInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<StartInstanceRequest,Operation>

startInstanceOperationCallable()

public final OperationCallable<StartInstanceRequest,StartInstanceResponse,OperationMetadata> startInstanceOperationCallable()

Starts a server that was shutdown.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   StartInstanceRequest request =
       StartInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   OperationFuture<StartInstanceResponse, OperationMetadata> future =
       bareMetalSolutionClient.startInstanceOperationCallable().futureCall(request);
   // Do something.
   StartInstanceResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<StartInstanceRequest,StartInstanceResponse,OperationMetadata>

stopInstanceAsync(InstanceName name)

public final OperationFuture<StopInstanceResponse,OperationMetadata> stopInstanceAsync(InstanceName name)

Stop a running server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   StopInstanceResponse response = bareMetalSolutionClient.stopInstanceAsync(name).get();
 }
 
Parameter
Name Description
name InstanceName

Required. Name of the resource.

Returns
Type Description
OperationFuture<StopInstanceResponse,OperationMetadata>

stopInstanceAsync(StopInstanceRequest request)

public final OperationFuture<StopInstanceResponse,OperationMetadata> stopInstanceAsync(StopInstanceRequest request)

Stop a running server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   StopInstanceRequest request =
       StopInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   StopInstanceResponse response = bareMetalSolutionClient.stopInstanceAsync(request).get();
 }
 
Parameter
Name Description
request StopInstanceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<StopInstanceResponse,OperationMetadata>

stopInstanceAsync(String name)

public final OperationFuture<StopInstanceResponse,OperationMetadata> stopInstanceAsync(String name)

Stop a running server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   StopInstanceResponse response = bareMetalSolutionClient.stopInstanceAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource.

Returns
Type Description
OperationFuture<StopInstanceResponse,OperationMetadata>

stopInstanceCallable()

public final UnaryCallable<StopInstanceRequest,Operation> stopInstanceCallable()

Stop a running server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   StopInstanceRequest request =
       StopInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.stopInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<StopInstanceRequest,Operation>

stopInstanceOperationCallable()

public final OperationCallable<StopInstanceRequest,StopInstanceResponse,OperationMetadata> stopInstanceOperationCallable()

Stop a running server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   StopInstanceRequest request =
       StopInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   OperationFuture<StopInstanceResponse, OperationMetadata> future =
       bareMetalSolutionClient.stopInstanceOperationCallable().futureCall(request);
   // Do something.
   StopInstanceResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<StopInstanceRequest,StopInstanceResponse,OperationMetadata>

submitProvisioningConfig(LocationName parent, ProvisioningConfig provisioningConfig)

public final SubmitProvisioningConfigResponse submitProvisioningConfig(LocationName parent, ProvisioningConfig provisioningConfig)

Submit a provisiong configuration for a given project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProvisioningConfig provisioningConfig = ProvisioningConfig.newBuilder().build();
   SubmitProvisioningConfigResponse response =
       bareMetalSolutionClient.submitProvisioningConfig(parent, provisioningConfig);
 }
 
Parameters
Name Description
parent LocationName

Required. The parent project and location containing the ProvisioningConfig.

provisioningConfig ProvisioningConfig

Required. The ProvisioningConfig to create.

Returns
Type Description
SubmitProvisioningConfigResponse

submitProvisioningConfig(SubmitProvisioningConfigRequest request)

public final SubmitProvisioningConfigResponse submitProvisioningConfig(SubmitProvisioningConfigRequest request)

Submit a provisiong configuration for a given project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   SubmitProvisioningConfigRequest request =
       SubmitProvisioningConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProvisioningConfig(ProvisioningConfig.newBuilder().build())
           .setEmail("email96619420")
           .build();
   SubmitProvisioningConfigResponse response =
       bareMetalSolutionClient.submitProvisioningConfig(request);
 }
 
Parameter
Name Description
request SubmitProvisioningConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SubmitProvisioningConfigResponse

submitProvisioningConfig(String parent, ProvisioningConfig provisioningConfig)

public final SubmitProvisioningConfigResponse submitProvisioningConfig(String parent, ProvisioningConfig provisioningConfig)

Submit a provisiong configuration for a given project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ProvisioningConfig provisioningConfig = ProvisioningConfig.newBuilder().build();
   SubmitProvisioningConfigResponse response =
       bareMetalSolutionClient.submitProvisioningConfig(parent, provisioningConfig);
 }
 
Parameters
Name Description
parent String

Required. The parent project and location containing the ProvisioningConfig.

provisioningConfig ProvisioningConfig

Required. The ProvisioningConfig to create.

Returns
Type Description
SubmitProvisioningConfigResponse

submitProvisioningConfigCallable()

public final UnaryCallable<SubmitProvisioningConfigRequest,SubmitProvisioningConfigResponse> submitProvisioningConfigCallable()

Submit a provisiong configuration for a given project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   SubmitProvisioningConfigRequest request =
       SubmitProvisioningConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setProvisioningConfig(ProvisioningConfig.newBuilder().build())
           .setEmail("email96619420")
           .build();
   ApiFuture<SubmitProvisioningConfigResponse> future =
       bareMetalSolutionClient.submitProvisioningConfigCallable().futureCall(request);
   // Do something.
   SubmitProvisioningConfigResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<SubmitProvisioningConfigRequest,SubmitProvisioningConfigResponse>

updateInstanceAsync(Instance instance, FieldMask updateMask)

public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(Instance instance, FieldMask updateMask)

Update details of a single server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   Instance instance = Instance.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Instance response = bareMetalSolutionClient.updateInstanceAsync(instance, updateMask).get();
 }
 
Parameters
Name Description
instance Instance

Required. The server to update.

The name field is used to identify the instance to update. Format: projects/{project}/locations/{location}/instances/{instance}

updateMask FieldMask

The list of fields to update. The currently supported fields are: labels hyperthreading_enabled os_image

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

updateInstanceAsync(UpdateInstanceRequest request)

public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(UpdateInstanceRequest request)

Update details of a single server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setInstance(Instance.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Instance response = bareMetalSolutionClient.updateInstanceAsync(request).get();
 }
 
Parameter
Name Description
request UpdateInstanceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

updateInstanceCallable()

public final UnaryCallable<UpdateInstanceRequest,Operation> updateInstanceCallable()

Update details of a single server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setInstance(Instance.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.updateInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateInstanceRequest,Operation>

updateInstanceOperationCallable()

public final OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationCallable()

Update details of a single server.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setInstance(Instance.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       bareMetalSolutionClient.updateInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata>

updateNetworkAsync(Network network, FieldMask updateMask)

public final OperationFuture<Network,OperationMetadata> updateNetworkAsync(Network network, FieldMask updateMask)

Update details of a single network.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   Network network = Network.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Network response = bareMetalSolutionClient.updateNetworkAsync(network, updateMask).get();
 }
 
Parameters
Name Description
network Network

Required. The network to update.

The name field is used to identify the instance to update. Format: projects/{project}/locations/{location}/networks/{network}

updateMask FieldMask

The list of fields to update. The only currently supported fields are: labels, reservations, vrf.vlan_attachments

Returns
Type Description
OperationFuture<Network,OperationMetadata>

updateNetworkAsync(UpdateNetworkRequest request)

public final OperationFuture<Network,OperationMetadata> updateNetworkAsync(UpdateNetworkRequest request)

Update details of a single network.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateNetworkRequest request =
       UpdateNetworkRequest.newBuilder()
           .setNetwork(Network.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Network response = bareMetalSolutionClient.updateNetworkAsync(request).get();
 }
 
Parameter
Name Description
request UpdateNetworkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Network,OperationMetadata>

updateNetworkCallable()

public final UnaryCallable<UpdateNetworkRequest,Operation> updateNetworkCallable()

Update details of a single network.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateNetworkRequest request =
       UpdateNetworkRequest.newBuilder()
           .setNetwork(Network.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.updateNetworkCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateNetworkRequest,Operation>

updateNetworkOperationCallable()

public final OperationCallable<UpdateNetworkRequest,Network,OperationMetadata> updateNetworkOperationCallable()

Update details of a single network.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateNetworkRequest request =
       UpdateNetworkRequest.newBuilder()
           .setNetwork(Network.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Network, OperationMetadata> future =
       bareMetalSolutionClient.updateNetworkOperationCallable().futureCall(request);
   // Do something.
   Network response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateNetworkRequest,Network,OperationMetadata>

updateNfsShareAsync(NfsShare nfsShare, FieldMask updateMask)

public final OperationFuture<NfsShare,OperationMetadata> updateNfsShareAsync(NfsShare nfsShare, FieldMask updateMask)

Update details of a single NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   NfsShare nfsShare = NfsShare.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   NfsShare response = bareMetalSolutionClient.updateNfsShareAsync(nfsShare, updateMask).get();
 }
 
Parameters
Name Description
nfsShare NfsShare

Required. The NFS share to update.

The name field is used to identify the NFS share to update. Format: projects/{project}/locations/{location}/nfsShares/{nfs_share}

updateMask FieldMask

The list of fields to update. The only currently supported fields are: labels allowed_clients

Returns
Type Description
OperationFuture<NfsShare,OperationMetadata>

updateNfsShareAsync(UpdateNfsShareRequest request)

public final OperationFuture<NfsShare,OperationMetadata> updateNfsShareAsync(UpdateNfsShareRequest request)

Update details of a single NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateNfsShareRequest request =
       UpdateNfsShareRequest.newBuilder()
           .setNfsShare(NfsShare.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   NfsShare response = bareMetalSolutionClient.updateNfsShareAsync(request).get();
 }
 
Parameter
Name Description
request UpdateNfsShareRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<NfsShare,OperationMetadata>

updateNfsShareCallable()

public final UnaryCallable<UpdateNfsShareRequest,Operation> updateNfsShareCallable()

Update details of a single NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateNfsShareRequest request =
       UpdateNfsShareRequest.newBuilder()
           .setNfsShare(NfsShare.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.updateNfsShareCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateNfsShareRequest,Operation>

updateNfsShareOperationCallable()

public final OperationCallable<UpdateNfsShareRequest,NfsShare,OperationMetadata> updateNfsShareOperationCallable()

Update details of a single NFS share.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateNfsShareRequest request =
       UpdateNfsShareRequest.newBuilder()
           .setNfsShare(NfsShare.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<NfsShare, OperationMetadata> future =
       bareMetalSolutionClient.updateNfsShareOperationCallable().futureCall(request);
   // Do something.
   NfsShare response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateNfsShareRequest,NfsShare,OperationMetadata>

updateProvisioningConfig(ProvisioningConfig provisioningConfig, FieldMask updateMask)

public final ProvisioningConfig updateProvisioningConfig(ProvisioningConfig provisioningConfig, FieldMask updateMask)

Update existing ProvisioningConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   ProvisioningConfig provisioningConfig = ProvisioningConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ProvisioningConfig response =
       bareMetalSolutionClient.updateProvisioningConfig(provisioningConfig, updateMask);
 }
 
Parameters
Name Description
provisioningConfig ProvisioningConfig

Required. The ProvisioningConfig to update.

updateMask FieldMask

Required. The list of fields to update.

Returns
Type Description
ProvisioningConfig

updateProvisioningConfig(UpdateProvisioningConfigRequest request)

public final ProvisioningConfig updateProvisioningConfig(UpdateProvisioningConfigRequest request)

Update existing ProvisioningConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateProvisioningConfigRequest request =
       UpdateProvisioningConfigRequest.newBuilder()
           .setProvisioningConfig(ProvisioningConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setEmail("email96619420")
           .build();
   ProvisioningConfig response = bareMetalSolutionClient.updateProvisioningConfig(request);
 }
 
Parameter
Name Description
request UpdateProvisioningConfigRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ProvisioningConfig

updateProvisioningConfigCallable()

public final UnaryCallable<UpdateProvisioningConfigRequest,ProvisioningConfig> updateProvisioningConfigCallable()

Update existing ProvisioningConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateProvisioningConfigRequest request =
       UpdateProvisioningConfigRequest.newBuilder()
           .setProvisioningConfig(ProvisioningConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setEmail("email96619420")
           .build();
   ApiFuture<ProvisioningConfig> future =
       bareMetalSolutionClient.updateProvisioningConfigCallable().futureCall(request);
   // Do something.
   ProvisioningConfig response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateProvisioningConfigRequest,ProvisioningConfig>

updateVolumeAsync(UpdateVolumeRequest request)

public final OperationFuture<Volume,OperationMetadata> updateVolumeAsync(UpdateVolumeRequest request)

Update details of a single storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateVolumeRequest request =
       UpdateVolumeRequest.newBuilder()
           .setVolume(Volume.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Volume response = bareMetalSolutionClient.updateVolumeAsync(request).get();
 }
 
Parameter
Name Description
request UpdateVolumeRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

updateVolumeAsync(Volume volume, FieldMask updateMask)

public final OperationFuture<Volume,OperationMetadata> updateVolumeAsync(Volume volume, FieldMask updateMask)

Update details of a single storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   Volume volume = Volume.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Volume response = bareMetalSolutionClient.updateVolumeAsync(volume, updateMask).get();
 }
 
Parameters
Name Description
volume Volume

Required. The volume to update.

The name field is used to identify the volume to update. Format: projects/{project}/locations/{location}/volumes/{volume}

updateMask FieldMask

The list of fields to update. The only currently supported fields are: 'labels'

Returns
Type Description
OperationFuture<Volume,OperationMetadata>

updateVolumeCallable()

public final UnaryCallable<UpdateVolumeRequest,Operation> updateVolumeCallable()

Update details of a single storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateVolumeRequest request =
       UpdateVolumeRequest.newBuilder()
           .setVolume(Volume.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       bareMetalSolutionClient.updateVolumeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateVolumeRequest,Operation>

updateVolumeOperationCallable()

public final OperationCallable<UpdateVolumeRequest,Volume,OperationMetadata> updateVolumeOperationCallable()

Update details of a single storage volume.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BareMetalSolutionClient bareMetalSolutionClient = BareMetalSolutionClient.create()) {
   UpdateVolumeRequest request =
       UpdateVolumeRequest.newBuilder()
           .setVolume(Volume.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Volume, OperationMetadata> future =
       bareMetalSolutionClient.updateVolumeOperationCallable().futureCall(request);
   // Do something.
   Volume response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateVolumeRequest,Volume,OperationMetadata>