Package com.google.cloud.baremetalsolution.v2 (0.24.0)

A client to Bare Metal Solution API

The interfaces provided are listed below, along with usage samples.

BareMetalSolutionClient

Service Description: Performs management operations on Bare Metal Solution servers.

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

Sample for BareMetalSolutionClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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);
 }

Classes

BareMetalSolutionClient

Service Description: Performs management operations on Bare Metal Solution servers.

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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns 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.

BareMetalSolutionClient.ListInstancesFixedSizeCollection

BareMetalSolutionClient.ListInstancesPage

BareMetalSolutionClient.ListInstancesPagedResponse

BareMetalSolutionClient.ListLocationsFixedSizeCollection

BareMetalSolutionClient.ListLocationsPage

BareMetalSolutionClient.ListLocationsPagedResponse

BareMetalSolutionClient.ListLunsFixedSizeCollection

BareMetalSolutionClient.ListLunsPage

BareMetalSolutionClient.ListLunsPagedResponse

BareMetalSolutionClient.ListNetworksFixedSizeCollection

BareMetalSolutionClient.ListNetworksPage

BareMetalSolutionClient.ListNetworksPagedResponse

BareMetalSolutionClient.ListNfsSharesFixedSizeCollection

BareMetalSolutionClient.ListNfsSharesPage

BareMetalSolutionClient.ListNfsSharesPagedResponse

BareMetalSolutionClient.ListOSImagesFixedSizeCollection

BareMetalSolutionClient.ListOSImagesPage

BareMetalSolutionClient.ListOSImagesPagedResponse

BareMetalSolutionClient.ListProvisioningQuotasFixedSizeCollection

BareMetalSolutionClient.ListProvisioningQuotasPage

BareMetalSolutionClient.ListProvisioningQuotasPagedResponse

BareMetalSolutionClient.ListSSHKeysFixedSizeCollection

BareMetalSolutionClient.ListSSHKeysPage

BareMetalSolutionClient.ListSSHKeysPagedResponse

BareMetalSolutionClient.ListVolumeSnapshotsFixedSizeCollection

BareMetalSolutionClient.ListVolumeSnapshotsPage

BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse

BareMetalSolutionClient.ListVolumesFixedSizeCollection

BareMetalSolutionClient.ListVolumesPage

BareMetalSolutionClient.ListVolumesPagedResponse

BareMetalSolutionGrpc

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

BareMetalSolutionGrpc.BareMetalSolutionBlockingStub

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

BareMetalSolutionGrpc.BareMetalSolutionFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service BareMetalSolution.

BareMetalSolutionGrpc.BareMetalSolutionImplBase

Base class for the server implementation of the service BareMetalSolution.

BareMetalSolutionGrpc.BareMetalSolutionStub

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

BareMetalSolutionProto

BareMetalSolutionSettings

Settings class to configure an instance of BareMetalSolutionClient.

The default instance has everything set to sensible defaults:

