Class BareMetalSolutionClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StopInstance |
Stop a running server. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DetachLun |
Detach LUN from Instance. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ResizeVolume |
Emergency Volume resize. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListNfsShares |
List NFS shares. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateNfsShare |
Create an NFS share. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetProvisioningConfig |
Get ProvisioningConfig by name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateProvisioningConfig |
Create new ProvisioningConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateProvisioningConfig |
Update existing ProvisioningConfig. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructs an instance of BareMetalSolutionClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()static final BareMetalSolutionClientcreate()Constructs an instance of BareMetalSolutionClient with default settings.static final BareMetalSolutionClientcreate(BareMetalSolutionSettings settings) Constructs an instance of BareMetalSolutionClient, using the given settings.static final BareMetalSolutionClientcreate(BareMetalSolutionStub stub) Constructs an instance of BareMetalSolutionClient, using the given stub for making calls.createNfsShareAsync(CreateNfsShareRequest request) Create an NFS share.createNfsShareAsync(LocationName parent, NfsShare nfsShare) Create an NFS share.createNfsShareAsync(String parent, NfsShare nfsShare) Create an NFS share.Create an NFS share.Create an NFS share.final ProvisioningConfigCreate new ProvisioningConfig.final ProvisioningConfigcreateProvisioningConfig(LocationName parent, ProvisioningConfig provisioningConfig) Create new ProvisioningConfig.final ProvisioningConfigcreateProvisioningConfig(String parent, ProvisioningConfig provisioningConfig) Create new ProvisioningConfig.Create new ProvisioningConfig.final SSHKeycreateSSHKey(CreateSSHKeyRequest request) Register a public SSH key in the specified project for use with the interactive serial console feature.final SSHKeycreateSSHKey(LocationName parent, SSHKey sshKey, String sshKeyId) Register a public SSH key in the specified project for use with the interactive serial console feature.final SSHKeycreateSSHKey(String parent, SSHKey sshKey, String sshKeyId) Register a public SSH key in the specified project for use with the interactive serial console feature.Register a public SSH key in the specified project for use with the interactive serial console feature.final VolumeSnapshotTakes a snapshot of a boot volume.final VolumeSnapshotcreateVolumeSnapshot(VolumeName parent, VolumeSnapshot volumeSnapshot) Takes a snapshot of a boot volume.final VolumeSnapshotcreateVolumeSnapshot(String parent, VolumeSnapshot volumeSnapshot) Takes a snapshot of a boot volume.Takes a snapshot of a boot volume.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteNfsShareAsync(DeleteNfsShareRequest request) Delete an NFS share.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Delete an NFS share.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteNfsShareAsync(String name) Delete an NFS share.Delete an NFS share.final OperationCallable<DeleteNfsShareRequest,com.google.protobuf.Empty, OperationMetadata> Delete an NFS share.final voiddeleteSSHKey(DeleteSSHKeyRequest request) Deletes a public SSH key registered in the specified project.final voiddeleteSSHKey(SshKeyName name) Deletes a public SSH key registered in the specified project.final voiddeleteSSHKey(String name) Deletes a public SSH key registered in the specified project.final UnaryCallable<DeleteSSHKeyRequest,com.google.protobuf.Empty> Deletes a public SSH key registered in the specified project.final voidDeletes a volume snapshot.final voidDeletes a volume snapshot.final voiddeleteVolumeSnapshot(String name) Deletes a volume snapshot.final UnaryCallable<DeleteVolumeSnapshotRequest,com.google.protobuf.Empty> Deletes a volume snapshot.detachLunAsync(DetachLunRequest request) Detach LUN from Instance.detachLunAsync(InstanceName instance, LunName lun) Detach LUN from Instance.detachLunAsync(InstanceName instance, String lun) Detach LUN from Instance.detachLunAsync(String instance, LunName lun) Detach LUN from Instance.detachLunAsync(String instance, String lun) Detach LUN from Instance.Detach LUN from Instance.Detach LUN from Instance.Disable the interactive serial console feature on an instance.Disable the interactive serial console feature on an instance.Disable the interactive serial console feature on an instance.Disable the interactive serial console feature on an instance.final OperationCallable<DisableInteractiveSerialConsoleRequest,DisableInteractiveSerialConsoleResponse, OperationMetadata> Disable the interactive serial console feature on an instance.Enable the interactive serial console feature on an instance.Enable the interactive serial console feature on an instance.Enable the interactive serial console feature on an instance.Enable the interactive serial console feature on an instance.final OperationCallable<EnableInteractiveSerialConsoleRequest,EnableInteractiveSerialConsoleResponse, OperationMetadata> Enable the interactive serial console feature on an instance.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> evictLunAsync(EvictLunRequest request) Skips lun's cooloff and deletes it now.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> evictLunAsync(LunName name) Skips lun's cooloff and deletes it now.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> evictLunAsync(String name) Skips lun's cooloff and deletes it now.Skips lun's cooloff and deletes it now.final OperationCallable<EvictLunRequest,com.google.protobuf.Empty, OperationMetadata> Skips lun's cooloff and deletes it now.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> evictVolumeAsync(EvictVolumeRequest request) Skips volume's cooloff and deletes it now.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> evictVolumeAsync(VolumeName name) Skips volume's cooloff and deletes it now.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> evictVolumeAsync(String name) Skips volume's cooloff and deletes it now.Skips volume's cooloff and deletes it now.final OperationCallable<EvictVolumeRequest,com.google.protobuf.Empty, OperationMetadata> Skips volume's cooloff and deletes it now.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final InstancegetInstance(GetInstanceRequest request) Get details about a single server.final InstancegetInstance(InstanceName name) Get details about a single server.final InstancegetInstance(String name) Get details about a single server.Get details about a single server.final LocationgetLocation(GetLocationRequest request) Gets information about a location.Gets information about a location.final LungetLun(GetLunRequest request) Get details of a single storage logical unit number(LUN).final LunGet details of a single storage logical unit number(LUN).final LunGet details of a single storage logical unit number(LUN).final UnaryCallable<GetLunRequest,Lun> Get details of a single storage logical unit number(LUN).final NetworkgetNetwork(GetNetworkRequest request) Get details of a single network.final NetworkgetNetwork(NetworkName name) Get details of a single network.final NetworkgetNetwork(String name) Get details of a single network.Get details of a single network.final NfsSharegetNfsShare(GetNfsShareRequest request) Get details of a single NFS share.final NfsSharegetNfsShare(NFSShareName name) Get details of a single NFS share.final NfsSharegetNfsShare(String name) Get details of a single NFS share.Get details of a single NFS share.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final ProvisioningConfigGet ProvisioningConfig by name.final ProvisioningConfigGet ProvisioningConfig by name.final ProvisioningConfiggetProvisioningConfig(String name) Get ProvisioningConfig by name.Get ProvisioningConfig by name.getStub()final VolumegetVolume(GetVolumeRequest request) Get details of a single storage volume.final VolumegetVolume(VolumeName name) Get details of a single storage volume.final VolumeGet details of a single storage volume.final UnaryCallable<GetVolumeRequest,Volume> Get details of a single storage volume.final VolumeSnapshotReturns the specified snapshot resource.final VolumeSnapshotReturns the specified snapshot resource.final VolumeSnapshotgetVolumeSnapshot(String name) Returns the specified snapshot resource.Returns the specified snapshot resource.booleanbooleanlistInstances(ListInstancesRequest request) List servers in a given project and location.listInstances(LocationName parent) List servers in a given project and location.listInstances(String parent) List servers in a given project and location.List servers in a given project and location.List servers in a given project and location.listLocations(ListLocationsRequest request) Lists information about the supported locations for this service.Lists information about the supported locations for this service.Lists information about the supported locations for this service.listLuns(ListLunsRequest request) List storage volume luns for given storage volume.listLuns(VolumeName parent) List storage volume luns for given storage volume.List storage volume luns for given storage volume.List storage volume luns for given storage volume.List storage volume luns for given storage volume.listNetworks(ListNetworksRequest request) List network in a given project and location.listNetworks(LocationName parent) List network in a given project and location.listNetworks(String parent) List network in a given project and location.List network in a given project and location.List network in a given project and location.final ListNetworkUsageResponselistNetworkUsage(ListNetworkUsageRequest request) List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.final ListNetworkUsageResponselistNetworkUsage(LocationName location) List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.final ListNetworkUsageResponselistNetworkUsage(String location) List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.listNfsShares(ListNfsSharesRequest request) List NFS shares.listNfsShares(LocationName parent) List NFS shares.listNfsShares(String parent) List NFS shares.List NFS shares.List NFS shares.listOSImages(ListOSImagesRequest request) Retrieves the list of OS images which are currently approved.listOSImages(LocationName parent) Retrieves the list of OS images which are currently approved.listOSImages(String parent) Retrieves the list of OS images which are currently approved.Retrieves the list of OS images which are currently approved.Retrieves the list of OS images which are currently approved.List the budget details to provision resources on a given project.listProvisioningQuotas(LocationName parent) List the budget details to provision resources on a given project.listProvisioningQuotas(String parent) List the budget details to provision resources on a given project.List the budget details to provision resources on a given project.final UnaryCallable<ListProvisioningQuotasRequest,BareMetalSolutionClient.ListProvisioningQuotasPagedResponse> List the budget details to provision resources on a given project.listSSHKeys(ListSSHKeysRequest request) Lists the public SSH keys registered for the specified project.listSSHKeys(LocationName parent) Lists the public SSH keys registered for the specified project.listSSHKeys(String parent) Lists the public SSH keys registered for the specified project.Lists the public SSH keys registered for the specified project.Lists the public SSH keys registered for the specified project.listVolumes(ListVolumesRequest request) List storage volumes in a given project and location.listVolumes(LocationName parent) List storage volumes in a given project and location.listVolumes(String parent) List storage volumes in a given project and location.List storage volumes in a given project and location.Retrieves the list of snapshots for the specified volume.listVolumeSnapshots(VolumeName parent) Retrieves the list of snapshots for the specified volume.listVolumeSnapshots(String parent) Retrieves the list of snapshots for the specified volume.Retrieves the list of snapshots for the specified volume.final UnaryCallable<ListVolumeSnapshotsRequest,BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse> Retrieves the list of snapshots for the specified volume.List storage volumes in a given project and location.final InstancerenameInstance(InstanceName name, String newInstanceId) RenameInstance sets a new name for an instance.final InstancerenameInstance(RenameInstanceRequest request) RenameInstance sets a new name for an instance.final InstancerenameInstance(String name, String newInstanceId) RenameInstance sets a new name for an instance.RenameInstance sets a new name for an instance.final NetworkrenameNetwork(NetworkName name, String newNetworkId) RenameNetwork sets a new name for a network.final NetworkrenameNetwork(RenameNetworkRequest request) RenameNetwork sets a new name for a network.final NetworkrenameNetwork(String name, String newNetworkId) RenameNetwork sets a new name for a network.RenameNetwork sets a new name for a network.final NfsSharerenameNfsShare(NFSShareName name, String newNfsshareId) RenameNfsShare sets a new name for an nfsshare.final NfsSharerenameNfsShare(RenameNfsShareRequest request) RenameNfsShare sets a new name for an nfsshare.final NfsSharerenameNfsShare(String name, String newNfsshareId) RenameNfsShare sets a new name for an nfsshare.RenameNfsShare sets a new name for an nfsshare.final VolumerenameVolume(RenameVolumeRequest request) RenameVolume sets a new name for a volume.final VolumerenameVolume(VolumeName name, String newVolumeId) RenameVolume sets a new name for a volume.final VolumerenameVolume(String name, String newVolumeId) RenameVolume sets a new name for a volume.RenameVolume sets a new name for a volume.Perform an ungraceful, hard reset on a server.resetInstanceAsync(ResetInstanceRequest request) Perform an ungraceful, hard reset on a server.resetInstanceAsync(String name) Perform an ungraceful, hard reset on a server.Perform an ungraceful, hard reset on a server.Perform an ungraceful, hard reset on a server.resizeVolumeAsync(ResizeVolumeRequest request) Emergency Volume resize.resizeVolumeAsync(VolumeName volume, long sizeGib) Emergency Volume resize.resizeVolumeAsync(String volume, long sizeGib) Emergency Volume resize.Emergency Volume resize.Emergency Volume resize.Uses the specified snapshot to restore its parent volume.restoreVolumeSnapshotAsync(VolumeSnapshotName volumeSnapshot) Uses the specified snapshot to restore its parent volume.restoreVolumeSnapshotAsync(String volumeSnapshot) Uses the specified snapshot to restore its parent volume.Uses the specified snapshot to restore its parent volume.Uses the specified snapshot to restore its parent volume.voidshutdown()voidStarts a server that was shutdown.startInstanceAsync(StartInstanceRequest request) Starts a server that was shutdown.startInstanceAsync(String name) Starts a server that was shutdown.Starts a server that was shutdown.Starts a server that was shutdown.Stop a running server.stopInstanceAsync(StopInstanceRequest request) Stop a running server.stopInstanceAsync(String name) Stop a running server.Stop a running server.Stop a running server.submitProvisioningConfig(LocationName parent, ProvisioningConfig provisioningConfig) Submit a provisiong configuration for a given project.Submit a provisiong configuration for a given project.submitProvisioningConfig(String parent, ProvisioningConfig provisioningConfig) Submit a provisiong configuration for a given project.Submit a provisiong configuration for a given project.updateInstanceAsync(Instance instance, com.google.protobuf.FieldMask updateMask) Update details of a single server.updateInstanceAsync(UpdateInstanceRequest request) Update details of a single server.Update details of a single server.Update details of a single server.updateNetworkAsync(Network network, com.google.protobuf.FieldMask updateMask) Update details of a single network.updateNetworkAsync(UpdateNetworkRequest request) Update details of a single network.Update details of a single network.Update details of a single network.updateNfsShareAsync(NfsShare nfsShare, com.google.protobuf.FieldMask updateMask) Update details of a single NFS share.updateNfsShareAsync(UpdateNfsShareRequest request) Update details of a single NFS share.Update details of a single NFS share.Update details of a single NFS share.final ProvisioningConfigupdateProvisioningConfig(ProvisioningConfig provisioningConfig, com.google.protobuf.FieldMask updateMask) Update existing ProvisioningConfig.final ProvisioningConfigUpdate existing ProvisioningConfig.Update existing ProvisioningConfig.updateVolumeAsync(UpdateVolumeRequest request) Update details of a single storage volume.updateVolumeAsync(Volume volume, com.google.protobuf.FieldMask updateMask) Update details of a single storage volume.Update details of a single storage volume.Update details of a single storage volume.
-
Constructor Details
-
BareMetalSolutionClient
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.- Throws:
IOException
-
BareMetalSolutionClient
-
-
Method Details
-
create
Constructs an instance of BareMetalSolutionClient with default settings.- Throws:
IOException
-
create
public static final BareMetalSolutionClient create(BareMetalSolutionSettings settings) throws IOException 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.- Throws:
IOException
-
create
Constructs an instance of BareMetalSolutionClient, using the given stub for making calls. This is for advanced usage - prefer using create(BareMetalSolutionSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
getHttpJsonOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
listInstances
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); } }- Parameters:
parent- Required. Parent value for ListInstancesRequest.- Throws:
ApiException- if the remote call fails
-
listInstances
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); } }- Parameters:
parent- Required. Parent value for ListInstancesRequest.- Throws:
ApiException- if the remote call fails
-
listInstances
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
getInstance
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); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
getInstance
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); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
getInstance
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
updateInstanceAsync
public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(Instance instance, com.google.protobuf.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:
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- The list of fields to update. The currently supported fields are: `labels` `hyperthreading_enabled` `os_image`- Throws:
ApiException- if the remote call fails
-
updateInstanceAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateInstanceOperationCallable
public final OperationCallable<UpdateInstanceRequest,Instance, updateInstanceOperationCallable()OperationMetadata> 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(); } -
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(); } -
renameInstance
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- Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}newInstanceId- Required. The new `id` of the instance.- Throws:
ApiException- if the remote call fails
-
renameInstance
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- Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}newInstanceId- Required. The new `id` of the instance.- Throws:
ApiException- if the remote call fails
-
renameInstance
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
resetInstanceAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
resetInstanceAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
resetInstanceAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
resetInstanceOperationCallable
public final OperationCallable<ResetInstanceRequest,ResetInstanceResponse, resetInstanceOperationCallable()OperationMetadata> 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(); } -
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(); } -
startInstanceAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
startInstanceAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
startInstanceAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
startInstanceOperationCallable
public final OperationCallable<StartInstanceRequest,StartInstanceResponse, startInstanceOperationCallable()OperationMetadata> 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(); } -
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(); } -
stopInstanceAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
stopInstanceAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
stopInstanceAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
stopInstanceOperationCallable
public final OperationCallable<StopInstanceRequest,StopInstanceResponse, stopInstanceOperationCallable()OperationMetadata> 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(); } -
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(); } -
enableInteractiveSerialConsoleAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
enableInteractiveSerialConsoleAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
enableInteractiveSerialConsoleAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
enableInteractiveSerialConsoleOperationCallable
public final OperationCallable<EnableInteractiveSerialConsoleRequest,EnableInteractiveSerialConsoleResponse, enableInteractiveSerialConsoleOperationCallable()OperationMetadata> 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(); } -
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(); } -
disableInteractiveSerialConsoleAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
disableInteractiveSerialConsoleAsync
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(); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
disableInteractiveSerialConsoleAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
disableInteractiveSerialConsoleOperationCallable
public final OperationCallable<DisableInteractiveSerialConsoleRequest,DisableInteractiveSerialConsoleResponse, disableInteractiveSerialConsoleOperationCallable()OperationMetadata> 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(); } -
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(); } -
detachLunAsync
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:
instance- Required. Name of the instance.lun- Required. Name of the Lun to detach.- Throws:
ApiException- if the remote call fails
-
detachLunAsync
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:
instance- Required. Name of the instance.lun- Required. Name of the Lun to detach.- Throws:
ApiException- if the remote call fails
-
detachLunAsync
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:
instance- Required. Name of the instance.lun- Required. Name of the Lun to detach.- Throws:
ApiException- if the remote call fails
-
detachLunAsync
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:
instance- Required. Name of the instance.lun- Required. Name of the Lun to detach.- Throws:
ApiException- if the remote call fails
-
detachLunAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
detachLunOperationCallable
public final OperationCallable<DetachLunRequest,Instance, detachLunOperationCallable()OperationMetadata> 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(); } -
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(); } -
listSSHKeys
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); } }- Parameters:
parent- Required. The parent containing the SSH keys. Currently, the only valid value for the location is "global".- Throws:
ApiException- if the remote call fails
-
listSSHKeys
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); } }- Parameters:
parent- Required. The parent containing the SSH keys. Currently, the only valid value for the location is "global".- Throws:
ApiException- if the remote call fails
-
listSSHKeys
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
createSSHKey
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:
parent- Required. The parent containing the SSH keys.sshKey- Required. The SSH key to register.sshKeyId- 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}
- Throws:
ApiException- if the remote call fails
-
createSSHKey
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:
parent- Required. The parent containing the SSH keys.sshKey- Required. The SSH key to register.sshKeyId- 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}
- Throws:
ApiException- if the remote call fails
-
createSSHKey
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
deleteSSHKey
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); }- Parameters:
name- Required. The name of the SSH key to delete. Currently, the only valid value for the location is "global".- Throws:
ApiException- if the remote call fails
-
deleteSSHKey
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); }- Parameters:
name- Required. The name of the SSH key to delete. Currently, the only valid value for the location is "global".- Throws:
ApiException- if the remote call fails
-
deleteSSHKey
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listVolumes
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); } }- Parameters:
parent- Required. Parent value for ListVolumesRequest.- Throws:
ApiException- if the remote call fails
-
listVolumes
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); } }- Parameters:
parent- Required. Parent value for ListVolumesRequest.- Throws:
ApiException- if the remote call fails
-
listVolumes
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
getVolume
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); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
getVolume
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); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
getVolume
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
updateVolumeAsync
public final OperationFuture<Volume,OperationMetadata> updateVolumeAsync(Volume volume, com.google.protobuf.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:
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- The list of fields to update. The only currently supported fields are: 'labels'- Throws:
ApiException- if the remote call fails
-
updateVolumeAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateVolumeOperationCallable
public final OperationCallable<UpdateVolumeRequest,Volume, updateVolumeOperationCallable()OperationMetadata> 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(); } -
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(); } -
renameVolume
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- Required. The `name` field is used to identify the volume. Format: projects/{project}/locations/{location}/volumes/{volume}newVolumeId- Required. The new `id` of the volume.- Throws:
ApiException- if the remote call fails
-
renameVolume
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- Required. The `name` field is used to identify the volume. Format: projects/{project}/locations/{location}/volumes/{volume}newVolumeId- Required. The new `id` of the volume.- Throws:
ApiException- if the remote call fails
-
renameVolume
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
evictVolumeAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
name- Required. The name of the Volume.- Throws:
ApiException- if the remote call fails
-
evictVolumeAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
name- Required. The name of the Volume.- Throws:
ApiException- if the remote call fails
-
evictVolumeAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
evictVolumeOperationCallable
public final OperationCallable<EvictVolumeRequest,com.google.protobuf.Empty, evictVolumeOperationCallable()OperationMetadata> 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(); } -
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(); } -
resizeVolumeAsync
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:
volume- Required. Volume to resize.sizeGib- New Volume size, in GiB.- Throws:
ApiException- if the remote call fails
-
resizeVolumeAsync
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:
volume- Required. Volume to resize.sizeGib- New Volume size, in GiB.- Throws:
ApiException- if the remote call fails
-
resizeVolumeAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
resizeVolumeOperationCallable
public final OperationCallable<ResizeVolumeRequest,Volume, resizeVolumeOperationCallable()OperationMetadata> 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(); } -
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(); } -
listNetworks
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); } }- Parameters:
parent- Required. Parent value for ListNetworksRequest.- Throws:
ApiException- if the remote call fails
-
listNetworks
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); } }- Parameters:
parent- Required. Parent value for ListNetworksRequest.- Throws:
ApiException- if the remote call fails
-
listNetworks
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
listNetworkUsage
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); }- Parameters:
location- Required. Parent value (project and location).- Throws:
ApiException- if the remote call fails
-
listNetworkUsage
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); }- Parameters:
location- Required. Parent value (project and location).- Throws:
ApiException- if the remote call fails
-
listNetworkUsage
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
getNetwork
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); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
getNetwork
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); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
getNetwork
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
updateNetworkAsync
public final OperationFuture<Network,OperationMetadata> updateNetworkAsync(Network network, com.google.protobuf.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:
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- The list of fields to update. The only currently supported fields are: `labels`, `reservations`, `vrf.vlan_attachments`- Throws:
ApiException- if the remote call fails
-
updateNetworkAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateNetworkOperationCallable
public final OperationCallable<UpdateNetworkRequest,Network, updateNetworkOperationCallable()OperationMetadata> 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(); } -
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(); } -
createVolumeSnapshot
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:
parent- Required. The volume to snapshot.volumeSnapshot- Required. The snapshot to create.- Throws:
ApiException- if the remote call fails
-
createVolumeSnapshot
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:
parent- Required. The volume to snapshot.volumeSnapshot- Required. The snapshot to create.- Throws:
ApiException- if the remote call fails
-
createVolumeSnapshot
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
restoreVolumeSnapshotAsync
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(); }- Parameters:
volumeSnapshot- Required. Name of the snapshot which will be used to restore its parent volume.- Throws:
ApiException- if the remote call fails
-
restoreVolumeSnapshotAsync
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(); }- Parameters:
volumeSnapshot- Required. Name of the snapshot which will be used to restore its parent volume.- Throws:
ApiException- if the remote call fails
-
restoreVolumeSnapshotAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
restoreVolumeSnapshotOperationCallable
public final OperationCallable<RestoreVolumeSnapshotRequest,VolumeSnapshot, restoreVolumeSnapshotOperationCallable()OperationMetadata> 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(); } -
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(); } -
deleteVolumeSnapshot
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); }- Parameters:
name- Required. The name of the snapshot to delete.- Throws:
ApiException- if the remote call fails
-
deleteVolumeSnapshot
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); }- Parameters:
name- Required. The name of the snapshot to delete.- Throws:
ApiException- if the remote call fails
-
deleteVolumeSnapshot
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteVolumeSnapshotCallable
public final UnaryCallable<DeleteVolumeSnapshotRequest,com.google.protobuf.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(); } -
getVolumeSnapshot
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); }- Parameters:
name- Required. The name of the snapshot.- Throws:
ApiException- if the remote call fails
-
getVolumeSnapshot
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); }- Parameters:
name- Required. The name of the snapshot.- Throws:
ApiException- if the remote call fails
-
getVolumeSnapshot
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listVolumeSnapshots
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); } }- Parameters:
parent- Required. Parent value for ListVolumesRequest.- Throws:
ApiException- if the remote call fails
-
listVolumeSnapshots
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); } }- Parameters:
parent- Required. Parent value for ListVolumesRequest.- Throws:
ApiException- if the remote call fails
-
listVolumeSnapshots
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
getLun
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); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
getLun
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); }- Parameters:
name- Required. Name of the resource.- Throws:
ApiException- if the remote call fails
-
getLun
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listLuns
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); } }- Parameters:
parent- Required. Parent value for ListLunsRequest.- Throws:
ApiException- if the remote call fails
-
listLuns
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); } }- Parameters:
parent- Required. Parent value for ListLunsRequest.- Throws:
ApiException- if the remote call fails
-
listLuns
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
evictLunAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
name- Required. The name of the lun.- Throws:
ApiException- if the remote call fails
-
evictLunAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
name- Required. The name of the lun.- Throws:
ApiException- if the remote call fails
-
evictLunAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
evictLunOperationCallable
public final OperationCallable<EvictLunRequest,com.google.protobuf.Empty, evictLunOperationCallable()OperationMetadata> 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(); } -
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(); } -
listProvisioningQuotas
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); } }- Parameters:
parent- Required. Parent value for ListProvisioningQuotasRequest.- Throws:
ApiException- if the remote call fails
-
listProvisioningQuotas
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); } }- Parameters:
parent- Required. Parent value for ListProvisioningQuotasRequest.- Throws:
ApiException- if the remote call fails
-
listProvisioningQuotas
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
submitProvisioningConfig
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:
parent- Required. The parent project and location containing the ProvisioningConfig.provisioningConfig- Required. The ProvisioningConfig to create.- Throws:
ApiException- if the remote call fails
-
submitProvisioningConfig
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:
parent- Required. The parent project and location containing the ProvisioningConfig.provisioningConfig- Required. The ProvisioningConfig to create.- Throws:
ApiException- if the remote call fails
-
submitProvisioningConfig
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
getProvisioningConfig
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); }- Parameters:
name- Required. Name of the ProvisioningConfig.- Throws:
ApiException- if the remote call fails
-
getProvisioningConfig
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); }- Parameters:
name- Required. Name of the ProvisioningConfig.- Throws:
ApiException- if the remote call fails
-
getProvisioningConfig
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
createProvisioningConfig
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:
parent- Required. The parent project and location containing the ProvisioningConfig.provisioningConfig- Required. The ProvisioningConfig to create.- Throws:
ApiException- if the remote call fails
-
createProvisioningConfig
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:
parent- Required. The parent project and location containing the ProvisioningConfig.provisioningConfig- Required. The ProvisioningConfig to create.- Throws:
ApiException- if the remote call fails
-
createProvisioningConfig
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
updateProvisioningConfig
public final ProvisioningConfig updateProvisioningConfig(ProvisioningConfig provisioningConfig, com.google.protobuf.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:
provisioningConfig- Required. The ProvisioningConfig to update.updateMask- Required. The list of fields to update.- Throws:
ApiException- if the remote call fails
-
updateProvisioningConfig
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
renameNetwork
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- Required. The `name` field is used to identify the network. Format: projects/{project}/locations/{location}/networks/{network}newNetworkId- Required. The new `id` of the network.- Throws:
ApiException- if the remote call fails
-
renameNetwork
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- Required. The `name` field is used to identify the network. Format: projects/{project}/locations/{location}/networks/{network}newNetworkId- Required. The new `id` of the network.- Throws:
ApiException- if the remote call fails
-
renameNetwork
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listOSImages
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); } }- Parameters:
parent- Required. Parent value for ListProvisioningQuotasRequest.- Throws:
ApiException- if the remote call fails
-
listOSImages
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); } }- Parameters:
parent- Required. Parent value for ListProvisioningQuotasRequest.- Throws:
ApiException- if the remote call fails
-
listOSImages
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
listLocations
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
getLocation
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-