Class BareMetalSolutionStubSettings (0.58.0)

public class BareMetalSolutionStubSettings extends StubSettings<BareMetalSolutionStubSettings>

Settings class to configure an instance of BareMetalSolutionStub.

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 RetrySettings of getInstance:


 // 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
 BareMetalSolutionStubSettings.Builder bareMetalSolutionSettingsBuilder =
     BareMetalSolutionStubSettings.newBuilder();
 bareMetalSolutionSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         bareMetalSolutionSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 BareMetalSolutionStubSettings bareMetalSolutionSettings =
     bareMetalSolutionSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for updateInstance:


 // 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
 BareMetalSolutionStubSettings.Builder bareMetalSolutionSettingsBuilder =
     BareMetalSolutionStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 bareMetalSolutionSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > StubSettings > BareMetalSolutionStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
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

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 BareMetalSolutionStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
BareMetalSolutionStubSettings.Builder

newBuilder(ClientContext clientContext)

public static BareMetalSolutionStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
BareMetalSolutionStubSettings.Builder

newHttpJsonBuilder()

public static BareMetalSolutionStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
BareMetalSolutionStubSettings.Builder

Constructors

BareMetalSolutionStubSettings(BareMetalSolutionStubSettings.Builder settingsBuilder)

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

Methods

createNfsShareOperationSettings()

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

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

createNfsShareSettings()

public UnaryCallSettings<CreateNfsShareRequest,Operation> createNfsShareSettings()

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

createProvisioningConfigSettings()

public UnaryCallSettings<CreateProvisioningConfigRequest,ProvisioningConfig> createProvisioningConfigSettings()

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

createSSHKeySettings()

public UnaryCallSettings<CreateSSHKeyRequest,SSHKey> createSSHKeySettings()

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

Returns
Type Description
UnaryCallSettings<CreateSSHKeyRequest,SSHKey>

createStub()

public BareMetalSolutionStub createStub()
Returns
Type Description
BareMetalSolutionStub
Exceptions
Type Description
IOException

createVolumeSnapshotSettings()

public UnaryCallSettings<CreateVolumeSnapshotRequest,VolumeSnapshot> createVolumeSnapshotSettings()

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

deleteNfsShareOperationSettings()

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

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

deleteNfsShareSettings()

public UnaryCallSettings<DeleteNfsShareRequest,Operation> deleteNfsShareSettings()

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

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.

detachLunOperationSettings()

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

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

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.

disableInteractiveSerialConsoleSettings()

public UnaryCallSettings<DisableInteractiveSerialConsoleRequest,Operation> disableInteractiveSerialConsoleSettings()

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

enableInteractiveSerialConsoleOperationSettings()

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

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

enableInteractiveSerialConsoleSettings()

public UnaryCallSettings<EnableInteractiveSerialConsoleRequest,Operation> enableInteractiveSerialConsoleSettings()

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

evictLunOperationSettings()

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

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

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.

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.

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

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.

listInstancesSettings()

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

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

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.

listNetworkUsageSettings()

public UnaryCallSettings<ListNetworkUsageRequest,ListNetworkUsageResponse> listNetworkUsageSettings()

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

listNetworksSettings()

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

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

listNfsSharesSettings()

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

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

listOSImagesSettings()

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

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

listProvisioningQuotasSettings()

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

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

listSSHKeysSettings()

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

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

listVolumeSnapshotsSettings()

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

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

listVolumesSettings()

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

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

renameInstanceSettings()

public UnaryCallSettings<RenameInstanceRequest,Instance> renameInstanceSettings()

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

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.

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.

resetInstanceSettings()

public UnaryCallSettings<ResetInstanceRequest,Operation> resetInstanceSettings()

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

resizeVolumeOperationSettings()

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

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

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.

restoreVolumeSnapshotSettings()

public UnaryCallSettings<RestoreVolumeSnapshotRequest,Operation> restoreVolumeSnapshotSettings()

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

startInstanceOperationSettings()

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

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

startInstanceSettings()

public UnaryCallSettings<StartInstanceRequest,Operation> startInstanceSettings()

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

stopInstanceOperationSettings()

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

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

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.

toBuilder()

public BareMetalSolutionStubSettings.Builder toBuilder()

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

Returns
Type Description
BareMetalSolutionStubSettings.Builder
Overrides

updateInstanceOperationSettings()

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

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

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

updateNetworkOperationSettings()

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

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

updateNetworkSettings()

public UnaryCallSettings<UpdateNetworkRequest,Operation> updateNetworkSettings()

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

updateNfsShareOperationSettings()

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

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

updateNfsShareSettings()

public UnaryCallSettings<UpdateNfsShareRequest,Operation> updateNfsShareSettings()

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

updateProvisioningConfigSettings()

public UnaryCallSettings<UpdateProvisioningConfigRequest,ProvisioningConfig> updateProvisioningConfigSettings()

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

updateVolumeOperationSettings()

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

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

updateVolumeSettings()

public UnaryCallSettings<UpdateVolumeRequest,Operation> updateVolumeSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateVolumeRequest,Operation>