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.
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().
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.
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.BareMetalSolutionFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service BareMetalSolution.
Performs management operations on Bare Metal Solution servers.
The baremetalsolution.googleapis.com service provides management
capabilities for Bare Metal Solution servers. To access the API methods, you
must assign Bare Metal Solution IAM roles containing the desired permissions
to your staff in your Google Cloud project. You must also enable the Bare
Metal Solution API. Once enabled, the methods act
upon specific servers in your Bare Metal Solution environment.
BareMetalSolutionGrpc.BareMetalSolutionImplBase
Base class for the server implementation of the service BareMetalSolution.
Performs management operations on Bare Metal Solution servers.
The baremetalsolution.googleapis.com service provides management
capabilities for Bare Metal Solution servers. To access the API methods, you
must assign Bare Metal Solution IAM roles containing the desired permissions
to your staff in your Google Cloud project. You must also enable the Bare
Metal Solution API. Once enabled, the methods act
upon specific servers in your Bare Metal Solution environment.
BareMetalSolutionGrpc.BareMetalSolutionStub
A stub to allow clients to do asynchronous rpc calls to service BareMetalSolution.
Performs management operations on Bare Metal Solution servers.
The baremetalsolution.googleapis.com service provides management
capabilities for Bare Metal Solution servers. To access the API methods, you
must assign Bare Metal Solution IAM roles containing the desired permissions
to your staff in your Google Cloud project. You must also enable the Bare
Metal Solution API. Once enabled, the methods act
upon specific servers in your Bare Metal Solution environment.
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
LogicalInterface.Builder
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
LogicalInterface.LogicalNetworkInterface
Each logical network interface is effectively a network and IP pair.
Protobuf type
google.cloud.baremetalsolution.v2.LogicalInterface.LogicalNetworkInterface
LogicalInterface.LogicalNetworkInterface.Builder
Each logical network interface is effectively a network and IP pair.
Protobuf type
google.cloud.baremetalsolution.v2.LogicalInterface.LogicalNetworkInterface
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}.
LunProto
NFSShareName
NFSShareName.Builder
Builder for projects/{project}/locations/{location}/nfsShares/{nfs_share}.
Network
A Network.
Protobuf type google.cloud.baremetalsolution.v2.Network
Network.Builder
A Network.
Protobuf type google.cloud.baremetalsolution.v2.Network
NetworkAddressReservation
A reservation of one or more addresses in a network.
Protobuf type google.cloud.baremetalsolution.v2.NetworkAddressReservation
NetworkAddressReservation.Builder
A reservation of one or more addresses in a network.
Protobuf type google.cloud.baremetalsolution.v2.NetworkAddressReservation
NetworkConfig
Configuration parameters for a new network.
Protobuf type google.cloud.baremetalsolution.v2.NetworkConfig
NetworkConfig.Builder
Configuration parameters for a new network.
Protobuf type google.cloud.baremetalsolution.v2.NetworkConfig
NetworkConfig.IntakeVlanAttachment
A GCP vlan attachment.
Protobuf type google.cloud.baremetalsolution.v2.NetworkConfig.IntakeVlanAttachment
NetworkConfig.IntakeVlanAttachment.Builder
A GCP vlan attachment.
Protobuf type google.cloud.baremetalsolution.v2.NetworkConfig.IntakeVlanAttachment
NetworkMountPoint
Mount point for a network.
Protobuf type google.cloud.baremetalsolution.v2.NetworkMountPoint
NetworkMountPoint.Builder
Mount point for a network.
Protobuf type google.cloud.baremetalsolution.v2.NetworkMountPoint
NetworkName
NetworkName.Builder
Builder for projects/{project}/locations/{location}/networks/{network}.
NetworkProto
NetworkUsage
Network with all used IP addresses.
Protobuf type google.cloud.baremetalsolution.v2.NetworkUsage
NetworkUsage.Builder
Network with all used IP addresses.
Protobuf type google.cloud.baremetalsolution.v2.NetworkUsage
NfsShare
An NFS share.
Protobuf type google.cloud.baremetalsolution.v2.NfsShare
NfsShare.AllowedClient
Represents an 'access point' for the share.
Protobuf type google.cloud.baremetalsolution.v2.NfsShare.AllowedClient
NfsShare.AllowedClient.Builder
Represents an 'access point' for the share.
Protobuf type google.cloud.baremetalsolution.v2.NfsShare.AllowedClient
NfsShare.Builder
An NFS share.
Protobuf type google.cloud.baremetalsolution.v2.NfsShare
NfsShareProto
OSImage
Operation System image.
Protobuf type google.cloud.baremetalsolution.v2.OSImage
OSImage.Builder
Operation System image.
Protobuf type google.cloud.baremetalsolution.v2.OSImage
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
OsImageProto
ProvisioningConfig
A provisioning configuration.
Protobuf type google.cloud.baremetalsolution.v2.ProvisioningConfig
ProvisioningConfig.Builder
A provisioning configuration.
Protobuf type google.cloud.baremetalsolution.v2.ProvisioningConfig
ProvisioningConfigName
ProvisioningConfigName.Builder
Builder for projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}.
ProvisioningProto
ProvisioningQuota
A provisioning quota for a given project.
Protobuf type google.cloud.baremetalsolution.v2.ProvisioningQuota
ProvisioningQuota.Builder
A provisioning quota for a given project.
Protobuf type google.cloud.baremetalsolution.v2.ProvisioningQuota
RenameInstanceRequest
Message requesting rename of a server.
Protobuf type google.cloud.baremetalsolution.v2.RenameInstanceRequest
RenameInstanceRequest.Builder
Message requesting rename of a server.
Protobuf type google.cloud.baremetalsolution.v2.RenameInstanceRequest
RenameNetworkRequest
Message requesting rename of a server.
Protobuf type google.cloud.baremetalsolution.v2.RenameNetworkRequest
RenameNetworkRequest.Builder
Message requesting rename of a server.
Protobuf type google.cloud.baremetalsolution.v2.RenameNetworkRequest
RenameNfsShareRequest
Message requesting rename of a server.
Protobuf type google.cloud.baremetalsolution.v2.RenameNfsShareRequest
RenameNfsShareRequest.Builder
Message requesting rename of a server.
Protobuf type google.cloud.baremetalsolution.v2.RenameNfsShareRequest
RenameVolumeRequest
Message requesting rename of a server.
Protobuf type google.cloud.baremetalsolution.v2.RenameVolumeRequest
RenameVolumeRequest.Builder
Message requesting rename of a server.
Protobuf type google.cloud.baremetalsolution.v2.RenameVolumeRequest
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
ResizeVolumeRequest
Request for emergency resize Volume.
Protobuf type google.cloud.baremetalsolution.v2.ResizeVolumeRequest
ResizeVolumeRequest.Builder
Request for emergency resize Volume.
Protobuf type google.cloud.baremetalsolution.v2.ResizeVolumeRequest
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
SSHKey
An SSH key, used for authorizing with the interactive serial console feature.
Protobuf type google.cloud.baremetalsolution.v2.SSHKey
SSHKey.Builder
An SSH key, used for authorizing with the interactive serial console feature.
Protobuf type google.cloud.baremetalsolution.v2.SSHKey
ServerNetworkTemplate
Network template.
Protobuf type google.cloud.baremetalsolution.v2.ServerNetworkTemplate
ServerNetworkTemplate.Builder
Network template.
Protobuf type google.cloud.baremetalsolution.v2.ServerNetworkTemplate
ServerNetworkTemplate.LogicalInterface
Logical interface.
Protobuf type google.cloud.baremetalsolution.v2.ServerNetworkTemplate.LogicalInterface
ServerNetworkTemplate.LogicalInterface.Builder
Logical interface.
Protobuf type
google.cloud.baremetalsolution.v2.ServerNetworkTemplate.LogicalInterface
SshKeyName
SshKeyName.Builder
Builder for projects/{project}/locations/{location}/sshKeys/{ssh_key}.
SshKeyProto
StartInstanceRequest
Message requesting to start a server.
Protobuf type google.cloud.baremetalsolution.v2.StartInstanceRequest
StartInstanceRequest.Builder
Message requesting to start a server.
Protobuf type google.cloud.baremetalsolution.v2.StartInstanceRequest
StartInstanceResponse
Response message from starting a server.
Protobuf type google.cloud.baremetalsolution.v2.StartInstanceResponse
StartInstanceResponse.Builder
Response message from starting a server.
Protobuf type google.cloud.baremetalsolution.v2.StartInstanceResponse
StopInstanceRequest
Message requesting to stop a server.
Protobuf type google.cloud.baremetalsolution.v2.StopInstanceRequest
StopInstanceRequest.Builder
Message requesting to stop a server.
Protobuf type google.cloud.baremetalsolution.v2.StopInstanceRequest
StopInstanceResponse
Response message from stopping a server.
Protobuf type google.cloud.baremetalsolution.v2.StopInstanceResponse
StopInstanceResponse.Builder
Response message from stopping a server.
Protobuf type google.cloud.baremetalsolution.v2.StopInstanceResponse
SubmitProvisioningConfigRequest
Request for SubmitProvisioningConfig.
Protobuf type google.cloud.baremetalsolution.v2.SubmitProvisioningConfigRequest
SubmitProvisioningConfigRequest.Builder
Request for SubmitProvisioningConfig.
Protobuf type google.cloud.baremetalsolution.v2.SubmitProvisioningConfigRequest
SubmitProvisioningConfigResponse
Response for SubmitProvisioningConfig.
Protobuf type google.cloud.baremetalsolution.v2.SubmitProvisioningConfigResponse
SubmitProvisioningConfigResponse.Builder
Response for SubmitProvisioningConfig.
Protobuf type google.cloud.baremetalsolution.v2.SubmitProvisioningConfigResponse
UpdateInstanceRequest
Message requesting to updating a server.
Protobuf type google.cloud.baremetalsolution.v2.UpdateInstanceRequest
UpdateInstanceRequest.Builder
Message requesting to updating a server.
Protobuf type google.cloud.baremetalsolution.v2.UpdateInstanceRequest
UpdateNetworkRequest
Message requesting to updating a network.
Protobuf type google.cloud.baremetalsolution.v2.UpdateNetworkRequest
UpdateNetworkRequest.Builder
Message requesting to updating a network.
Protobuf type google.cloud.baremetalsolution.v2.UpdateNetworkRequest
UpdateNfsShareRequest
Message requesting to updating an NFS share.
Protobuf type google.cloud.baremetalsolution.v2.UpdateNfsShareRequest
UpdateNfsShareRequest.Builder
Message requesting to updating an NFS share.
Protobuf type google.cloud.baremetalsolution.v2.UpdateNfsShareRequest
UpdateProvisioningConfigRequest
Message for updating a ProvisioningConfig.
Protobuf type google.cloud.baremetalsolution.v2.UpdateProvisioningConfigRequest
UpdateProvisioningConfigRequest.Builder
Message for updating a ProvisioningConfig.
Protobuf type google.cloud.baremetalsolution.v2.UpdateProvisioningConfigRequest
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
VolumeConfig
Configuration parameters for a new volume.
Protobuf type google.cloud.baremetalsolution.v2.VolumeConfig
VolumeConfig.Builder
Configuration parameters for a new volume.
Protobuf type google.cloud.baremetalsolution.v2.VolumeConfig
VolumeConfig.LunRange
A LUN(Logical Unit Number) range.
Protobuf type google.cloud.baremetalsolution.v2.VolumeConfig.LunRange
VolumeConfig.LunRange.Builder
A LUN(Logical Unit Number) range.
Protobuf type google.cloud.baremetalsolution.v2.VolumeConfig.LunRange
VolumeConfig.NfsExport
A NFS export entry.
Protobuf type google.cloud.baremetalsolution.v2.VolumeConfig.NfsExport
VolumeConfig.NfsExport.Builder
A NFS export entry.
Protobuf type google.cloud.baremetalsolution.v2.VolumeConfig.NfsExport
VolumeName
VolumeName.Builder
Builder for projects/{project}/locations/{location}/volumes/{volume}.
VolumeProto
VolumeSnapshot
A snapshot of a volume. Only boot volumes can have snapshots.
Protobuf type google.cloud.baremetalsolution.v2.VolumeSnapshot
VolumeSnapshot.Builder
A snapshot of a volume. Only boot volumes can have snapshots.
Protobuf type google.cloud.baremetalsolution.v2.VolumeSnapshot
VolumeSnapshotName
VolumeSnapshotName.Builder
Builder for projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}.
VolumeSnapshotProto
Interfaces
BareMetalSolutionGrpc.AsyncService
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.
CreateNfsShareRequestOrBuilder
CreateProvisioningConfigRequestOrBuilder
CreateSSHKeyRequestOrBuilder
CreateVolumeSnapshotRequestOrBuilder
DeleteNfsShareRequestOrBuilder
DeleteSSHKeyRequestOrBuilder
DeleteVolumeSnapshotRequestOrBuilder
DetachLunRequestOrBuilder
DisableInteractiveSerialConsoleRequestOrBuilder
DisableInteractiveSerialConsoleResponseOrBuilder
EnableInteractiveSerialConsoleRequestOrBuilder
EnableInteractiveSerialConsoleResponseOrBuilder
EvictLunRequestOrBuilder
EvictVolumeRequestOrBuilder
GetInstanceRequestOrBuilder
GetLunRequestOrBuilder
GetNetworkRequestOrBuilder
GetNfsShareRequestOrBuilder
GetProvisioningConfigRequestOrBuilder
GetVolumeRequestOrBuilder
GetVolumeSnapshotRequestOrBuilder
InstanceConfig.NetworkAddressOrBuilder
InstanceConfigOrBuilder
InstanceOrBuilder
InstanceQuotaOrBuilder
ListInstancesRequestOrBuilder
ListInstancesResponseOrBuilder
ListLunsRequestOrBuilder
ListLunsResponseOrBuilder
ListNetworkUsageRequestOrBuilder
ListNetworkUsageResponseOrBuilder
ListNetworksRequestOrBuilder
ListNetworksResponseOrBuilder
ListNfsSharesRequestOrBuilder
ListNfsSharesResponseOrBuilder
ListOSImagesRequestOrBuilder
ListOSImagesResponseOrBuilder
ListProvisioningQuotasRequestOrBuilder
ListProvisioningQuotasResponseOrBuilder
ListSSHKeysRequestOrBuilder
ListSSHKeysResponseOrBuilder
ListVolumeSnapshotsRequestOrBuilder
ListVolumeSnapshotsResponseOrBuilder
ListVolumesRequestOrBuilder
ListVolumesResponseOrBuilder
LogicalInterface.LogicalNetworkInterfaceOrBuilder
LogicalInterfaceOrBuilder
LunOrBuilder
NetworkAddressReservationOrBuilder
NetworkConfig.IntakeVlanAttachmentOrBuilder
NetworkConfigOrBuilder
NetworkMountPointOrBuilder
NetworkOrBuilder
NetworkUsageOrBuilder
NfsShare.AllowedClientOrBuilder
NfsShareOrBuilder
OSImageOrBuilder
OperationMetadataOrBuilder
ProvisioningConfigOrBuilder
ProvisioningQuotaOrBuilder
RenameInstanceRequestOrBuilder
RenameNetworkRequestOrBuilder
RenameNfsShareRequestOrBuilder
RenameVolumeRequestOrBuilder
ResetInstanceRequestOrBuilder
ResetInstanceResponseOrBuilder
ResizeVolumeRequestOrBuilder
RestoreVolumeSnapshotRequestOrBuilder
SSHKeyOrBuilder
ServerNetworkTemplate.LogicalInterfaceOrBuilder
ServerNetworkTemplateOrBuilder
StartInstanceRequestOrBuilder
StartInstanceResponseOrBuilder
StopInstanceRequestOrBuilder
StopInstanceResponseOrBuilder
SubmitProvisioningConfigRequestOrBuilder
SubmitProvisioningConfigResponseOrBuilder
UpdateInstanceRequestOrBuilder
UpdateNetworkRequestOrBuilder
UpdateNfsShareRequestOrBuilder
UpdateProvisioningConfigRequestOrBuilder
UpdateVolumeRequestOrBuilder
VRF.QosPolicyOrBuilder
VRF.VlanAttachmentOrBuilder
VRFOrBuilder
Volume.SnapshotReservationDetailOrBuilder
VolumeConfig.LunRangeOrBuilder
VolumeConfig.NfsExportOrBuilder
VolumeConfigOrBuilder
VolumeOrBuilder
VolumeSnapshotOrBuilder
Enums
Instance.State
The possible states for this server.
Protobuf enum google.cloud.baremetalsolution.v2.Instance.State
InstanceConfig.NetworkConfig
The network configuration of the instance.
Protobuf enum google.cloud.baremetalsolution.v2.InstanceConfig.NetworkConfig
Lun.MultiprotocolType
Display the operating systems present for the LUN multiprotocol type.
Protobuf enum google.cloud.baremetalsolution.v2.Lun.MultiprotocolType
Lun.State
The possible states for the LUN.
Protobuf enum google.cloud.baremetalsolution.v2.Lun.State
Lun.StorageType
The storage types for a LUN.
Protobuf enum google.cloud.baremetalsolution.v2.Lun.StorageType
Network.State
The possible states for this Network.
Protobuf enum google.cloud.baremetalsolution.v2.Network.State
Network.Type
Network type.
Protobuf enum google.cloud.baremetalsolution.v2.Network.Type
NetworkConfig.Bandwidth
Interconnect bandwidth.
Protobuf enum google.cloud.baremetalsolution.v2.NetworkConfig.Bandwidth
NetworkConfig.ServiceCidr
Service network block.
Protobuf enum google.cloud.baremetalsolution.v2.NetworkConfig.ServiceCidr
NetworkConfig.Type
Network type.
Protobuf enum google.cloud.baremetalsolution.v2.NetworkConfig.Type
NfsShare.MountPermissions
The possible mount permissions.
Protobuf enum google.cloud.baremetalsolution.v2.NfsShare.MountPermissions
NfsShare.State
The possible states for this NFS share.
Protobuf enum google.cloud.baremetalsolution.v2.NfsShare.State
NfsShare.StorageType
The storage type for a volume.
Protobuf enum google.cloud.baremetalsolution.v2.NfsShare.StorageType
ProvisioningConfig.State
The possible states for this ProvisioningConfig.
Protobuf enum google.cloud.baremetalsolution.v2.ProvisioningConfig.State
ProvisioningQuota.AssetType
The available asset types for intake.
Protobuf enum google.cloud.baremetalsolution.v2.ProvisioningQuota.AssetType
ProvisioningQuota.AvailabilityCase
ProvisioningQuota.QuotaCase
ServerNetworkTemplate.LogicalInterface.InterfaceType
Interface type.
Protobuf enum
google.cloud.baremetalsolution.v2.ServerNetworkTemplate.LogicalInterface.InterfaceType
VRF.State
The possible states for this VRF.
Protobuf enum google.cloud.baremetalsolution.v2.VRF.State
Volume.Protocol
Storage protocol.
Protobuf enum google.cloud.baremetalsolution.v2.Volume.Protocol
Volume.SnapshotAutoDeleteBehavior
The kinds of auto delete behavior to use when snapshot reserved space is full.
Protobuf enum google.cloud.baremetalsolution.v2.Volume.SnapshotAutoDeleteBehavior
Volume.State
The possible states for a storage volume.
Protobuf enum google.cloud.baremetalsolution.v2.Volume.State
Volume.StorageType
The storage type for a volume.
Protobuf enum google.cloud.baremetalsolution.v2.Volume.StorageType
Volume.WorkloadProfile
The possible values for a workload profile.
Protobuf enum google.cloud.baremetalsolution.v2.Volume.WorkloadProfile
VolumeConfig.NfsExport.ClientCase
VolumeConfig.NfsExport.Permissions
Permissions that can granted for an export.
Protobuf enum google.cloud.baremetalsolution.v2.VolumeConfig.NfsExport.Permissions
VolumeConfig.Protocol
The protocol used to access the volume.
Protobuf enum google.cloud.baremetalsolution.v2.VolumeConfig.Protocol
VolumeConfig.Type
The types of Volumes.
Protobuf enum google.cloud.baremetalsolution.v2.VolumeConfig.Type
VolumePerformanceTier
Performance tier of the Volume.
Protobuf enum google.cloud.baremetalsolution.v2.VolumePerformanceTier
VolumeSnapshot.SnapshotType
Represents the type of a snapshot.
Protobuf enum google.cloud.baremetalsolution.v2.VolumeSnapshot.SnapshotType
WorkloadProfile
The possible values for a workload profile.
Protobuf enum google.cloud.baremetalsolution.v2.WorkloadProfile