Package com.google.cloud.aiplatform.v1
Class MigrationServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<MigrationServiceSettings>
com.google.cloud.aiplatform.v1.MigrationServiceSettings
@Generated("by gapic-generator-java")
public class MigrationServiceSettings
extends ClientSettings<MigrationServiceSettings>
Settings class to configure an instance of
MigrationServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (aiplatform.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 getLocation:
// 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
MigrationServiceSettings.Builder migrationServiceSettingsBuilder =
MigrationServiceSettings.newBuilder();
migrationServiceSettingsBuilder
.getLocationSettings()
.setRetrySettings(
migrationServiceSettingsBuilder
.getLocationSettings()
.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());
MigrationServiceSettings migrationServiceSettings = migrationServiceSettingsBuilder.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 batchMigrateResources:
// 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
MigrationServiceSettings.Builder migrationServiceSettingsBuilder =
MigrationServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
migrationServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for MigrationServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedMigrationServiceSettings(MigrationServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<BatchMigrateResourcesRequest,BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> Returns the object with the settings used for calls to batchMigrateResources.Returns the object with the settings used for calls to batchMigrateResources.static final MigrationServiceSettingsReturns 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 ChannelProvider for this service.static TransportChannelProviderstatic StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, MigrationServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.PagedCallSettings<SearchMigratableResourcesRequest,SearchMigratableResourcesResponse, MigrationServiceClient.SearchMigratableResourcesPagedResponse> Returns the object with the settings used for calls to searchMigratableResources.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.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
-
MigrationServiceSettings
protected MigrationServiceSettings(MigrationServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
searchMigratableResourcesSettings
public PagedCallSettings<SearchMigratableResourcesRequest,SearchMigratableResourcesResponse, searchMigratableResourcesSettings()MigrationServiceClient.SearchMigratableResourcesPagedResponse> Returns the object with the settings used for calls to searchMigratableResources. -
batchMigrateResourcesSettings
Returns the object with the settings used for calls to batchMigrateResources. -
batchMigrateResourcesOperationSettings
public OperationCallSettings<BatchMigrateResourcesRequest,BatchMigrateResourcesResponse, batchMigrateResourcesOperationSettings()BatchMigrateResourcesOperationMetadata> Returns the object with the settings used for calls to batchMigrateResources. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()MigrationServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final MigrationServiceSettings create(MigrationServiceStubSettings 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 ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new 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<MigrationServiceSettings>
-