The default service address (baremetalsolution.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getInstance to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require 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.Builder bareMetalSolutionSettingsBuilder =
     BareMetalSolutionSettings.newBuilder();
 bareMetalSolutionSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         bareMetalSolutionSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BareMetalSolutionSettings bareMetalSolutionSettings = bareMetalSolutionSettingsBuilder.build();

BareMetalSolutionSettings.Builder

Builder for BareMetalSolutionSettings.

CommonProto

CreateNfsShareRequest

Message for creating an NFS share.

Protobuf type google.cloud.baremetalsolution.v2.CreateNfsShareRequest

CreateNfsShareRequest.Builder

Message for creating an NFS share.

Protobuf type google.cloud.baremetalsolution.v2.CreateNfsShareRequest

CreateProvisioningConfigRequest

Request for CreateProvisioningConfig.

Protobuf type google.cloud.baremetalsolution.v2.CreateProvisioningConfigRequest

CreateProvisioningConfigRequest.Builder

Request for CreateProvisioningConfig.

Protobuf type google.cloud.baremetalsolution.v2.CreateProvisioningConfigRequest

CreateSSHKeyRequest

Message for registering a public SSH key in a project.

Protobuf type google.cloud.baremetalsolution.v2.CreateSSHKeyRequest

CreateSSHKeyRequest.Builder

Message for registering a public SSH key in a project.

Protobuf type google.cloud.baremetalsolution.v2.CreateSSHKeyRequest

CreateVolumeSnapshotRequest

Message for creating a volume snapshot.

Protobuf type google.cloud.baremetalsolution.v2.CreateVolumeSnapshotRequest

CreateVolumeSnapshotRequest.Builder

Message for creating a volume snapshot.

Protobuf type google.cloud.baremetalsolution.v2.CreateVolumeSnapshotRequest

DeleteNfsShareRequest

Message for deleting an NFS share.

Protobuf type google.cloud.baremetalsolution.v2.DeleteNfsShareRequest

DeleteNfsShareRequest.Builder

Message for deleting an NFS share.

Protobuf type google.cloud.baremetalsolution.v2.DeleteNfsShareRequest

DeleteSSHKeyRequest

Message for deleting an SSH key from a project.

Protobuf type google.cloud.baremetalsolution.v2.DeleteSSHKeyRequest

DeleteSSHKeyRequest.Builder

Message for deleting an SSH key from a project.

Protobuf type google.cloud.baremetalsolution.v2.DeleteSSHKeyRequest

DeleteVolumeSnapshotRequest

Message for deleting named Volume snapshot.

Protobuf type google.cloud.baremetalsolution.v2.DeleteVolumeSnapshotRequest

DeleteVolumeSnapshotRequest.Builder

Message for deleting named Volume snapshot.

Protobuf type google.cloud.baremetalsolution.v2.DeleteVolumeSnapshotRequest

DetachLunRequest

Message for detach specific LUN from an Instance.

Protobuf type google.cloud.baremetalsolution.v2.DetachLunRequest

DetachLunRequest.Builder

Message for detach specific LUN from an Instance.

Protobuf type google.cloud.baremetalsolution.v2.DetachLunRequest

DisableInteractiveSerialConsoleRequest

Message for disabling the interactive serial console on an instance.

Protobuf type google.cloud.baremetalsolution.v2.DisableInteractiveSerialConsoleRequest

DisableInteractiveSerialConsoleRequest.Builder

Message for disabling the interactive serial console on an instance.

Protobuf type google.cloud.baremetalsolution.v2.DisableInteractiveSerialConsoleRequest

DisableInteractiveSerialConsoleResponse

Message for response of DisableInteractiveSerialConsole.

Protobuf type google.cloud.baremetalsolution.v2.DisableInteractiveSerialConsoleResponse

DisableInteractiveSerialConsoleResponse.Builder

Message for response of DisableInteractiveSerialConsole.

Protobuf type google.cloud.baremetalsolution.v2.DisableInteractiveSerialConsoleResponse

EnableInteractiveSerialConsoleRequest

Message for enabling the interactive serial console on an instance.

Protobuf type google.cloud.baremetalsolution.v2.EnableInteractiveSerialConsoleRequest

EnableInteractiveSerialConsoleRequest.Builder

Message for enabling the interactive serial console on an instance.

Protobuf type google.cloud.baremetalsolution.v2.EnableInteractiveSerialConsoleRequest

EnableInteractiveSerialConsoleResponse

Message for response of EnableInteractiveSerialConsole.

Protobuf type google.cloud.baremetalsolution.v2.EnableInteractiveSerialConsoleResponse

EnableInteractiveSerialConsoleResponse.Builder

Message for response of EnableInteractiveSerialConsole.

Protobuf type google.cloud.baremetalsolution.v2.EnableInteractiveSerialConsoleResponse

EvictLunRequest

Request for skip lun cooloff and delete it.

Protobuf type google.cloud.baremetalsolution.v2.EvictLunRequest

EvictLunRequest.Builder

Request for skip lun cooloff and delete it.

Protobuf type google.cloud.baremetalsolution.v2.EvictLunRequest

EvictVolumeRequest

Request for skip volume cooloff and delete it.

Protobuf type google.cloud.baremetalsolution.v2.EvictVolumeRequest

EvictVolumeRequest.Builder

Request for skip volume cooloff and delete it.

Protobuf type google.cloud.baremetalsolution.v2.EvictVolumeRequest

GetInstanceRequest

Message for requesting server information.

Protobuf type google.cloud.baremetalsolution.v2.GetInstanceRequest

GetInstanceRequest.Builder

Message for requesting server information.

Protobuf type google.cloud.baremetalsolution.v2.GetInstanceRequest

GetLunRequest

Message for requesting storage lun information.

Protobuf type google.cloud.baremetalsolution.v2.GetLunRequest

GetLunRequest.Builder

Message for requesting storage lun information.

Protobuf type google.cloud.baremetalsolution.v2.GetLunRequest

GetNetworkRequest

Message for requesting network information.

Protobuf type google.cloud.baremetalsolution.v2.GetNetworkRequest

GetNetworkRequest.Builder

Message for requesting network information.

Protobuf type google.cloud.baremetalsolution.v2.GetNetworkRequest

GetNfsShareRequest

Message for requesting NFS share information.

Protobuf type google.cloud.baremetalsolution.v2.GetNfsShareRequest

GetNfsShareRequest.Builder

Message for requesting NFS share information.

Protobuf type google.cloud.baremetalsolution.v2.GetNfsShareRequest

GetProvisioningConfigRequest

Request for GetProvisioningConfig.

Protobuf type google.cloud.baremetalsolution.v2.GetProvisioningConfigRequest

GetProvisioningConfigRequest.Builder

Request for GetProvisioningConfig.

Protobuf type google.cloud.baremetalsolution.v2.GetProvisioningConfigRequest

GetVolumeRequest

Message for requesting storage volume information.

Protobuf type google.cloud.baremetalsolution.v2.GetVolumeRequest

GetVolumeRequest.Builder

Message for requesting storage volume information.

Protobuf type google.cloud.baremetalsolution.v2.GetVolumeRequest

GetVolumeSnapshotRequest

Message for requesting volume snapshot information.

Protobuf type google.cloud.baremetalsolution.v2.GetVolumeSnapshotRequest

GetVolumeSnapshotRequest.Builder

Message for requesting volume snapshot information.

Protobuf type google.cloud.baremetalsolution.v2.GetVolumeSnapshotRequest

Instance

A server.

Protobuf type google.cloud.baremetalsolution.v2.Instance

Instance.Builder

A server.

Protobuf type google.cloud.baremetalsolution.v2.Instance

InstanceConfig

Configuration parameters for a new instance.

Protobuf type google.cloud.baremetalsolution.v2.InstanceConfig

InstanceConfig.Builder

Configuration parameters for a new instance.

Protobuf type google.cloud.baremetalsolution.v2.InstanceConfig

InstanceConfig.NetworkAddress

A network.

Protobuf type google.cloud.baremetalsolution.v2.InstanceConfig.NetworkAddress

InstanceConfig.NetworkAddress.Builder

A network.

Protobuf type google.cloud.baremetalsolution.v2.InstanceConfig.NetworkAddress

InstanceName

InstanceName.Builder

Builder for projects/{project}/locations/{location}/instances/{instance}.

InstanceProto

InstanceQuota

A resource budget.

Protobuf type google.cloud.baremetalsolution.v2.InstanceQuota

InstanceQuota.Builder

A resource budget.

Protobuf type google.cloud.baremetalsolution.v2.InstanceQuota

ListInstancesRequest

Message for requesting the list of servers.

Protobuf type google.cloud.baremetalsolution.v2.ListInstancesRequest

ListInstancesRequest.Builder

Message for requesting the list of servers.

Protobuf type google.cloud.baremetalsolution.v2.ListInstancesRequest

ListInstancesResponse

Response message for the list of servers.

Protobuf type google.cloud.baremetalsolution.v2.ListInstancesResponse

ListInstancesResponse.Builder

Response message for the list of servers.

Protobuf type google.cloud.baremetalsolution.v2.ListInstancesResponse

ListLunsRequest

Message for requesting a list of storage volume luns.

Protobuf type google.cloud.baremetalsolution.v2.ListLunsRequest

ListLunsRequest.Builder

Message for requesting a list of storage volume luns.

Protobuf type google.cloud.baremetalsolution.v2.ListLunsRequest

ListLunsResponse

Response message containing the list of storage volume luns.

Protobuf type google.cloud.baremetalsolution.v2.ListLunsResponse

ListLunsResponse.Builder

Response message containing the list of storage volume luns.

Protobuf type google.cloud.baremetalsolution.v2.ListLunsResponse

ListNetworkUsageRequest

Request to get networks with IPs.

Protobuf type google.cloud.baremetalsolution.v2.ListNetworkUsageRequest

ListNetworkUsageRequest.Builder

Request to get networks with IPs.

Protobuf type google.cloud.baremetalsolution.v2.ListNetworkUsageRequest

ListNetworkUsageResponse

Response with Networks with IPs

Protobuf type google.cloud.baremetalsolution.v2.ListNetworkUsageResponse

ListNetworkUsageResponse.Builder

Response with Networks with IPs

Protobuf type google.cloud.baremetalsolution.v2.ListNetworkUsageResponse

ListNetworksRequest

Message for requesting a list of networks.

Protobuf type google.cloud.baremetalsolution.v2.ListNetworksRequest

ListNetworksRequest.Builder

Message for requesting a list of networks.

Protobuf type google.cloud.baremetalsolution.v2.ListNetworksRequest

ListNetworksResponse

Response message containing the list of networks.

Protobuf type google.cloud.baremetalsolution.v2.ListNetworksResponse

ListNetworksResponse.Builder

Response message containing the list of networks.

Protobuf type google.cloud.baremetalsolution.v2.ListNetworksResponse

ListNfsSharesRequest

Message for requesting a list of NFS shares.

Protobuf type google.cloud.baremetalsolution.v2.ListNfsSharesRequest

ListNfsSharesRequest.Builder

Message for requesting a list of NFS shares.

Protobuf type google.cloud.baremetalsolution.v2.ListNfsSharesRequest

ListNfsSharesResponse

Response message containing the list of NFS shares.

Protobuf type google.cloud.baremetalsolution.v2.ListNfsSharesResponse

ListNfsSharesResponse.Builder

Response message containing the list of NFS shares.

Protobuf type google.cloud.baremetalsolution.v2.ListNfsSharesResponse

ListOSImagesRequest

Request for getting all available OS images.

Protobuf type google.cloud.baremetalsolution.v2.ListOSImagesRequest

ListOSImagesRequest.Builder

Request for getting all available OS images.

Protobuf type google.cloud.baremetalsolution.v2.ListOSImagesRequest

ListOSImagesResponse

Request for getting all available OS images.

Protobuf type google.cloud.baremetalsolution.v2.ListOSImagesResponse

ListOSImagesResponse.Builder

Request for getting all available OS images.

Protobuf type google.cloud.baremetalsolution.v2.ListOSImagesResponse

ListProvisioningQuotasRequest

Message for requesting the list of provisioning quotas.

Protobuf type google.cloud.baremetalsolution.v2.ListProvisioningQuotasRequest

ListProvisioningQuotasRequest.Builder

Message for requesting the list of provisioning quotas.

Protobuf type google.cloud.baremetalsolution.v2.ListProvisioningQuotasRequest

ListProvisioningQuotasResponse

Response message for the list of provisioning quotas.

Protobuf type google.cloud.baremetalsolution.v2.ListProvisioningQuotasResponse

ListProvisioningQuotasResponse.Builder

Response message for the list of provisioning quotas.

Protobuf type google.cloud.baremetalsolution.v2.ListProvisioningQuotasResponse

ListSSHKeysRequest

Message for listing the public SSH keys in a project.

Protobuf type google.cloud.baremetalsolution.v2.ListSSHKeysRequest

ListSSHKeysRequest.Builder

Message for listing the public SSH keys in a project.

Protobuf type google.cloud.baremetalsolution.v2.ListSSHKeysRequest

ListSSHKeysResponse

Message for response of ListSSHKeys.

Protobuf type google.cloud.baremetalsolution.v2.ListSSHKeysResponse

ListSSHKeysResponse.Builder

Message for response of ListSSHKeys.

Protobuf type google.cloud.baremetalsolution.v2.ListSSHKeysResponse

ListVolumeSnapshotsRequest

Message for requesting a list of volume snapshots.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumeSnapshotsRequest

ListVolumeSnapshotsRequest.Builder

Message for requesting a list of volume snapshots.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumeSnapshotsRequest

ListVolumeSnapshotsResponse

Response message containing the list of volume snapshots.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumeSnapshotsResponse

ListVolumeSnapshotsResponse.Builder

Response message containing the list of volume snapshots.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumeSnapshotsResponse

ListVolumesRequest

Message for requesting a list of storage volumes.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumesRequest

ListVolumesRequest.Builder

Message for requesting a list of storage volumes.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumesRequest

ListVolumesResponse

Response message containing the list of storage volumes.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumesResponse

ListVolumesResponse.Builder

Response message containing the list of storage volumes.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumesResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

LogicalInterface

Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.

Protobuf type google.cloud.baremetalsolution.v2.LogicalInterface