Package com.google.cloud.clouddms.v1
Class DataMigrationServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<DataMigrationServiceSettings>
com.google.cloud.clouddms.v1.DataMigrationServiceSettings
@Generated("by gapic-generator-java")
public class DataMigrationServiceSettings
extends ClientSettings<DataMigrationServiceSettings>
Settings class to configure an instance of
DataMigrationServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (datamigration.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 getMigrationJob:
// 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
DataMigrationServiceSettings.Builder dataMigrationServiceSettingsBuilder =
DataMigrationServiceSettings.newBuilder();
dataMigrationServiceSettingsBuilder
.getMigrationJobSettings()
.setRetrySettings(
dataMigrationServiceSettingsBuilder
.getMigrationJobSettings()
.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());
DataMigrationServiceSettings dataMigrationServiceSettings =
dataMigrationServiceSettingsBuilder.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 createMigrationJob:
// 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
DataMigrationServiceSettings.Builder dataMigrationServiceSettingsBuilder =
DataMigrationServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
dataMigrationServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DataMigrationServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDataMigrationServiceSettings(DataMigrationServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to applyConversionWorkspace.Returns the object with the settings used for calls to applyConversionWorkspace.Returns the object with the settings used for calls to commitConversionWorkspace.Returns the object with the settings used for calls to commitConversionWorkspace.Returns the object with the settings used for calls to convertConversionWorkspace.Returns the object with the settings used for calls to convertConversionWorkspace.static final DataMigrationServiceSettingsReturns the object with the settings used for calls to createConnectionProfile.Returns the object with the settings used for calls to createConnectionProfile.Returns the object with the settings used for calls to createConversionWorkspace.Returns the object with the settings used for calls to createConversionWorkspace.Returns the object with the settings used for calls to createMappingRule.Returns the object with the settings used for calls to createMigrationJob.Returns the object with the settings used for calls to createMigrationJob.Returns the object with the settings used for calls to createPrivateConnection.Returns the object with the settings used for calls to createPrivateConnection.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 ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteConnectionProfileRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteConnectionProfile.Returns the object with the settings used for calls to deleteConnectionProfile.OperationCallSettings<DeleteConversionWorkspaceRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteConversionWorkspace.Returns the object with the settings used for calls to deleteConversionWorkspace.UnaryCallSettings<DeleteMappingRuleRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteMappingRule.OperationCallSettings<DeleteMigrationJobRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteMigrationJob.Returns the object with the settings used for calls to deleteMigrationJob.OperationCallSettings<DeletePrivateConnectionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deletePrivateConnection.Returns the object with the settings used for calls to deletePrivateConnection.UnaryCallSettings<DescribeConversionWorkspaceRevisionsRequest,DescribeConversionWorkspaceRevisionsResponse> Returns the object with the settings used for calls to describeConversionWorkspaceRevisions.PagedCallSettings<DescribeDatabaseEntitiesRequest,DescribeDatabaseEntitiesResponse, DataMigrationServiceClient.DescribeDatabaseEntitiesPagedResponse> Returns the object with the settings used for calls to describeDatabaseEntities.PagedCallSettings<FetchStaticIpsRequest,FetchStaticIpsResponse, DataMigrationServiceClient.FetchStaticIpsPagedResponse> Returns the object with the settings used for calls to fetchStaticIps.Returns the object with the settings used for calls to generateSshScript.Returns the object with the settings used for calls to generateTcpProxyScript.Returns the object with the settings used for calls to getConnectionProfile.Returns the object with the settings used for calls to getConversionWorkspace.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getMappingRule.Returns the object with the settings used for calls to getMigrationJob.Returns the object with the settings used for calls to getPrivateConnection.Returns the object with the settings used for calls to importMappingRules.Returns the object with the settings used for calls to importMappingRules.PagedCallSettings<ListConnectionProfilesRequest,ListConnectionProfilesResponse, DataMigrationServiceClient.ListConnectionProfilesPagedResponse> Returns the object with the settings used for calls to listConnectionProfiles.PagedCallSettings<ListConversionWorkspacesRequest,ListConversionWorkspacesResponse, DataMigrationServiceClient.ListConversionWorkspacesPagedResponse> Returns the object with the settings used for calls to listConversionWorkspaces.PagedCallSettings<ListMappingRulesRequest,ListMappingRulesResponse, DataMigrationServiceClient.ListMappingRulesPagedResponse> Returns the object with the settings used for calls to listMappingRules.PagedCallSettings<ListMigrationJobsRequest,ListMigrationJobsResponse, DataMigrationServiceClient.ListMigrationJobsPagedResponse> Returns the object with the settings used for calls to listMigrationJobs.PagedCallSettings<ListPrivateConnectionsRequest,ListPrivateConnectionsResponse, DataMigrationServiceClient.ListPrivateConnectionsPagedResponse> Returns the object with the settings used for calls to listPrivateConnections.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to promoteMigrationJob.Returns the object with the settings used for calls to promoteMigrationJob.Returns the object with the settings used for calls to restartMigrationJob.Returns the object with the settings used for calls to restartMigrationJob.Returns the object with the settings used for calls to resumeMigrationJob.Returns the object with the settings used for calls to resumeMigrationJob.Returns the object with the settings used for calls to rollbackConversionWorkspace.Returns the object with the settings used for calls to rollbackConversionWorkspace.Returns the object with the settings used for calls to searchBackgroundJobs.Returns the object with the settings used for calls to seedConversionWorkspace.Returns the object with the settings used for calls to seedConversionWorkspace.Returns the object with the settings used for calls to startMigrationJob.Returns the object with the settings used for calls to startMigrationJob.Returns the object with the settings used for calls to stopMigrationJob.Returns the object with the settings used for calls to stopMigrationJob.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateConnectionProfile.Returns the object with the settings used for calls to updateConnectionProfile.Returns the object with the settings used for calls to updateConversionWorkspace.Returns the object with the settings used for calls to updateConversionWorkspace.Returns the object with the settings used for calls to updateMigrationJob.Returns the object with the settings used for calls to updateMigrationJob.Returns the object with the settings used for calls to verifyMigrationJob.Returns the object with the settings used for calls to verifyMigrationJob.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
-
DataMigrationServiceSettings
protected DataMigrationServiceSettings(DataMigrationServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listMigrationJobsSettings
public PagedCallSettings<ListMigrationJobsRequest,ListMigrationJobsResponse, listMigrationJobsSettings()DataMigrationServiceClient.ListMigrationJobsPagedResponse> Returns the object with the settings used for calls to listMigrationJobs. -
getMigrationJobSettings
Returns the object with the settings used for calls to getMigrationJob. -
createMigrationJobSettings
Returns the object with the settings used for calls to createMigrationJob. -
createMigrationJobOperationSettings
public OperationCallSettings<CreateMigrationJobRequest,MigrationJob, createMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createMigrationJob. -
updateMigrationJobSettings
Returns the object with the settings used for calls to updateMigrationJob. -
updateMigrationJobOperationSettings
public OperationCallSettings<UpdateMigrationJobRequest,MigrationJob, updateMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateMigrationJob. -
deleteMigrationJobSettings
Returns the object with the settings used for calls to deleteMigrationJob. -
deleteMigrationJobOperationSettings
public OperationCallSettings<DeleteMigrationJobRequest,com.google.protobuf.Empty, deleteMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteMigrationJob. -
startMigrationJobSettings
Returns the object with the settings used for calls to startMigrationJob. -
startMigrationJobOperationSettings
public OperationCallSettings<StartMigrationJobRequest,MigrationJob, startMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to startMigrationJob. -
stopMigrationJobSettings
Returns the object with the settings used for calls to stopMigrationJob. -
stopMigrationJobOperationSettings
public OperationCallSettings<StopMigrationJobRequest,MigrationJob, stopMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to stopMigrationJob. -
resumeMigrationJobSettings
Returns the object with the settings used for calls to resumeMigrationJob. -
resumeMigrationJobOperationSettings
public OperationCallSettings<ResumeMigrationJobRequest,MigrationJob, resumeMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to resumeMigrationJob. -
promoteMigrationJobSettings
Returns the object with the settings used for calls to promoteMigrationJob. -
promoteMigrationJobOperationSettings
public OperationCallSettings<PromoteMigrationJobRequest,MigrationJob, promoteMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to promoteMigrationJob. -
verifyMigrationJobSettings
Returns the object with the settings used for calls to verifyMigrationJob. -
verifyMigrationJobOperationSettings
public OperationCallSettings<VerifyMigrationJobRequest,MigrationJob, verifyMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to verifyMigrationJob. -
restartMigrationJobSettings
Returns the object with the settings used for calls to restartMigrationJob. -
restartMigrationJobOperationSettings
public OperationCallSettings<RestartMigrationJobRequest,MigrationJob, restartMigrationJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to restartMigrationJob. -
generateSshScriptSettings
Returns the object with the settings used for calls to generateSshScript. -
generateTcpProxyScriptSettings
public UnaryCallSettings<GenerateTcpProxyScriptRequest,TcpProxyScript> generateTcpProxyScriptSettings()Returns the object with the settings used for calls to generateTcpProxyScript. -
listConnectionProfilesSettings
public PagedCallSettings<ListConnectionProfilesRequest,ListConnectionProfilesResponse, listConnectionProfilesSettings()DataMigrationServiceClient.ListConnectionProfilesPagedResponse> Returns the object with the settings used for calls to listConnectionProfiles. -
getConnectionProfileSettings
public UnaryCallSettings<GetConnectionProfileRequest,ConnectionProfile> getConnectionProfileSettings()Returns the object with the settings used for calls to getConnectionProfile. -
createConnectionProfileSettings
public UnaryCallSettings<CreateConnectionProfileRequest,Operation> createConnectionProfileSettings()Returns the object with the settings used for calls to createConnectionProfile. -
createConnectionProfileOperationSettings
public OperationCallSettings<CreateConnectionProfileRequest,ConnectionProfile, createConnectionProfileOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createConnectionProfile. -
updateConnectionProfileSettings
public UnaryCallSettings<UpdateConnectionProfileRequest,Operation> updateConnectionProfileSettings()Returns the object with the settings used for calls to updateConnectionProfile. -
updateConnectionProfileOperationSettings
public OperationCallSettings<UpdateConnectionProfileRequest,ConnectionProfile, updateConnectionProfileOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateConnectionProfile. -
deleteConnectionProfileSettings
public UnaryCallSettings<DeleteConnectionProfileRequest,Operation> deleteConnectionProfileSettings()Returns the object with the settings used for calls to deleteConnectionProfile. -
deleteConnectionProfileOperationSettings
public OperationCallSettings<DeleteConnectionProfileRequest,com.google.protobuf.Empty, deleteConnectionProfileOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteConnectionProfile. -
createPrivateConnectionSettings
public UnaryCallSettings<CreatePrivateConnectionRequest,Operation> createPrivateConnectionSettings()Returns the object with the settings used for calls to createPrivateConnection. -
createPrivateConnectionOperationSettings
public OperationCallSettings<CreatePrivateConnectionRequest,PrivateConnection, createPrivateConnectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createPrivateConnection. -
getPrivateConnectionSettings
public UnaryCallSettings<GetPrivateConnectionRequest,PrivateConnection> getPrivateConnectionSettings()Returns the object with the settings used for calls to getPrivateConnection. -
listPrivateConnectionsSettings
public PagedCallSettings<ListPrivateConnectionsRequest,ListPrivateConnectionsResponse, listPrivateConnectionsSettings()DataMigrationServiceClient.ListPrivateConnectionsPagedResponse> Returns the object with the settings used for calls to listPrivateConnections. -
deletePrivateConnectionSettings
public UnaryCallSettings<DeletePrivateConnectionRequest,Operation> deletePrivateConnectionSettings()Returns the object with the settings used for calls to deletePrivateConnection. -
deletePrivateConnectionOperationSettings
public OperationCallSettings<DeletePrivateConnectionRequest,com.google.protobuf.Empty, deletePrivateConnectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deletePrivateConnection. -
getConversionWorkspaceSettings
public UnaryCallSettings<GetConversionWorkspaceRequest,ConversionWorkspace> getConversionWorkspaceSettings()Returns the object with the settings used for calls to getConversionWorkspace. -
listConversionWorkspacesSettings
public PagedCallSettings<ListConversionWorkspacesRequest,ListConversionWorkspacesResponse, listConversionWorkspacesSettings()DataMigrationServiceClient.ListConversionWorkspacesPagedResponse> Returns the object with the settings used for calls to listConversionWorkspaces. -
createConversionWorkspaceSettings
public UnaryCallSettings<CreateConversionWorkspaceRequest,Operation> createConversionWorkspaceSettings()Returns the object with the settings used for calls to createConversionWorkspace. -
createConversionWorkspaceOperationSettings
public OperationCallSettings<CreateConversionWorkspaceRequest,ConversionWorkspace, createConversionWorkspaceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createConversionWorkspace. -
updateConversionWorkspaceSettings
public UnaryCallSettings<UpdateConversionWorkspaceRequest,Operation> updateConversionWorkspaceSettings()Returns the object with the settings used for calls to updateConversionWorkspace. -
updateConversionWorkspaceOperationSettings
public OperationCallSettings<UpdateConversionWorkspaceRequest,ConversionWorkspace, updateConversionWorkspaceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateConversionWorkspace. -
deleteConversionWorkspaceSettings
public UnaryCallSettings<DeleteConversionWorkspaceRequest,Operation> deleteConversionWorkspaceSettings()Returns the object with the settings used for calls to deleteConversionWorkspace. -
deleteConversionWorkspaceOperationSettings
public OperationCallSettings<DeleteConversionWorkspaceRequest,com.google.protobuf.Empty, deleteConversionWorkspaceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteConversionWorkspace. -
createMappingRuleSettings
Returns the object with the settings used for calls to createMappingRule. -
deleteMappingRuleSettings
public UnaryCallSettings<DeleteMappingRuleRequest,com.google.protobuf.Empty> deleteMappingRuleSettings()Returns the object with the settings used for calls to deleteMappingRule. -
listMappingRulesSettings
public PagedCallSettings<ListMappingRulesRequest,ListMappingRulesResponse, listMappingRulesSettings()DataMigrationServiceClient.ListMappingRulesPagedResponse> Returns the object with the settings used for calls to listMappingRules. -
getMappingRuleSettings
Returns the object with the settings used for calls to getMappingRule. -
seedConversionWorkspaceSettings
public UnaryCallSettings<SeedConversionWorkspaceRequest,Operation> seedConversionWorkspaceSettings()Returns the object with the settings used for calls to seedConversionWorkspace. -
seedConversionWorkspaceOperationSettings
public OperationCallSettings<SeedConversionWorkspaceRequest,ConversionWorkspace, seedConversionWorkspaceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to seedConversionWorkspace. -
importMappingRulesSettings
Returns the object with the settings used for calls to importMappingRules. -
importMappingRulesOperationSettings
public OperationCallSettings<ImportMappingRulesRequest,ConversionWorkspace, importMappingRulesOperationSettings()OperationMetadata> Returns the object with the settings used for calls to importMappingRules. -
convertConversionWorkspaceSettings
public UnaryCallSettings<ConvertConversionWorkspaceRequest,Operation> convertConversionWorkspaceSettings()Returns the object with the settings used for calls to convertConversionWorkspace. -
convertConversionWorkspaceOperationSettings
public OperationCallSettings<ConvertConversionWorkspaceRequest,ConversionWorkspace, convertConversionWorkspaceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to convertConversionWorkspace. -
commitConversionWorkspaceSettings
public UnaryCallSettings<CommitConversionWorkspaceRequest,Operation> commitConversionWorkspaceSettings()Returns the object with the settings used for calls to commitConversionWorkspace. -
commitConversionWorkspaceOperationSettings
public OperationCallSettings<CommitConversionWorkspaceRequest,ConversionWorkspace, commitConversionWorkspaceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to commitConversionWorkspace. -
rollbackConversionWorkspaceSettings
public UnaryCallSettings<RollbackConversionWorkspaceRequest,Operation> rollbackConversionWorkspaceSettings()Returns the object with the settings used for calls to rollbackConversionWorkspace. -
rollbackConversionWorkspaceOperationSettings
public OperationCallSettings<RollbackConversionWorkspaceRequest,ConversionWorkspace, rollbackConversionWorkspaceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to rollbackConversionWorkspace. -
applyConversionWorkspaceSettings
public UnaryCallSettings<ApplyConversionWorkspaceRequest,Operation> applyConversionWorkspaceSettings()Returns the object with the settings used for calls to applyConversionWorkspace. -
applyConversionWorkspaceOperationSettings
public OperationCallSettings<ApplyConversionWorkspaceRequest,ConversionWorkspace, applyConversionWorkspaceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to applyConversionWorkspace. -
describeDatabaseEntitiesSettings
public PagedCallSettings<DescribeDatabaseEntitiesRequest,DescribeDatabaseEntitiesResponse, describeDatabaseEntitiesSettings()DataMigrationServiceClient.DescribeDatabaseEntitiesPagedResponse> Returns the object with the settings used for calls to describeDatabaseEntities. -
searchBackgroundJobsSettings
public UnaryCallSettings<SearchBackgroundJobsRequest,SearchBackgroundJobsResponse> searchBackgroundJobsSettings()Returns the object with the settings used for calls to searchBackgroundJobs. -
describeConversionWorkspaceRevisionsSettings
public UnaryCallSettings<DescribeConversionWorkspaceRevisionsRequest,DescribeConversionWorkspaceRevisionsResponse> describeConversionWorkspaceRevisionsSettings()Returns the object with the settings used for calls to describeConversionWorkspaceRevisions. -
fetchStaticIpsSettings
public PagedCallSettings<FetchStaticIpsRequest,FetchStaticIpsResponse, fetchStaticIpsSettings()DataMigrationServiceClient.FetchStaticIpsPagedResponse> Returns the object with the settings used for calls to fetchStaticIps. -
create
public static final DataMigrationServiceSettings create(DataMigrationServiceStubSettings 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<DataMigrationServiceSettings>
-