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

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:


 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:


 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:


 BareMetalSolutionSettings bareMetalSolutionSettings =
     BareMetalSolutionSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BareMetalSolutionClient bareMetalSolutionClient =
     BareMetalSolutionClient.create(bareMetalSolutionSettings);

To customize the endpoint:


 BareMetalSolutionSettings bareMetalSolutionSettings =
     BareMetalSolutionSettings.newBuilder().setEndpoint(myEndpoint).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.ListLunsFixedSizeCollection

BareMetalSolutionClient.ListLunsPage

BareMetalSolutionClient.ListLunsPagedResponse

BareMetalSolutionClient.ListNetworksFixedSizeCollection

BareMetalSolutionClient.ListNetworksPage

BareMetalSolutionClient.ListNetworksPagedResponse

BareMetalSolutionClient.ListSnapshotSchedulePoliciesFixedSizeCollection

BareMetalSolutionClient.ListSnapshotSchedulePoliciesPage

BareMetalSolutionClient.ListSnapshotSchedulePoliciesPagedResponse

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

BareMetalSolutionGrpc.BareMetalSolutionFutureStub

BareMetalSolutionGrpc.BareMetalSolutionImplBase

BareMetalSolutionGrpc.BareMetalSolutionStub

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:


 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.

BaremetalsolutionProto

CreateSnapshotSchedulePolicyRequest

Message for creating a snapshot schedule policy in a project.

Protobuf type google.cloud.baremetalsolution.v2.CreateSnapshotSchedulePolicyRequest

CreateSnapshotSchedulePolicyRequest.Builder

Message for creating a snapshot schedule policy in a project.

Protobuf type google.cloud.baremetalsolution.v2.CreateSnapshotSchedulePolicyRequest

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

DeleteSnapshotSchedulePolicyRequest

Message for deleting a snapshot schedule policy in a project.

Protobuf type google.cloud.baremetalsolution.v2.DeleteSnapshotSchedulePolicyRequest

DeleteSnapshotSchedulePolicyRequest.Builder

Message for deleting a snapshot schedule policy in a project.

Protobuf type google.cloud.baremetalsolution.v2.DeleteSnapshotSchedulePolicyRequest

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

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

GetSnapshotSchedulePolicyRequest

Message for requesting snapshot schedule policy information.

Protobuf type google.cloud.baremetalsolution.v2.GetSnapshotSchedulePolicyRequest

GetSnapshotSchedulePolicyRequest.Builder

Message for requesting snapshot schedule policy information.

Protobuf type google.cloud.baremetalsolution.v2.GetSnapshotSchedulePolicyRequest

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 storage volume snapshot information.

Protobuf type google.cloud.baremetalsolution.v2.GetVolumeSnapshotRequest

GetVolumeSnapshotRequest.Builder

Message for requesting storage 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

InstanceName

InstanceName.Builder

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

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

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

ListSnapshotSchedulePoliciesRequest

Message for requesting a list of snapshot schedule policies.

Protobuf type google.cloud.baremetalsolution.v2.ListSnapshotSchedulePoliciesRequest

ListSnapshotSchedulePoliciesRequest.Builder

Message for requesting a list of snapshot schedule policies.

Protobuf type google.cloud.baremetalsolution.v2.ListSnapshotSchedulePoliciesRequest

ListSnapshotSchedulePoliciesResponse

Response message containing the list of snapshot schedule policies.

Protobuf type google.cloud.baremetalsolution.v2.ListSnapshotSchedulePoliciesResponse

ListSnapshotSchedulePoliciesResponse.Builder

Response message containing the list of snapshot schedule policies.

Protobuf type google.cloud.baremetalsolution.v2.ListSnapshotSchedulePoliciesResponse

ListVolumeSnapshotsRequest

Message for requesting a list of storage volume snapshots.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumeSnapshotsRequest

ListVolumeSnapshotsRequest.Builder

Message for requesting a list of storage volume snapshots.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumeSnapshotsRequest

ListVolumeSnapshotsResponse

Response message containing the list of storage volume snapshots.

Protobuf type google.cloud.baremetalsolution.v2.ListVolumeSnapshotsResponse

ListVolumeSnapshotsResponse.Builder

Response message containing the list of storage 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}.

Lun

A storage volume logical unit number (LUN).

Protobuf type google.cloud.baremetalsolution.v2.Lun

Lun.Builder

A storage volume logical unit number (LUN).

Protobuf type google.cloud.baremetalsolution.v2.Lun

LunName

LunName.Builder

Builder for projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}.

Network

A Network.

Protobuf type google.cloud.baremetalsolution.v2.Network

Network.Builder

A Network.

Protobuf type google.cloud.baremetalsolution.v2.Network

