Class RapidMigrationAssessmentSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<RapidMigrationAssessmentSettings>
com.google.cloud.rapidmigrationassessment.v1.RapidMigrationAssessmentSettings
@Generated("by gapic-generator-java")
public class RapidMigrationAssessmentSettings
extends ClientSettings<RapidMigrationAssessmentSettings>
Settings class to configure an instance of
RapidMigrationAssessmentClient.
The default instance has everything set to sensible defaults:
- The default service address (rapidmigrationassessment.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 getAnnotation:
// 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
RapidMigrationAssessmentSettings.Builder rapidMigrationAssessmentSettingsBuilder =
RapidMigrationAssessmentSettings.newBuilder();
rapidMigrationAssessmentSettingsBuilder
.getAnnotationSettings()
.setRetrySettings(
rapidMigrationAssessmentSettingsBuilder
.getAnnotationSettings()
.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());
RapidMigrationAssessmentSettings rapidMigrationAssessmentSettings =
rapidMigrationAssessmentSettingsBuilder.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 createCollector:
// 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
RapidMigrationAssessmentSettings.Builder rapidMigrationAssessmentSettingsBuilder =
RapidMigrationAssessmentSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
rapidMigrationAssessmentSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for RapidMigrationAssessmentSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedRapidMigrationAssessmentSettings(RapidMigrationAssessmentSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final RapidMigrationAssessmentSettingsReturns the object with the settings used for calls to createAnnotation.Returns the object with the settings used for calls to createAnnotation.Returns the object with the settings used for calls to createCollector.Returns the object with the settings used for calls to createCollector.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 TransportChannelProviderReturns the object with the settings used for calls to deleteCollector.Returns the object with the settings used for calls to deleteCollector.Returns the object with the settings used for calls to getAnnotation.Returns the object with the settings used for calls to getCollector.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListCollectorsRequest,ListCollectorsResponse, RapidMigrationAssessmentClient.ListCollectorsPagedResponse> Returns the object with the settings used for calls to listCollectors.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, RapidMigrationAssessmentClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.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 pauseCollector.Returns the object with the settings used for calls to pauseCollector.Returns the object with the settings used for calls to registerCollector.Returns the object with the settings used for calls to registerCollector.Returns the object with the settings used for calls to resumeCollector.Returns the object with the settings used for calls to resumeCollector.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateCollector.Returns the object with the settings used for calls to updateCollector.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
RapidMigrationAssessmentSettings
protected RapidMigrationAssessmentSettings(RapidMigrationAssessmentSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createCollectorSettings
Returns the object with the settings used for calls to createCollector. -
createCollectorOperationSettings
public OperationCallSettings<CreateCollectorRequest,Collector, createCollectorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createCollector. -
createAnnotationSettings
Returns the object with the settings used for calls to createAnnotation. -
createAnnotationOperationSettings
public OperationCallSettings<CreateAnnotationRequest,Annotation, createAnnotationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createAnnotation. -
getAnnotationSettings
Returns the object with the settings used for calls to getAnnotation. -
listCollectorsSettings
public PagedCallSettings<ListCollectorsRequest,ListCollectorsResponse, listCollectorsSettings()RapidMigrationAssessmentClient.ListCollectorsPagedResponse> Returns the object with the settings used for calls to listCollectors. -
getCollectorSettings
Returns the object with the settings used for calls to getCollector. -
updateCollectorSettings
Returns the object with the settings used for calls to updateCollector. -
updateCollectorOperationSettings
public OperationCallSettings<UpdateCollectorRequest,Collector, updateCollectorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateCollector. -
deleteCollectorSettings
Returns the object with the settings used for calls to deleteCollector. -
deleteCollectorOperationSettings
public OperationCallSettings<DeleteCollectorRequest,Collector, deleteCollectorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteCollector. -
resumeCollectorSettings
Returns the object with the settings used for calls to resumeCollector. -
resumeCollectorOperationSettings
public OperationCallSettings<ResumeCollectorRequest,Collector, resumeCollectorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to resumeCollector. -
registerCollectorSettings
Returns the object with the settings used for calls to registerCollector. -
registerCollectorOperationSettings
public OperationCallSettings<RegisterCollectorRequest,Collector, registerCollectorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to registerCollector. -
pauseCollectorSettings
Returns the object with the settings used for calls to pauseCollector. -
pauseCollectorOperationSettings
public OperationCallSettings<PauseCollectorRequest,Collector, pauseCollectorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to pauseCollector. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()RapidMigrationAssessmentClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
public static final RapidMigrationAssessmentSettings create(RapidMigrationAssessmentStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default 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
-
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 classClientSettings<RapidMigrationAssessmentSettings>
-