Class BareMetalSolutionSettings (0.43.0)

public class BareMetalSolutionSettings extends ClientSettings<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();
 

Inheritance

java.lang.Object > ClientSettings > BareMetalSolutionSettings

Static Methods

create(BareMetalSolutionStubSettings stub)

public static final BareMetalSolutionSettings create(BareMetalSolutionStubSettings stub)
Parameter
Name Description
stub BareMetalSolutionStubSettings
Returns
Type Description
BareMetalSolutionSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static BareMetalSolutionSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
BareMetalSolutionSettings.Builder

newBuilder(ClientContext clientContext)

public static BareMetalSolutionSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
BareMetalSolutionSettings.Builder

newHttpJsonBuilder()

public static BareMetalSolutionSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
BareMetalSolutionSettings.Builder

Constructors

BareMetalSolutionSettings(BareMetalSolutionSettings.Builder settingsBuilder)

protected BareMetalSolutionSettings(BareMetalSolutionSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder BareMetalSolutionSettings.Builder

Methods

createNfsShareOperationSettings()

public OperationCallSettings<CreateNfsShareRequest,NfsShare,OperationMetadata> createNfsShareOperationSettings()

Returns the object with the settings used for calls to createNfsShare.

Returns
Type Description
OperationCallSettings<CreateNfsShareRequest,NfsShare,OperationMetadata>

createNfsShareSettings()

public UnaryCallSettings<CreateNfsShareRequest,Operation> createNfsShareSettings()

Returns the object with the settings used for calls to createNfsShare.

Returns
Type Description
UnaryCallSettings<CreateNfsShareRequest,Operation>

createProvisioningConfigSettings()

public UnaryCallSettings<CreateProvisioningConfigRequest,ProvisioningConfig> createProvisioningConfigSettings()

Returns the object with the settings used for calls to createProvisioningConfig.

Returns
Type Description
UnaryCallSettings<CreateProvisioningConfigRequest,ProvisioningConfig>

createSSHKeySettings()

public UnaryCallSettings<CreateSSHKeyRequest,SSHKey> createSSHKeySettings()

Returns the object with the settings used for calls to createSSHKey.

Returns
Type Description
UnaryCallSettings<CreateSSHKeyRequest,SSHKey>

createVolumeSnapshotSettings()

public UnaryCallSettings<CreateVolumeSnapshotRequest,VolumeSnapshot> createVolumeSnapshotSettings()

Returns the object with the settings used for calls to createVolumeSnapshot.

Returns
Type Description
UnaryCallSettings<CreateVolumeSnapshotRequest,VolumeSnapshot>

deleteNfsShareOperationSettings()

public OperationCallSettings<DeleteNfsShareRequest,Empty,OperationMetadata> deleteNfsShareOperationSettings()

Returns the object with the settings used for calls to deleteNfsShare.

Returns
Type Description
OperationCallSettings<DeleteNfsShareRequest,Empty,OperationMetadata>

deleteNfsShareSettings()

public UnaryCallSettings<DeleteNfsShareRequest,Operation> deleteNfsShareSettings()

Returns the object with the settings used for calls to deleteNfsShare.

Returns
Type Description
UnaryCallSettings<DeleteNfsShareRequest,Operation>

deleteSSHKeySettings()

public UnaryCallSettings<DeleteSSHKeyRequest,Empty> deleteSSHKeySettings()

Returns the object with the settings used for calls to deleteSSHKey.

Returns
Type Description
UnaryCallSettings<DeleteSSHKeyRequest,Empty>

deleteVolumeSnapshotSettings()

public UnaryCallSettings<DeleteVolumeSnapshotRequest,Empty> deleteVolumeSnapshotSettings()

Returns the object with the settings used for calls to deleteVolumeSnapshot.

Returns
Type Description
UnaryCallSettings<DeleteVolumeSnapshotRequest,Empty>

detachLunOperationSettings()

public OperationCallSettings<DetachLunRequest,Instance,OperationMetadata> detachLunOperationSettings()

Returns the object with the settings used for calls to detachLun.

Returns
Type Description
OperationCallSettings<DetachLunRequest,Instance,OperationMetadata>

detachLunSettings()

public UnaryCallSettings<DetachLunRequest,Operation> detachLunSettings()

Returns the object with the settings used for calls to detachLun.

Returns
Type Description
UnaryCallSettings<DetachLunRequest,Operation>

disableInteractiveSerialConsoleOperationSettings()

public OperationCallSettings<DisableInteractiveSerialConsoleRequest,DisableInteractiveSerialConsoleResponse,OperationMetadata> disableInteractiveSerialConsoleOperationSettings()

Returns the object with the settings used for calls to disableInteractiveSerialConsole.

Returns
Type Description
OperationCallSettings<DisableInteractiveSerialConsoleRequest,DisableInteractiveSerialConsoleResponse,OperationMetadata>

disableInteractiveSerialConsoleSettings()

public UnaryCallSettings<DisableInteractiveSerialConsoleRequest,Operation> disableInteractiveSerialConsoleSettings()

Returns the object with the settings used for calls to disableInteractiveSerialConsole.

Returns
Type Description
UnaryCallSettings<DisableInteractiveSerialConsoleRequest,Operation>

enableInteractiveSerialConsoleOperationSettings()

public OperationCallSettings<EnableInteractiveSerialConsoleRequest,EnableInteractiveSerialConsoleResponse,OperationMetadata> enableInteractiveSerialConsoleOperationSettings()

Returns the object with the settings used for calls to enableInteractiveSerialConsole.

Returns
Type Description
OperationCallSettings<EnableInteractiveSerialConsoleRequest,EnableInteractiveSerialConsoleResponse,OperationMetadata>

enableInteractiveSerialConsoleSettings()

public UnaryCallSettings<EnableInteractiveSerialConsoleRequest,Operation> enableInteractiveSerialConsoleSettings()

Returns the object with the settings used for calls to enableInteractiveSerialConsole.

Returns
Type Description
UnaryCallSettings<EnableInteractiveSerialConsoleRequest,Operation>

evictLunOperationSettings()

public OperationCallSettings<EvictLunRequest,Empty,OperationMetadata> evictLunOperationSettings()

Returns the object with the settings used for calls to evictLun.

Returns
Type Description
OperationCallSettings<EvictLunRequest,Empty,OperationMetadata>

evictLunSettings()

public UnaryCallSettings<EvictLunRequest,Operation> evictLunSettings()

Returns the object with the settings used for calls to evictLun.

Returns
Type Description
UnaryCallSettings<EvictLunRequest,Operation>

evictVolumeOperationSettings()

public OperationCallSettings<EvictVolumeRequest,Empty,OperationMetadata> evictVolumeOperationSettings()

Returns the object with the settings used for calls to evictVolume.

Returns
Type Description
OperationCallSettings<EvictVolumeRequest,Empty,OperationMetadata>

evictVolumeSettings()

public UnaryCallSettings<EvictVolumeRequest,Operation> evictVolumeSettings()

Returns the object with the settings used for calls to evictVolume.

Returns
Type Description
UnaryCallSettings<EvictVolumeRequest,Operation>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

Returns the object with the settings used for calls to getInstance.

Returns
Type Description
UnaryCallSettings<GetInstanceRequest,Instance>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getLunSettings()

public UnaryCallSettings<GetLunRequest,Lun> getLunSettings()

Returns the object with the settings used for calls to getLun.

Returns
Type Description
UnaryCallSettings<GetLunRequest,Lun>

getNetworkSettings()

public UnaryCallSettings<GetNetworkRequest,Network> getNetworkSettings()

Returns the object with the settings used for calls to getNetwork.

Returns
Type Description
UnaryCallSettings<GetNetworkRequest,Network>

getNfsShareSettings()

public UnaryCallSettings<GetNfsShareRequest,NfsShare> getNfsShareSettings()

Returns the object with the settings used for calls to getNfsShare.

Returns
Type Description
UnaryCallSettings<GetNfsShareRequest,NfsShare>

getProvisioningConfigSettings()

public UnaryCallSettings<GetProvisioningConfigRequest,ProvisioningConfig> getProvisioningConfigSettings()

Returns the object with the settings used for calls to getProvisioningConfig.

Returns
Type Description
UnaryCallSettings<GetProvisioningConfigRequest,ProvisioningConfig>

getVolumeSettings()

public UnaryCallSettings<GetVolumeRequest,Volume> getVolumeSettings()

Returns the object with the settings used for calls to getVolume.

Returns
Type Description
UnaryCallSettings<GetVolumeRequest,Volume>

getVolumeSnapshotSettings()

public UnaryCallSettings<GetVolumeSnapshotRequest,VolumeSnapshot> getVolumeSnapshotSettings()

Returns the object with the settings used for calls to getVolumeSnapshot.

Returns
Type Description
UnaryCallSettings<GetVolumeSnapshotRequest,VolumeSnapshot>

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,BareMetalSolutionClient.ListInstancesPagedResponse> listInstancesSettings()

Returns the object with the settings used for calls to listInstances.

Returns
Type Description
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,BareMetalSolutionClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listLunsSettings()

public PagedCallSettings<ListLunsRequest,ListLunsResponse,BareMetalSolutionClient.ListLunsPagedResponse> listLunsSettings()

Returns the object with the settings used for calls to listLuns.

Returns
Type Description
PagedCallSettings<ListLunsRequest,ListLunsResponse,ListLunsPagedResponse>

listNetworkUsageSettings()

public UnaryCallSettings<ListNetworkUsageRequest,ListNetworkUsageResponse> listNetworkUsageSettings()

Returns the object with the settings used for calls to listNetworkUsage.

Returns
Type Description
UnaryCallSettings<ListNetworkUsageRequest,ListNetworkUsageResponse>

listNetworksSettings()

public PagedCallSettings<ListNetworksRequest,ListNetworksResponse,BareMetalSolutionClient.ListNetworksPagedResponse> listNetworksSettings()

Returns the object with the settings used for calls to listNetworks.

Returns
Type Description
PagedCallSettings<ListNetworksRequest,ListNetworksResponse,ListNetworksPagedResponse>

listNfsSharesSettings()

public PagedCallSettings<ListNfsSharesRequest,ListNfsSharesResponse,BareMetalSolutionClient.ListNfsSharesPagedResponse> listNfsSharesSettings()

Returns the object with the settings used for calls to listNfsShares.

Returns
Type Description
PagedCallSettings<ListNfsSharesRequest,ListNfsSharesResponse,ListNfsSharesPagedResponse>

listOSImagesSettings()

public PagedCallSettings<ListOSImagesRequest,ListOSImagesResponse,BareMetalSolutionClient.ListOSImagesPagedResponse> listOSImagesSettings()

Returns the object with the settings used for calls to listOSImages.

Returns
Type Description
PagedCallSettings<ListOSImagesRequest,ListOSImagesResponse,ListOSImagesPagedResponse>

listProvisioningQuotasSettings()

public PagedCallSettings<ListProvisioningQuotasRequest,ListProvisioningQuotasResponse,BareMetalSolutionClient.ListProvisioningQuotasPagedResponse> listProvisioningQuotasSettings()

Returns the object with the settings used for calls to listProvisioningQuotas.

Returns
Type Description
PagedCallSettings<ListProvisioningQuotasRequest,ListProvisioningQuotasResponse,ListProvisioningQuotasPagedResponse>

listSSHKeysSettings()

public PagedCallSettings<ListSSHKeysRequest,ListSSHKeysResponse,BareMetalSolutionClient.ListSSHKeysPagedResponse> listSSHKeysSettings()

Returns the object with the settings used for calls to listSSHKeys.

Returns
Type Description
PagedCallSettings<ListSSHKeysRequest,ListSSHKeysResponse,ListSSHKeysPagedResponse>

listVolumeSnapshotsSettings()

public PagedCallSettings<ListVolumeSnapshotsRequest,ListVolumeSnapshotsResponse,BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse> listVolumeSnapshotsSettings()

Returns the object with the settings used for calls to listVolumeSnapshots.

Returns
Type Description
PagedCallSettings<ListVolumeSnapshotsRequest,ListVolumeSnapshotsResponse,ListVolumeSnapshotsPagedResponse>

listVolumesSettings()

public PagedCallSettings<ListVolumesRequest,ListVolumesResponse,BareMetalSolutionClient.ListVolumesPagedResponse> listVolumesSettings()

Returns the object with the settings used for calls to listVolumes.

Returns
Type Description
PagedCallSettings<ListVolumesRequest,ListVolumesResponse,ListVolumesPagedResponse>

renameInstanceSettings()

public UnaryCallSettings<RenameInstanceRequest,Instance> renameInstanceSettings()

Returns the object with the settings used for calls to renameInstance.

Returns
Type Description
UnaryCallSettings<RenameInstanceRequest,Instance>

renameNetworkSettings()

public UnaryCallSettings<RenameNetworkRequest,Network> renameNetworkSettings()

Returns the object with the settings used for calls to renameNetwork.

Returns
Type Description
UnaryCallSettings<RenameNetworkRequest,Network>

renameNfsShareSettings()

public UnaryCallSettings<RenameNfsShareRequest,NfsShare> renameNfsShareSettings()

Returns the object with the settings used for calls to renameNfsShare.

Returns
Type Description
UnaryCallSettings<RenameNfsShareRequest,NfsShare>

renameVolumeSettings()

public UnaryCallSettings<RenameVolumeRequest,Volume> renameVolumeSettings()

Returns the object with the settings used for calls to renameVolume.

Returns
Type Description
UnaryCallSettings<RenameVolumeRequest,Volume>

resetInstanceOperationSettings()

public OperationCallSettings<ResetInstanceRequest,ResetInstanceResponse,OperationMetadata> resetInstanceOperationSettings()

Returns the object with the settings used for calls to resetInstance.

Returns
Type Description
OperationCallSettings<ResetInstanceRequest,ResetInstanceResponse,OperationMetadata>

resetInstanceSettings()

public UnaryCallSettings<ResetInstanceRequest,Operation> resetInstanceSettings()

Returns the object with the settings used for calls to resetInstance.

Returns
Type Description
UnaryCallSettings<ResetInstanceRequest,Operation>

resizeVolumeOperationSettings()

public OperationCallSettings<ResizeVolumeRequest,Volume,OperationMetadata> resizeVolumeOperationSettings()

Returns the object with the settings used for calls to resizeVolume.

Returns
Type Description
OperationCallSettings<ResizeVolumeRequest,Volume,OperationMetadata>

resizeVolumeSettings()

public UnaryCallSettings<ResizeVolumeRequest,Operation> resizeVolumeSettings()

Returns the object with the settings used for calls to resizeVolume.

Returns
Type Description
UnaryCallSettings<ResizeVolumeRequest,Operation>

restoreVolumeSnapshotOperationSettings()

public OperationCallSettings<RestoreVolumeSnapshotRequest,VolumeSnapshot,OperationMetadata> restoreVolumeSnapshotOperationSettings()

Returns the object with the settings used for calls to restoreVolumeSnapshot.

Returns
Type Description
OperationCallSettings<RestoreVolumeSnapshotRequest,VolumeSnapshot,OperationMetadata>

restoreVolumeSnapshotSettings()

public UnaryCallSettings<RestoreVolumeSnapshotRequest,Operation> restoreVolumeSnapshotSettings()

Returns the object with the settings used for calls to restoreVolumeSnapshot.

Returns
Type Description
UnaryCallSettings<RestoreVolumeSnapshotRequest,Operation>

startInstanceOperationSettings()

public OperationCallSettings<StartInstanceRequest,StartInstanceResponse,OperationMetadata> startInstanceOperationSettings()

Returns the object with the settings used for calls to startInstance.

Returns
Type Description
OperationCallSettings<StartInstanceRequest,StartInstanceResponse,OperationMetadata>

startInstanceSettings()

public UnaryCallSettings<StartInstanceRequest,Operation> startInstanceSettings()

Returns the object with the settings used for calls to startInstance.

Returns
Type Description
UnaryCallSettings<StartInstanceRequest,Operation>

stopInstanceOperationSettings()

public OperationCallSettings<StopInstanceRequest,StopInstanceResponse,OperationMetadata> stopInstanceOperationSettings()

Returns the object with the settings used for calls to stopInstance.

Returns
Type Description
OperationCallSettings<StopInstanceRequest,StopInstanceResponse,OperationMetadata>

stopInstanceSettings()

public UnaryCallSettings<StopInstanceRequest,Operation> stopInstanceSettings()

Returns the object with the settings used for calls to stopInstance.

Returns
Type Description
UnaryCallSettings<StopInstanceRequest,Operation>

submitProvisioningConfigSettings()

public UnaryCallSettings<SubmitProvisioningConfigRequest,SubmitProvisioningConfigResponse> submitProvisioningConfigSettings()

Returns the object with the settings used for calls to submitProvisioningConfig.

Returns
Type Description
UnaryCallSettings<SubmitProvisioningConfigRequest,SubmitProvisioningConfigResponse>

toBuilder()

public BareMetalSolutionSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
BareMetalSolutionSettings.Builder
Overrides

updateInstanceOperationSettings()

public OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationSettings()

Returns the object with the settings used for calls to updateInstance.

Returns
Type Description
OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata>

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

Returns the object with the settings used for calls to updateInstance.

Returns
Type Description
UnaryCallSettings<UpdateInstanceRequest,Operation>

updateNetworkOperationSettings()

public OperationCallSettings<UpdateNetworkRequest,Network,OperationMetadata> updateNetworkOperationSettings()

Returns the object with the settings used for calls to updateNetwork.

Returns
Type Description
OperationCallSettings<UpdateNetworkRequest,Network,OperationMetadata>

updateNetworkSettings()

public UnaryCallSettings<UpdateNetworkRequest,Operation> updateNetworkSettings()

Returns the object with the settings used for calls to updateNetwork.

Returns
Type Description
UnaryCallSettings<UpdateNetworkRequest,Operation>

updateNfsShareOperationSettings()

public OperationCallSettings<UpdateNfsShareRequest,NfsShare,OperationMetadata> updateNfsShareOperationSettings()

Returns the object with the settings used for calls to updateNfsShare.

Returns
Type Description
OperationCallSettings<UpdateNfsShareRequest,NfsShare,OperationMetadata>

updateNfsShareSettings()

public UnaryCallSettings<UpdateNfsShareRequest,Operation> updateNfsShareSettings()

Returns the object with the settings used for calls to updateNfsShare.

Returns
Type Description
UnaryCallSettings<UpdateNfsShareRequest,Operation>

updateProvisioningConfigSettings()

public UnaryCallSettings<UpdateProvisioningConfigRequest,ProvisioningConfig> updateProvisioningConfigSettings()

Returns the object with the settings used for calls to updateProvisioningConfig.

Returns
Type Description
UnaryCallSettings<UpdateProvisioningConfigRequest,ProvisioningConfig>

updateVolumeOperationSettings()

public OperationCallSettings<UpdateVolumeRequest,Volume,OperationMetadata> updateVolumeOperationSettings()

Returns the object with the settings used for calls to updateVolume.

Returns
Type Description
OperationCallSettings<UpdateVolumeRequest,Volume,OperationMetadata>

updateVolumeSettings()

public UnaryCallSettings<UpdateVolumeRequest,Operation> updateVolumeSettings()

Returns the object with the settings used for calls to updateVolume.

Returns
Type Description
UnaryCallSettings<UpdateVolumeRequest,Operation>