NetworkName

NetworkName.Builder

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

OperationMetadata

Represents the metadata from a long-running operation.

Protobuf type google.cloud.baremetalsolution.v2.OperationMetadata

OperationMetadata.Builder

Represents the metadata from a long-running operation.

Protobuf type google.cloud.baremetalsolution.v2.OperationMetadata

ResetInstanceRequest

Message requesting to reset a server.

Protobuf type google.cloud.baremetalsolution.v2.ResetInstanceRequest

ResetInstanceRequest.Builder

Message requesting to reset a server.

Protobuf type google.cloud.baremetalsolution.v2.ResetInstanceRequest

ResetInstanceResponse

Response message from resetting a server.

Protobuf type google.cloud.baremetalsolution.v2.ResetInstanceResponse

ResetInstanceResponse.Builder

Response message from resetting a server.

Protobuf type google.cloud.baremetalsolution.v2.ResetInstanceResponse

RestoreVolumeSnapshotRequest

Message for restoring a volume snapshot.

Protobuf type google.cloud.baremetalsolution.v2.RestoreVolumeSnapshotRequest

RestoreVolumeSnapshotRequest.Builder

Message for restoring a volume snapshot.

Protobuf type google.cloud.baremetalsolution.v2.RestoreVolumeSnapshotRequest

SnapshotSchedulePolicy

A snapshot schedule policy.

Protobuf type google.cloud.baremetalsolution.v2.SnapshotSchedulePolicy

SnapshotSchedulePolicy.Builder

A snapshot schedule policy.

Protobuf type google.cloud.baremetalsolution.v2.SnapshotSchedulePolicy

SnapshotSchedulePolicy.Schedule

A snapshot schedule.

Protobuf type google.cloud.baremetalsolution.v2.SnapshotSchedulePolicy.Schedule

SnapshotSchedulePolicy.Schedule.Builder

A snapshot schedule.

Protobuf type google.cloud.baremetalsolution.v2.SnapshotSchedulePolicy.Schedule

SnapshotSchedulePolicyName

SnapshotSchedulePolicyName.Builder

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

UpdateSnapshotSchedulePolicyRequest

Message for updating a snapshot schedule policy in a project.

Protobuf type google.cloud.baremetalsolution.v2.UpdateSnapshotSchedulePolicyRequest

UpdateSnapshotSchedulePolicyRequest.Builder

Message for updating a snapshot schedule policy in a project.

Protobuf type google.cloud.baremetalsolution.v2.UpdateSnapshotSchedulePolicyRequest

UpdateVolumeRequest

Message for updating a volume.

Protobuf type google.cloud.baremetalsolution.v2.UpdateVolumeRequest

UpdateVolumeRequest.Builder

Message for updating a volume.

Protobuf type google.cloud.baremetalsolution.v2.UpdateVolumeRequest

VRF

A network VRF.

Protobuf type google.cloud.baremetalsolution.v2.VRF

VRF.Builder

A network VRF.

Protobuf type google.cloud.baremetalsolution.v2.VRF

VRF.QosPolicy

QOS policy parameters.

Protobuf type google.cloud.baremetalsolution.v2.VRF.QosPolicy

VRF.QosPolicy.Builder

QOS policy parameters.

Protobuf type google.cloud.baremetalsolution.v2.VRF.QosPolicy

VRF.VlanAttachment

VLAN attachment details.

Protobuf type google.cloud.baremetalsolution.v2.VRF.VlanAttachment

VRF.VlanAttachment.Builder

VLAN attachment details.

Protobuf type google.cloud.baremetalsolution.v2.VRF.VlanAttachment

Volume

A storage volume.

Protobuf type google.cloud.baremetalsolution.v2.Volume

Volume.Builder

A storage volume.

Protobuf type google.cloud.baremetalsolution.v2.Volume

Volume.SnapshotReservationDetail

Details about snapshot space reservation and usage on the storage volume.

Protobuf type google.cloud.baremetalsolution.v2.Volume.SnapshotReservationDetail

Volume.SnapshotReservationDetail.Builder

Details about snapshot space reservation and usage on the storage volume.

Protobuf type google.cloud.baremetalsolution.v2.Volume.SnapshotReservationDetail

VolumeName

VolumeName.Builder

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

VolumeSnapshot

Snapshot registered for a given storage volume.

Protobuf type google.cloud.baremetalsolution.v2.VolumeSnapshot

VolumeSnapshot.Builder

Snapshot registered for a given storage volume.

Protobuf type google.cloud.baremetalsolution.v2.VolumeSnapshot

VolumeSnapshotName

VolumeSnapshotName.Builder

Builder for projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}.

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

BareMetalSolutionClient

Classes

Interfaces