Class BareMetalSolutionStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<BareMetalSolutionStubSettings>
com.google.cloud.baremetalsolution.v2.stub.BareMetalSolutionStubSettings
@Generated("by gapic-generator-java")
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](https://docs.cloud.google.com/java/docs/client-retries) 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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for BareMetalSolutionStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBareMetalSolutionStubSettings(BareMetalSolutionStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createNfsShare.Returns the object with the settings used for calls to createNfsShare.Returns the object with the settings used for calls to createProvisioningConfig.Returns the object with the settings used for calls to createSSHKey.Returns the object with the settings used for calls to createVolumeSnapshot.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteNfsShareRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteNfsShare.Returns the object with the settings used for calls to deleteNfsShare.UnaryCallSettings<DeleteSSHKeyRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteSSHKey.UnaryCallSettings<DeleteVolumeSnapshotRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteVolumeSnapshot.Returns the object with the settings used for calls to detachLun.Returns the object with the settings used for calls to detachLun.OperationCallSettings<DisableInteractiveSerialConsoleRequest,DisableInteractiveSerialConsoleResponse, OperationMetadata> Returns the object with the settings used for calls to disableInteractiveSerialConsole.Returns the object with the settings used for calls to disableInteractiveSerialConsole.OperationCallSettings<EnableInteractiveSerialConsoleRequest,EnableInteractiveSerialConsoleResponse, OperationMetadata> Returns the object with the settings used for calls to enableInteractiveSerialConsole.Returns the object with the settings used for calls to enableInteractiveSerialConsole.OperationCallSettings<EvictLunRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to evictLun.Returns the object with the settings used for calls to evictLun.OperationCallSettings<EvictVolumeRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to evictVolume.Returns the object with the settings used for calls to evictVolume.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getInstance.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getLun.Returns the object with the settings used for calls to getNetwork.Returns the object with the settings used for calls to getNfsShare.Returns the object with the settings used for calls to getProvisioningConfig.Returns the default service name.Returns the object with the settings used for calls to getVolume.Returns the object with the settings used for calls to getVolumeSnapshot.PagedCallSettings<ListInstancesRequest,ListInstancesResponse, BareMetalSolutionClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, BareMetalSolutionClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to listLuns.PagedCallSettings<ListNetworksRequest,ListNetworksResponse, BareMetalSolutionClient.ListNetworksPagedResponse> Returns the object with the settings used for calls to listNetworks.Returns the object with the settings used for calls to listNetworkUsage.PagedCallSettings<ListNfsSharesRequest,ListNfsSharesResponse, BareMetalSolutionClient.ListNfsSharesPagedResponse> Returns the object with the settings used for calls to listNfsShares.PagedCallSettings<ListOSImagesRequest,ListOSImagesResponse, BareMetalSolutionClient.ListOSImagesPagedResponse> Returns the object with the settings used for calls to listOSImages.PagedCallSettings<ListProvisioningQuotasRequest,ListProvisioningQuotasResponse, BareMetalSolutionClient.ListProvisioningQuotasPagedResponse> Returns the object with the settings used for calls to listProvisioningQuotas.PagedCallSettings<ListSSHKeysRequest,ListSSHKeysResponse, BareMetalSolutionClient.ListSSHKeysPagedResponse> Returns the object with the settings used for calls to listSSHKeys.PagedCallSettings<ListVolumeSnapshotsRequest,ListVolumeSnapshotsResponse, BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse> Returns the object with the settings used for calls to listVolumeSnapshots.PagedCallSettings<ListVolumesRequest,ListVolumesResponse, BareMetalSolutionClient.ListVolumesPagedResponse> Returns the object with the settings used for calls to listVolumes.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to renameInstance.Returns the object with the settings used for calls to renameNetwork.Returns the object with the settings used for calls to renameNfsShare.Returns the object with the settings used for calls to renameVolume.Returns the object with the settings used for calls to resetInstance.Returns the object with the settings used for calls to resetInstance.Returns the object with the settings used for calls to resizeVolume.Returns the object with the settings used for calls to resizeVolume.Returns the object with the settings used for calls to restoreVolumeSnapshot.Returns the object with the settings used for calls to restoreVolumeSnapshot.Returns the object with the settings used for calls to startInstance.Returns the object with the settings used for calls to startInstance.Returns the object with the settings used for calls to stopInstance.Returns the object with the settings used for calls to stopInstance.Returns the object with the settings used for calls to submitProvisioningConfig.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateInstance.Returns the object with the settings used for calls to updateInstance.Returns the object with the settings used for calls to updateNetwork.Returns the object with the settings used for calls to updateNetwork.Returns the object with the settings used for calls to updateNfsShare.Returns the object with the settings used for calls to updateNfsShare.Returns the object with the settings used for calls to updateProvisioningConfig.Returns the object with the settings used for calls to updateVolume.Returns the object with the settings used for calls to updateVolume.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
BareMetalSolutionStubSettings
protected BareMetalSolutionStubSettings(BareMetalSolutionStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listInstancesSettings
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse, listInstancesSettings()BareMetalSolutionClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances. -
getInstanceSettings
Returns the object with the settings used for calls to getInstance. -
updateInstanceSettings
Returns the object with the settings used for calls to updateInstance. -
updateInstanceOperationSettings
public OperationCallSettings<UpdateInstanceRequest,Instance, updateInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateInstance. -
renameInstanceSettings
Returns the object with the settings used for calls to renameInstance. -
resetInstanceSettings
Returns the object with the settings used for calls to resetInstance. -
resetInstanceOperationSettings
public OperationCallSettings<ResetInstanceRequest,ResetInstanceResponse, resetInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to resetInstance. -
startInstanceSettings
Returns the object with the settings used for calls to startInstance. -
startInstanceOperationSettings
public OperationCallSettings<StartInstanceRequest,StartInstanceResponse, startInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to startInstance. -
stopInstanceSettings
Returns the object with the settings used for calls to stopInstance. -
stopInstanceOperationSettings
public OperationCallSettings<StopInstanceRequest,StopInstanceResponse, stopInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to stopInstance. -
enableInteractiveSerialConsoleSettings
public UnaryCallSettings<EnableInteractiveSerialConsoleRequest,Operation> enableInteractiveSerialConsoleSettings()Returns the object with the settings used for calls to enableInteractiveSerialConsole. -
enableInteractiveSerialConsoleOperationSettings
public OperationCallSettings<EnableInteractiveSerialConsoleRequest,EnableInteractiveSerialConsoleResponse, enableInteractiveSerialConsoleOperationSettings()OperationMetadata> Returns the object with the settings used for calls to enableInteractiveSerialConsole. -
disableInteractiveSerialConsoleSettings
public UnaryCallSettings<DisableInteractiveSerialConsoleRequest,Operation> disableInteractiveSerialConsoleSettings()Returns the object with the settings used for calls to disableInteractiveSerialConsole. -
disableInteractiveSerialConsoleOperationSettings
public OperationCallSettings<DisableInteractiveSerialConsoleRequest,DisableInteractiveSerialConsoleResponse, disableInteractiveSerialConsoleOperationSettings()OperationMetadata> Returns the object with the settings used for calls to disableInteractiveSerialConsole. -
detachLunSettings
Returns the object with the settings used for calls to detachLun. -
detachLunOperationSettings
public OperationCallSettings<DetachLunRequest,Instance, detachLunOperationSettings()OperationMetadata> Returns the object with the settings used for calls to detachLun. -
listSSHKeysSettings
public PagedCallSettings<ListSSHKeysRequest,ListSSHKeysResponse, listSSHKeysSettings()BareMetalSolutionClient.ListSSHKeysPagedResponse> Returns the object with the settings used for calls to listSSHKeys. -
createSSHKeySettings
Returns the object with the settings used for calls to createSSHKey. -
deleteSSHKeySettings
Returns the object with the settings used for calls to deleteSSHKey. -
listVolumesSettings
public PagedCallSettings<ListVolumesRequest,ListVolumesResponse, listVolumesSettings()BareMetalSolutionClient.ListVolumesPagedResponse> Returns the object with the settings used for calls to listVolumes. -
getVolumeSettings
Returns the object with the settings used for calls to getVolume. -
updateVolumeSettings
Returns the object with the settings used for calls to updateVolume. -
updateVolumeOperationSettings
public OperationCallSettings<UpdateVolumeRequest,Volume, updateVolumeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateVolume. -
renameVolumeSettings
Returns the object with the settings used for calls to renameVolume. -
evictVolumeSettings
Returns the object with the settings used for calls to evictVolume. -
evictVolumeOperationSettings
public OperationCallSettings<EvictVolumeRequest,com.google.protobuf.Empty, evictVolumeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to evictVolume. -
resizeVolumeSettings
Returns the object with the settings used for calls to resizeVolume. -
resizeVolumeOperationSettings
public OperationCallSettings<ResizeVolumeRequest,Volume, resizeVolumeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to resizeVolume. -
listNetworksSettings
public PagedCallSettings<ListNetworksRequest,ListNetworksResponse, listNetworksSettings()BareMetalSolutionClient.ListNetworksPagedResponse> Returns the object with the settings used for calls to listNetworks. -
listNetworkUsageSettings
public UnaryCallSettings<ListNetworkUsageRequest,ListNetworkUsageResponse> listNetworkUsageSettings()Returns the object with the settings used for calls to listNetworkUsage. -
getNetworkSettings
Returns the object with the settings used for calls to getNetwork. -
updateNetworkSettings
Returns the object with the settings used for calls to updateNetwork. -
updateNetworkOperationSettings
public OperationCallSettings<UpdateNetworkRequest,Network, updateNetworkOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateNetwork. -
createVolumeSnapshotSettings
Returns the object with the settings used for calls to createVolumeSnapshot. -
restoreVolumeSnapshotSettings
Returns the object with the settings used for calls to restoreVolumeSnapshot. -
restoreVolumeSnapshotOperationSettings
public OperationCallSettings<RestoreVolumeSnapshotRequest,VolumeSnapshot, restoreVolumeSnapshotOperationSettings()OperationMetadata> Returns the object with the settings used for calls to restoreVolumeSnapshot. -
deleteVolumeSnapshotSettings
public UnaryCallSettings<DeleteVolumeSnapshotRequest,com.google.protobuf.Empty> deleteVolumeSnapshotSettings()Returns the object with the settings used for calls to deleteVolumeSnapshot. -
getVolumeSnapshotSettings
Returns the object with the settings used for calls to getVolumeSnapshot. -
listVolumeSnapshotsSettings
public PagedCallSettings<ListVolumeSnapshotsRequest,ListVolumeSnapshotsResponse, listVolumeSnapshotsSettings()BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse> Returns the object with the settings used for calls to listVolumeSnapshots. -
getLunSettings
Returns the object with the settings used for calls to getLun. -
listLunsSettings
public PagedCallSettings<ListLunsRequest,ListLunsResponse, listLunsSettings()BareMetalSolutionClient.ListLunsPagedResponse> Returns the object with the settings used for calls to listLuns. -
evictLunSettings
Returns the object with the settings used for calls to evictLun. -
evictLunOperationSettings
public OperationCallSettings<EvictLunRequest,com.google.protobuf.Empty, evictLunOperationSettings()OperationMetadata> Returns the object with the settings used for calls to evictLun. -
listProvisioningQuotasSettings
public PagedCallSettings<ListProvisioningQuotasRequest,ListProvisioningQuotasResponse, listProvisioningQuotasSettings()BareMetalSolutionClient.ListProvisioningQuotasPagedResponse> Returns the object with the settings used for calls to listProvisioningQuotas. -
submitProvisioningConfigSettings
public UnaryCallSettings<SubmitProvisioningConfigRequest,SubmitProvisioningConfigResponse> submitProvisioningConfigSettings()Returns the object with the settings used for calls to submitProvisioningConfig. -
getProvisioningConfigSettings
public UnaryCallSettings<GetProvisioningConfigRequest,ProvisioningConfig> getProvisioningConfigSettings()Returns the object with the settings used for calls to getProvisioningConfig. -
createProvisioningConfigSettings
public UnaryCallSettings<CreateProvisioningConfigRequest,ProvisioningConfig> createProvisioningConfigSettings()Returns the object with the settings used for calls to createProvisioningConfig. -
updateProvisioningConfigSettings
public UnaryCallSettings<UpdateProvisioningConfigRequest,ProvisioningConfig> updateProvisioningConfigSettings()Returns the object with the settings used for calls to updateProvisioningConfig. -
renameNetworkSettings
Returns the object with the settings used for calls to renameNetwork. -
listOSImagesSettings
public PagedCallSettings<ListOSImagesRequest,ListOSImagesResponse, listOSImagesSettings()BareMetalSolutionClient.ListOSImagesPagedResponse> Returns the object with the settings used for calls to listOSImages. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()BareMetalSolutionClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<BareMetalSolutionStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<BareMetalSolutionStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<BareMetalSolutionStubSettings>
-