Class DataMigrationServiceSettings (2.17.0)

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 total timeout of getMigrationJob to 30 seconds:


 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataMigrationServiceSettings dataMigrationServiceSettings =
     dataMigrationServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > DataMigrationServiceSettings

Static Methods

create(DataMigrationServiceStubSettings stub)

public static final DataMigrationServiceSettings create(DataMigrationServiceStubSettings stub)
Parameter
NameDescription
stubDataMigrationServiceStubSettings
Returns
TypeDescription
DataMigrationServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DataMigrationServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder(ClientContext clientContext)

public static DataMigrationServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext

Constructors

DataMigrationServiceSettings(DataMigrationServiceSettings.Builder settingsBuilder)

protected DataMigrationServiceSettings(DataMigrationServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDataMigrationServiceSettings.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.

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.

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.

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.

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.

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.

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.

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 DataMigrationServiceSettings.Builder toBuilder()

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

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.