public class RapidMigrationAssessmentStubSettings extends StubSettings<RapidMigrationAssessmentStubSettings>Settings class to configure an instance of RapidMigrationAssessmentStub.
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 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
RapidMigrationAssessmentStubSettings.Builder rapidMigrationAssessmentSettingsBuilder =
RapidMigrationAssessmentStubSettings.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());
RapidMigrationAssessmentStubSettings rapidMigrationAssessmentSettings =
rapidMigrationAssessmentSettingsBuilder.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 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
RapidMigrationAssessmentStubSettings.Builder rapidMigrationAssessmentSettingsBuilder =
RapidMigrationAssessmentStubSettings.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();
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 RapidMigrationAssessmentStubSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
RapidMigrationAssessmentStubSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static RapidMigrationAssessmentStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
RapidMigrationAssessmentStubSettings.Builder |
|
newHttpJsonBuilder()
public static RapidMigrationAssessmentStubSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
RapidMigrationAssessmentStubSettings.Builder |
|
Constructors
RapidMigrationAssessmentStubSettings(RapidMigrationAssessmentStubSettings.Builder settingsBuilder)
protected RapidMigrationAssessmentStubSettings(RapidMigrationAssessmentStubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
RapidMigrationAssessmentStubSettings.Builder |
Methods
createAnnotationOperationSettings()
public OperationCallSettings<CreateAnnotationRequest,Annotation,OperationMetadata> createAnnotationOperationSettings()Returns the object with the settings used for calls to createAnnotation.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateAnnotationRequest,Annotation,OperationMetadata> |
|
createAnnotationSettings()
public UnaryCallSettings<CreateAnnotationRequest,Operation> createAnnotationSettings()Returns the object with the settings used for calls to createAnnotation.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateAnnotationRequest,Operation> |
|
createCollectorOperationSettings()
public OperationCallSettings<CreateCollectorRequest,Collector,OperationMetadata> createCollectorOperationSettings()Returns the object with the settings used for calls to createCollector.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateCollectorRequest,Collector,OperationMetadata> |
|
createCollectorSettings()
public UnaryCallSettings<CreateCollectorRequest,Operation> createCollectorSettings()Returns the object with the settings used for calls to createCollector.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateCollectorRequest,Operation> |
|
createStub()
public RapidMigrationAssessmentStub createStub()| Returns | |
|---|---|
| Type | Description |
RapidMigrationAssessmentStub |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
deleteCollectorOperationSettings()
public OperationCallSettings<DeleteCollectorRequest,Collector,OperationMetadata> deleteCollectorOperationSettings()Returns the object with the settings used for calls to deleteCollector.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteCollectorRequest,Collector,OperationMetadata> |
|
deleteCollectorSettings()
public UnaryCallSettings<DeleteCollectorRequest,Operation> deleteCollectorSettings()Returns the object with the settings used for calls to deleteCollector.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteCollectorRequest,Operation> |
|
getAnnotationSettings()
public UnaryCallSettings<GetAnnotationRequest,Annotation> getAnnotationSettings()Returns the object with the settings used for calls to getAnnotation.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetAnnotationRequest,Annotation> |
|
getCollectorSettings()
public UnaryCallSettings<GetCollectorRequest,Collector> getCollectorSettings()Returns the object with the settings used for calls to getCollector.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetCollectorRequest,Collector> |
|
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> |
|
getServiceName()
public String getServiceName()Returns the default service name.
| Returns | |
|---|---|
| Type | Description |
String |
|
listCollectorsSettings()
public PagedCallSettings<ListCollectorsRequest,ListCollectorsResponse,RapidMigrationAssessmentClient.ListCollectorsPagedResponse> listCollectorsSettings()Returns the object with the settings used for calls to listCollectors.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListCollectorsRequest,ListCollectorsResponse,ListCollectorsPagedResponse> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,RapidMigrationAssessmentClient.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> |
|
pauseCollectorOperationSettings()
public OperationCallSettings<PauseCollectorRequest,Collector,OperationMetadata> pauseCollectorOperationSettings()Returns the object with the settings used for calls to pauseCollector.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<PauseCollectorRequest,Collector,OperationMetadata> |
|
pauseCollectorSettings()
public UnaryCallSettings<PauseCollectorRequest,Operation> pauseCollectorSettings()Returns the object with the settings used for calls to pauseCollector.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PauseCollectorRequest,Operation> |
|
registerCollectorOperationSettings()
public OperationCallSettings<RegisterCollectorRequest,Collector,OperationMetadata> registerCollectorOperationSettings()Returns the object with the settings used for calls to registerCollector.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<RegisterCollectorRequest,Collector,OperationMetadata> |
|
registerCollectorSettings()
public UnaryCallSettings<RegisterCollectorRequest,Operation> registerCollectorSettings()Returns the object with the settings used for calls to registerCollector.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RegisterCollectorRequest,Operation> |
|
resumeCollectorOperationSettings()
public OperationCallSettings<ResumeCollectorRequest,Collector,OperationMetadata> resumeCollectorOperationSettings()Returns the object with the settings used for calls to resumeCollector.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ResumeCollectorRequest,Collector,OperationMetadata> |
|
resumeCollectorSettings()
public UnaryCallSettings<ResumeCollectorRequest,Operation> resumeCollectorSettings()Returns the object with the settings used for calls to resumeCollector.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ResumeCollectorRequest,Operation> |
|
toBuilder()
public RapidMigrationAssessmentStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
RapidMigrationAssessmentStubSettings.Builder |
|
updateCollectorOperationSettings()
public OperationCallSettings<UpdateCollectorRequest,Collector,OperationMetadata> updateCollectorOperationSettings()Returns the object with the settings used for calls to updateCollector.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateCollectorRequest,Collector,OperationMetadata> |
|
updateCollectorSettings()
public UnaryCallSettings<UpdateCollectorRequest,Operation> updateCollectorSettings()Returns the object with the settings used for calls to updateCollector.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateCollectorRequest,Operation> |
|