Class DataMigrationServiceStubSettings (2.57.0)

public class DataMigrationServiceStubSettings extends StubSettings<DataMigrationServiceStubSettings>

Settings class to configure an instance of DataMigrationServiceStub.

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 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
 DataMigrationServiceStubSettings.Builder dataMigrationServiceSettingsBuilder =
     DataMigrationServiceStubSettings.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());
 DataMigrationServiceStubSettings dataMigrationServiceSettings =
     dataMigrationServiceSettingsBuilder.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 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
 DataMigrationServiceStubSettings.Builder dataMigrationServiceSettingsBuilder =
     DataMigrationServiceStubSettings.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();
 

Inheritance

java.lang.Object > StubSettings > DataMigrationServiceStubSettings

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default 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 DataMigrationServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
DataMigrationServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DataMigrationServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DataMigrationServiceStubSettings.Builder

Constructors

DataMigrationServiceStubSettings(DataMigrationServiceStubSettings.Builder settingsBuilder)

protected DataMigrationServiceStubSettings(DataMigrationServiceStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder DataMigrationServiceStubSettings.Builder

Methods

applyConversionWorkspaceOperationSettings()

public OperationCallSettings<ApplyConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> applyConversionWorkspaceOperationSettings()

Returns the object with the settings used for calls to applyConversionWorkspace.

applyConversionWorkspaceSettings()

public UnaryCallSettings<ApplyConversionWorkspaceRequest,Operation> applyConversionWorkspaceSettings()

Returns the object with the settings used for calls to applyConversionWorkspace.

commitConversionWorkspaceOperationSettings()

public OperationCallSettings<CommitConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> commitConversionWorkspaceOperationSettings()

Returns the object with the settings used for calls to commitConversionWorkspace.

commitConversionWorkspaceSettings()

public UnaryCallSettings<CommitConversionWorkspaceRequest,Operation> commitConversionWorkspaceSettings()

Returns the object with the settings used for calls to commitConversionWorkspace.

convertConversionWorkspaceOperationSettings()

public OperationCallSettings<ConvertConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> convertConversionWorkspaceOperationSettings()

Returns the object with the settings used for calls to convertConversionWorkspace.

convertConversionWorkspaceSettings()

public UnaryCallSettings<ConvertConversionWorkspaceRequest,Operation> convertConversionWorkspaceSettings()

Returns the object with the settings used for calls to convertConversionWorkspace.

createConnectionProfileOperationSettings()

public OperationCallSettings<CreateConnectionProfileRequest,ConnectionProfile,OperationMetadata> createConnectionProfileOperationSettings()

Returns the object with the settings used for calls to createConnectionProfile.

createConnectionProfileSettings()

public UnaryCallSettings<CreateConnectionProfileRequest,Operation> createConnectionProfileSettings()

Returns the object with the settings used for calls to createConnectionProfile.

createConversionWorkspaceOperationSettings()

public OperationCallSettings<CreateConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> createConversionWorkspaceOperationSettings()

Returns the object with the settings used for calls to createConversionWorkspace.

createConversionWorkspaceSettings()

public UnaryCallSettings<CreateConversionWorkspaceRequest,Operation> createConversionWorkspaceSettings()

Returns the object with the settings used for calls to createConversionWorkspace.

createMappingRuleSettings()

public UnaryCallSettings<CreateMappingRuleRequest,MappingRule> createMappingRuleSettings()

Returns the object with the settings used for calls to createMappingRule.

createMigrationJobOperationSettings()

public OperationCallSettings<CreateMigrationJobRequest,MigrationJob,OperationMetadata> createMigrationJobOperationSettings()

Returns the object with the settings used for calls to createMigrationJob.

createMigrationJobSettings()

public UnaryCallSettings<CreateMigrationJobRequest,Operation> createMigrationJobSettings()

Returns the object with the settings used for calls to createMigrationJob.

createPrivateConnectionOperationSettings()

public OperationCallSettings<CreatePrivateConnectionRequest,PrivateConnection,OperationMetadata> createPrivateConnectionOperationSettings()

Returns the object with the settings used for calls to createPrivateConnection.

createPrivateConnectionSettings()

public UnaryCallSettings<CreatePrivateConnectionRequest,Operation> createPrivateConnectionSettings()

Returns the object with the settings used for calls to createPrivateConnection.

createStub()

public DataMigrationServiceStub createStub()
Returns
Type Description
DataMigrationServiceStub
Exceptions
Type Description
IOException

deleteConnectionProfileOperationSettings()

public OperationCallSettings<DeleteConnectionProfileRequest,Empty,OperationMetadata> deleteConnectionProfileOperationSettings()

Returns the object with the settings used for calls to deleteConnectionProfile.

deleteConnectionProfileSettings()

public UnaryCallSettings<DeleteConnectionProfileRequest,Operation> deleteConnectionProfileSettings()

Returns the object with the settings used for calls to deleteConnectionProfile.

deleteConversionWorkspaceOperationSettings()

public OperationCallSettings<DeleteConversionWorkspaceRequest,Empty,OperationMetadata> deleteConversionWorkspaceOperationSettings()

Returns the object with the settings used for calls to deleteConversionWorkspace.

deleteConversionWorkspaceSettings()

public UnaryCallSettings<DeleteConversionWorkspaceRequest,Operation> deleteConversionWorkspaceSettings()

Returns the object with the settings used for calls to deleteConversionWorkspace.

deleteMappingRuleSettings()

public UnaryCallSettings<DeleteMappingRuleRequest,Empty> deleteMappingRuleSettings()

Returns the object with the settings used for calls to deleteMappingRule.

deleteMigrationJobOperationSettings()

public OperationCallSettings<DeleteMigrationJobRequest,Empty,OperationMetadata> deleteMigrationJobOperationSettings()

Returns the object with the settings used for calls to deleteMigrationJob.

deleteMigrationJobSettings()

public UnaryCallSettings<DeleteMigrationJobRequest,Operation> deleteMigrationJobSettings()

Returns the object with the settings used for calls to deleteMigrationJob.

deletePrivateConnectionOperationSettings()

public OperationCallSettings<DeletePrivateConnectionRequest,Empty,OperationMetadata> deletePrivateConnectionOperationSettings()

Returns the object with the settings used for calls to deletePrivateConnection.

deletePrivateConnectionSettings()

public UnaryCallSettings<DeletePrivateConnectionRequest,Operation> deletePrivateConnectionSettings()

Returns the object with the settings used for calls to deletePrivateConnection.

describeConversionWorkspaceRevisionsSettings()

public UnaryCallSettings<DescribeConversionWorkspaceRevisionsRequest,DescribeConversionWorkspaceRevisionsResponse> describeConversionWorkspaceRevisionsSettings()

Returns the object with the settings used for calls to describeConversionWorkspaceRevisions.

describeDatabaseEntitiesSettings()

public PagedCallSettings<DescribeDatabaseEntitiesRequest,DescribeDatabaseEntitiesResponse,DataMigrationServiceClient.DescribeDatabaseEntitiesPagedResponse> describeDatabaseEntitiesSettings()

Returns the object with the settings used for calls to describeDatabaseEntities.

fetchStaticIpsSettings()

public PagedCallSettings<FetchStaticIpsRequest,FetchStaticIpsResponse,DataMigrationServiceClient.FetchStaticIpsPagedResponse> fetchStaticIpsSettings()

Returns the object with the settings used for calls to fetchStaticIps.

generateSshScriptSettings()

public UnaryCallSettings<GenerateSshScriptRequest,SshScript> 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.

getConnectionProfileSettings()

public UnaryCallSettings<GetConnectionProfileRequest,ConnectionProfile> getConnectionProfileSettings()

Returns the object with the settings used for calls to getConnectionProfile.

getConversionWorkspaceSettings()

public UnaryCallSettings<GetConversionWorkspaceRequest,ConversionWorkspace> getConversionWorkspaceSettings()

Returns the object with the settings used for calls to getConversionWorkspace.

getMappingRuleSettings()

public UnaryCallSettings<GetMappingRuleRequest,MappingRule> getMappingRuleSettings()

Returns the object with the settings used for calls to getMappingRule.

getMigrationJobSettings()

public UnaryCallSettings<GetMigrationJobRequest,MigrationJob> getMigrationJobSettings()

Returns the object with the settings used for calls to getMigrationJob.

getPrivateConnectionSettings()

public UnaryCallSettings<GetPrivateConnectionRequest,PrivateConnection> getPrivateConnectionSettings()

Returns the object with the settings used for calls to getPrivateConnection.

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

importMappingRulesOperationSettings()

public OperationCallSettings<ImportMappingRulesRequest,ConversionWorkspace,OperationMetadata> importMappingRulesOperationSettings()

Returns the object with the settings used for calls to importMappingRules.

importMappingRulesSettings()

public UnaryCallSettings<ImportMappingRulesRequest,Operation> importMappingRulesSettings()

Returns the object with the settings used for calls to importMappingRules.

listConnectionProfilesSettings()

public PagedCallSettings<ListConnectionProfilesRequest,ListConnectionProfilesResponse,DataMigrationServiceClient.ListConnectionProfilesPagedResponse> listConnectionProfilesSettings()

Returns the object with the settings used for calls to listConnectionProfiles.

listConversionWorkspacesSettings()

public PagedCallSettings<ListConversionWorkspacesRequest,ListConversionWorkspacesResponse,DataMigrationServiceClient.ListConversionWorkspacesPagedResponse> listConversionWorkspacesSettings()

Returns the object with the settings used for calls to listConversionWorkspaces.

listMappingRulesSettings()

public PagedCallSettings<ListMappingRulesRequest,ListMappingRulesResponse,DataMigrationServiceClient.ListMappingRulesPagedResponse> listMappingRulesSettings()

Returns the object with the settings used for calls to listMappingRules.

listMigrationJobsSettings()

public PagedCallSettings<ListMigrationJobsRequest,ListMigrationJobsResponse,DataMigrationServiceClient.ListMigrationJobsPagedResponse> listMigrationJobsSettings()

Returns the object with the settings used for calls to listMigrationJobs.

listPrivateConnectionsSettings()

public PagedCallSettings<ListPrivateConnectionsRequest,ListPrivateConnectionsResponse,DataMigrationServiceClient.ListPrivateConnectionsPagedResponse> listPrivateConnectionsSettings()

Returns the object with the settings used for calls to listPrivateConnections.

promoteMigrationJobOperationSettings()

public OperationCallSettings<PromoteMigrationJobRequest,MigrationJob,OperationMetadata> promoteMigrationJobOperationSettings()

Returns the object with the settings used for calls to promoteMigrationJob.

promoteMigrationJobSettings()

public UnaryCallSettings<PromoteMigrationJobRequest,Operation> promoteMigrationJobSettings()

Returns the object with the settings used for calls to promoteMigrationJob.

restartMigrationJobOperationSettings()

public OperationCallSettings<RestartMigrationJobRequest,MigrationJob,OperationMetadata> restartMigrationJobOperationSettings()

Returns the object with the settings used for calls to restartMigrationJob.

restartMigrationJobSettings()

public UnaryCallSettings<RestartMigrationJobRequest,Operation> restartMigrationJobSettings()

Returns the object with the settings used for calls to restartMigrationJob.

resumeMigrationJobOperationSettings()

public OperationCallSettings<ResumeMigrationJobRequest,MigrationJob,OperationMetadata> resumeMigrationJobOperationSettings()

Returns the object with the settings used for calls to resumeMigrationJob.

resumeMigrationJobSettings()

public UnaryCallSettings<ResumeMigrationJobRequest,Operation> resumeMigrationJobSettings()

Returns the object with the settings used for calls to resumeMigrationJob.

rollbackConversionWorkspaceOperationSettings()

public OperationCallSettings<RollbackConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> rollbackConversionWorkspaceOperationSettings()

Returns the object with the settings used for calls to rollbackConversionWorkspace.

rollbackConversionWorkspaceSettings()

public UnaryCallSettings<RollbackConversionWorkspaceRequest,Operation> rollbackConversionWorkspaceSettings()

Returns the object with the settings used for calls to rollbackConversionWorkspace.

searchBackgroundJobsSettings()

public UnaryCallSettings<SearchBackgroundJobsRequest,SearchBackgroundJobsResponse> searchBackgroundJobsSettings()

Returns the object with the settings used for calls to searchBackgroundJobs.

seedConversionWorkspaceOperationSettings()

public OperationCallSettings<SeedConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> seedConversionWorkspaceOperationSettings()

Returns the object with the settings used for calls to seedConversionWorkspace.

seedConversionWorkspaceSettings()

public UnaryCallSettings<SeedConversionWorkspaceRequest,Operation> seedConversionWorkspaceSettings()

Returns the object with the settings used for calls to seedConversionWorkspace.

startMigrationJobOperationSettings()

public OperationCallSettings<StartMigrationJobRequest,MigrationJob,OperationMetadata> startMigrationJobOperationSettings()

Returns the object with the settings used for calls to startMigrationJob.

startMigrationJobSettings()

public UnaryCallSettings<StartMigrationJobRequest,Operation> startMigrationJobSettings()

Returns the object with the settings used for calls to startMigrationJob.

stopMigrationJobOperationSettings()

public OperationCallSettings<StopMigrationJobRequest,MigrationJob,OperationMetadata> stopMigrationJobOperationSettings()

Returns the object with the settings used for calls to stopMigrationJob.

stopMigrationJobSettings()

public UnaryCallSettings<StopMigrationJobRequest,Operation> stopMigrationJobSettings()

Returns the object with the settings used for calls to stopMigrationJob.

toBuilder()

public DataMigrationServiceStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
DataMigrationServiceStubSettings.Builder
Overrides

updateConnectionProfileOperationSettings()

public OperationCallSettings<UpdateConnectionProfileRequest,ConnectionProfile,OperationMetadata> updateConnectionProfileOperationSettings()

Returns the object with the settings used for calls to updateConnectionProfile.

updateConnectionProfileSettings()

public UnaryCallSettings<UpdateConnectionProfileRequest,Operation> updateConnectionProfileSettings()

Returns the object with the settings used for calls to updateConnectionProfile.

updateConversionWorkspaceOperationSettings()

public OperationCallSettings<UpdateConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> updateConversionWorkspaceOperationSettings()

Returns the object with the settings used for calls to updateConversionWorkspace.

updateConversionWorkspaceSettings()

public UnaryCallSettings<UpdateConversionWorkspaceRequest,Operation> updateConversionWorkspaceSettings()

Returns the object with the settings used for calls to updateConversionWorkspace.

updateMigrationJobOperationSettings()

public OperationCallSettings<UpdateMigrationJobRequest,MigrationJob,OperationMetadata> updateMigrationJobOperationSettings()

Returns the object with the settings used for calls to updateMigrationJob.

updateMigrationJobSettings()

public UnaryCallSettings<UpdateMigrationJobRequest,Operation> updateMigrationJobSettings()

Returns the object with the settings used for calls to updateMigrationJob.

verifyMigrationJobOperationSettings()

public OperationCallSettings<VerifyMigrationJobRequest,MigrationJob,OperationMetadata> verifyMigrationJobOperationSettings()

Returns the object with the settings used for calls to verifyMigrationJob.

verifyMigrationJobSettings()

public UnaryCallSettings<VerifyMigrationJobRequest,Operation> verifyMigrationJobSettings()

Returns the object with the settings used for calls to verifyMigrationJob.