@Generated("by gapic-generator-java")
Package com.google.cloud.baremetalsolution.v2
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);
}
-
Class Summary Class Description BareMetalSolutionClient Service Description: Performs management operations on Bare Metal Solution servers.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.ListVolumesFixedSizeCollection BareMetalSolutionClient.ListVolumeSnapshotsFixedSizeCollection BareMetalSolutionClient.ListVolumeSnapshotsPage BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse BareMetalSolutionClient.ListVolumesPage BareMetalSolutionClient.ListVolumesPagedResponse BareMetalSolutionGrpc Performs management operations on Bare Metal Solution servers.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 ofBareMetalSolutionClient
.BareMetalSolutionSettings.Builder Builder for BareMetalSolutionSettings.CommonProto CreateNfsShareRequest Message for creating an NFS share.CreateNfsShareRequest.Builder Message for creating an NFS share.CreateProvisioningConfigRequest Request for CreateProvisioningConfig.CreateProvisioningConfigRequest.Builder Request for CreateProvisioningConfig.CreateSSHKeyRequest Message for registering a public SSH key in a project.CreateSSHKeyRequest.Builder Message for registering a public SSH key in a project.CreateVolumeSnapshotRequest Message for creating a volume snapshot.CreateVolumeSnapshotRequest.Builder Message for creating a volume snapshot.DeleteNfsShareRequest Message for deleting an NFS share.DeleteNfsShareRequest.Builder Message for deleting an NFS share.DeleteSSHKeyRequest Message for deleting an SSH key from a project.DeleteSSHKeyRequest.Builder Message for deleting an SSH key from a project.DeleteVolumeSnapshotRequest Message for deleting named Volume snapshot.DeleteVolumeSnapshotRequest.Builder Message for deleting named Volume snapshot.DetachLunRequest Message for detach specific LUN from an Instance.DetachLunRequest.Builder Message for detach specific LUN from an Instance.DisableInteractiveSerialConsoleRequest Message for disabling the interactive serial console on an instance.DisableInteractiveSerialConsoleRequest.Builder Message for disabling the interactive serial console on an instance.DisableInteractiveSerialConsoleResponse Message for response of DisableInteractiveSerialConsole.DisableInteractiveSerialConsoleResponse.Builder Message for response of DisableInteractiveSerialConsole.EnableInteractiveSerialConsoleRequest Message for enabling the interactive serial console on an instance.EnableInteractiveSerialConsoleRequest.Builder Message for enabling the interactive serial console on an instance.EnableInteractiveSerialConsoleResponse Message for response of EnableInteractiveSerialConsole.EnableInteractiveSerialConsoleResponse.Builder Message for response of EnableInteractiveSerialConsole.EvictLunRequest Request for skip lun cooloff and delete it.EvictLunRequest.Builder Request for skip lun cooloff and delete it.EvictVolumeRequest Request for skip volume cooloff and delete it.EvictVolumeRequest.Builder Request for skip volume cooloff and delete it.GetInstanceRequest Message for requesting server information.GetInstanceRequest.Builder Message for requesting server information.GetLunRequest Message for requesting storage lun information.GetLunRequest.Builder Message for requesting storage lun information.GetNetworkRequest Message for requesting network information.GetNetworkRequest.Builder Message for requesting network information.GetNfsShareRequest Message for requesting NFS share information.GetNfsShareRequest.Builder Message for requesting NFS share information.GetProvisioningConfigRequest Request for GetProvisioningConfig.GetProvisioningConfigRequest.Builder Request for GetProvisioningConfig.GetVolumeRequest Message for requesting storage volume information.GetVolumeRequest.Builder Message for requesting storage volume information.GetVolumeSnapshotRequest Message for requesting volume snapshot information.GetVolumeSnapshotRequest.Builder Message for requesting volume snapshot information.Instance A server.Instance.Builder A server.InstanceConfig Configuration parameters for a new instance.InstanceConfig.Builder Configuration parameters for a new instance.InstanceConfig.NetworkAddress A network.InstanceConfig.NetworkAddress.Builder A network.InstanceName InstanceName.Builder Builder for projects/{project}/locations/{location}/instances/{instance}.InstanceProto InstanceQuota A resource budget.InstanceQuota.Builder A resource budget.ListInstancesRequest Message for requesting the list of servers.ListInstancesRequest.Builder Message for requesting the list of servers.ListInstancesResponse Response message for the list of servers.ListInstancesResponse.Builder Response message for the list of servers.ListLunsRequest Message for requesting a list of storage volume luns.ListLunsRequest.Builder Message for requesting a list of storage volume luns.ListLunsResponse Response message containing the list of storage volume luns.ListLunsResponse.Builder Response message containing the list of storage volume luns.ListNetworksRequest Message for requesting a list of networks.ListNetworksRequest.Builder Message for requesting a list of networks.ListNetworksResponse Response message containing the list of networks.ListNetworksResponse.Builder Response message containing the list of networks.ListNetworkUsageRequest Request to get networks with IPs.ListNetworkUsageRequest.Builder Request to get networks with IPs.ListNetworkUsageResponse Response with Networks with IPsListNetworkUsageResponse.Builder Response with Networks with IPsListNfsSharesRequest Message for requesting a list of NFS shares.ListNfsSharesRequest.Builder Message for requesting a list of NFS shares.ListNfsSharesResponse Response message containing the list of NFS shares.ListNfsSharesResponse.Builder Response message containing the list of NFS shares.ListOSImagesRequest Request for getting all available OS images.ListOSImagesRequest.Builder Request for getting all available OS images.ListOSImagesResponse Request for getting all available OS images.ListOSImagesResponse.Builder Request for getting all available OS images.ListProvisioningQuotasRequest Message for requesting the list of provisioning quotas.ListProvisioningQuotasRequest.Builder Message for requesting the list of provisioning quotas.ListProvisioningQuotasResponse Response message for the list of provisioning quotas.ListProvisioningQuotasResponse.Builder Response message for the list of provisioning quotas.ListSSHKeysRequest Message for listing the public SSH keys in a project.ListSSHKeysRequest.Builder Message for listing the public SSH keys in a project.ListSSHKeysResponse Message for response of ListSSHKeys.ListSSHKeysResponse.Builder Message for response of ListSSHKeys.ListVolumeSnapshotsRequest Message for requesting a list of volume snapshots.ListVolumeSnapshotsRequest.Builder Message for requesting a list of volume snapshots.ListVolumeSnapshotsResponse Response message containing the list of volume snapshots.ListVolumeSnapshotsResponse.Builder Response message containing the list of volume snapshots.ListVolumesRequest Message for requesting a list of storage volumes.ListVolumesRequest.Builder Message for requesting a list of storage volumes.ListVolumesResponse Response message containing the list of storage volumes.ListVolumesResponse.Builder Response message containing the list of storage volumes.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.LogicalInterface Each logical interface represents a logical abstraction of the underlying physical interface (for eg.LogicalInterface.Builder Each logical interface represents a logical abstraction of the underlying physical interface (for eg.LogicalInterface.LogicalNetworkInterface Each logical network interface is effectively a network and IP pair.LogicalInterface.LogicalNetworkInterface.Builder Each logical network interface is effectively a network and IP pair.Lun A storage volume logical unit number (LUN).Lun.Builder A storage volume logical unit number (LUN).LunName LunName.Builder Builder for projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}.LunProto Network A Network.Network.Builder A Network.NetworkAddressReservation A reservation of one or more addresses in a network.NetworkAddressReservation.Builder A reservation of one or more addresses in a network.NetworkConfig Configuration parameters for a new network.NetworkConfig.Builder Configuration parameters for a new network.NetworkConfig.IntakeVlanAttachment A GCP vlan attachment.NetworkConfig.IntakeVlanAttachment.Builder A GCP vlan attachment.NetworkMountPoint Mount point for a network.NetworkMountPoint.Builder Mount point for a network.NetworkName NetworkName.Builder Builder for projects/{project}/locations/{location}/networks/{network}.NetworkProto NetworkUsage Network with all used IP addresses.NetworkUsage.Builder Network with all used IP addresses.NfsShare An NFS share.NfsShare.AllowedClient Represents an 'access point' for the share.NfsShare.AllowedClient.Builder Represents an 'access point' for the share.NfsShare.Builder An NFS share.NFSShareName NFSShareName.Builder Builder for projects/{project}/locations/{location}/nfsShares/{nfs_share}.NfsShareProto OperationMetadata Represents the metadata from a long-running operation.OperationMetadata.Builder Represents the metadata from a long-running operation.OSImage Operation System image.OSImage.Builder Operation System image.OsImageProto ProvisioningConfig A provisioning configuration.ProvisioningConfig.Builder A provisioning configuration.ProvisioningConfigName ProvisioningConfigName.Builder Builder for projects/{project}/locations/{location}/provisioningConfigs/{provisioning_config}.ProvisioningProto ProvisioningQuota A provisioning quota for a given project.ProvisioningQuota.Builder A provisioning quota for a given project.RenameInstanceRequest Message requesting rename of a server.RenameInstanceRequest.Builder Message requesting rename of a server.RenameNetworkRequest Message requesting rename of a server.RenameNetworkRequest.Builder Message requesting rename of a server.RenameNfsShareRequest Message requesting rename of a server.RenameNfsShareRequest.Builder Message requesting rename of a server.RenameVolumeRequest Message requesting rename of a server.RenameVolumeRequest.Builder Message requesting rename of a server.ResetInstanceRequest Message requesting to reset a server.ResetInstanceRequest.Builder Message requesting to reset a server.ResetInstanceResponse Response message from resetting a server.ResetInstanceResponse.Builder Response message from resetting a server.ResizeVolumeRequest Request for emergency resize Volume.ResizeVolumeRequest.Builder Request for emergency resize Volume.RestoreVolumeSnapshotRequest Message for restoring a volume snapshot.RestoreVolumeSnapshotRequest.Builder Message for restoring a volume snapshot.ServerNetworkTemplate Network template.ServerNetworkTemplate.Builder Network template.ServerNetworkTemplate.LogicalInterface Logical interface.ServerNetworkTemplate.LogicalInterface.Builder Logical interface.SSHKey An SSH key, used for authorizing with the interactive serial console feature.SSHKey.Builder An SSH key, used for authorizing with the interactive serial console feature.SshKeyName SshKeyName.Builder Builder for projects/{project}/locations/{location}/sshKeys/{ssh_key}.SshKeyProto StartInstanceRequest Message requesting to start a server.StartInstanceRequest.Builder Message requesting to start a server.StartInstanceResponse Response message from starting a server.StartInstanceResponse.Builder Response message from starting a server.StopInstanceRequest Message requesting to stop a server.StopInstanceRequest.Builder Message requesting to stop a server.StopInstanceResponse Response message from stopping a server.StopInstanceResponse.Builder Response message from stopping a server.SubmitProvisioningConfigRequest Request for SubmitProvisioningConfig.SubmitProvisioningConfigRequest.Builder Request for SubmitProvisioningConfig.SubmitProvisioningConfigResponse Response for SubmitProvisioningConfig.SubmitProvisioningConfigResponse.Builder Response for SubmitProvisioningConfig.UpdateInstanceRequest Message requesting to updating a server.UpdateInstanceRequest.Builder Message requesting to updating a server.UpdateNetworkRequest Message requesting to updating a network.UpdateNetworkRequest.Builder Message requesting to updating a network.UpdateNfsShareRequest Message requesting to updating an NFS share.UpdateNfsShareRequest.Builder Message requesting to updating an NFS share.UpdateProvisioningConfigRequest Message for updating a ProvisioningConfig.UpdateProvisioningConfigRequest.Builder Message for updating a ProvisioningConfig.UpdateVolumeRequest Message for updating a volume.UpdateVolumeRequest.Builder Message for updating a volume.Volume A storage volume.Volume.Builder A storage volume.Volume.SnapshotReservationDetail Details about snapshot space reservation and usage on the storage volume.Volume.SnapshotReservationDetail.Builder Details about snapshot space reservation and usage on the storage volume.VolumeConfig Configuration parameters for a new volume.VolumeConfig.Builder Configuration parameters for a new volume.VolumeConfig.LunRange A LUN(Logical Unit Number) range.VolumeConfig.LunRange.Builder A LUN(Logical Unit Number) range.VolumeConfig.NfsExport A NFS export entry.VolumeConfig.NfsExport.Builder A NFS export entry.VolumeName VolumeName.Builder Builder for projects/{project}/locations/{location}/volumes/{volume}.VolumeProto VolumeSnapshot A snapshot of a volume.VolumeSnapshot.Builder A snapshot of a volume.VolumeSnapshotName VolumeSnapshotName.Builder Builder for projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}.VolumeSnapshotProto VRF A network VRF.VRF.Builder A network VRF.VRF.QosPolicy QOS policy parameters.VRF.QosPolicy.Builder QOS policy parameters.VRF.VlanAttachment VLAN attachment details.VRF.VlanAttachment.Builder VLAN attachment details. -
Enum Summary Enum Description Instance.State The possible states for this server.InstanceConfig.NetworkConfig The network configuration of the instance.Lun.MultiprotocolType Display the operating systems present for the LUN multiprotocol type.Lun.State The possible states for the LUN.Lun.StorageType The storage types for a LUN.Network.State The possible states for this Network.Network.Type Network type.NetworkConfig.Bandwidth Interconnect bandwidth.NetworkConfig.ServiceCidr Service network block.NetworkConfig.Type Network type.NfsShare.MountPermissions The possible mount permissions.NfsShare.State The possible states for this NFS share.NfsShare.StorageType The storage type for a volume.ProvisioningConfig.State The possible states for this ProvisioningConfig.ProvisioningQuota.AssetType The available asset types for intake.ProvisioningQuota.AvailabilityCase ProvisioningQuota.QuotaCase ServerNetworkTemplate.LogicalInterface.InterfaceType Interface type.Volume.Protocol Storage protocol.Volume.SnapshotAutoDeleteBehavior The kinds of auto delete behavior to use when snapshot reserved space is full.Volume.State The possible states for a storage volume.Volume.StorageType The storage type for a volume.Volume.WorkloadProfile The possible values for a workload profile.VolumeConfig.NfsExport.ClientCase VolumeConfig.NfsExport.Permissions Permissions that can granted for an export.VolumeConfig.Protocol The protocol used to access the volume.VolumeConfig.Type The types of Volumes.VolumePerformanceTier Performance tier of the Volume.VolumeSnapshot.SnapshotType Represents the type of a snapshot.VRF.State The possible states for this VRF.WorkloadProfile The possible values for a workload profile.