Class DataMigrationServiceSettings (2.12.0)

Version 2.12.0

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.8
• 2.1.9

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

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(DataMigrationServiceStubSettings stub)

public static final DataMigrationServiceSettings create(DataMigrationServiceStubSettings stub)

Parameter
Name	Description
stub	DataMigrationServiceStubSettings

Returns
Type	Description
DataMigrationServiceSettings

Exceptions
Type	Description
IOException

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static DataMigrationServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
DataMigrationServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DataMigrationServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
DataMigrationServiceSettings.Builder

Constructors

DataMigrationServiceSettings(DataMigrationServiceSettings.Builder settingsBuilder)

protected DataMigrationServiceSettings(DataMigrationServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	DataMigrationServiceSettings.Builder

Methods

createConnectionProfileOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<CreateConnectionProfileRequest,ConnectionProfile,OperationMetadata>

createConnectionProfileSettings()

public UnaryCallSettings<CreateConnectionProfileRequest,Operation> createConnectionProfileSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateConnectionProfileRequest,Operation>

createMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<CreateMigrationJobRequest,MigrationJob,OperationMetadata>

createMigrationJobSettings()

public UnaryCallSettings<CreateMigrationJobRequest,Operation> createMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateMigrationJobRequest,Operation>

deleteConnectionProfileOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<DeleteConnectionProfileRequest,Empty,OperationMetadata>

deleteConnectionProfileSettings()

public UnaryCallSettings<DeleteConnectionProfileRequest,Operation> deleteConnectionProfileSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteConnectionProfileRequest,Operation>

deleteMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<DeleteMigrationJobRequest,Empty,OperationMetadata>

deleteMigrationJobSettings()

public UnaryCallSettings<DeleteMigrationJobRequest,Operation> deleteMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteMigrationJobRequest,Operation>

generateSshScriptSettings()

public UnaryCallSettings<GenerateSshScriptRequest,SshScript> generateSshScriptSettings()

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

Returns
Type	Description
UnaryCallSettings<GenerateSshScriptRequest,SshScript>

getConnectionProfileSettings()

public UnaryCallSettings<GetConnectionProfileRequest,ConnectionProfile> getConnectionProfileSettings()

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

Returns
Type	Description
UnaryCallSettings<GetConnectionProfileRequest,ConnectionProfile>

getMigrationJobSettings()

public UnaryCallSettings<GetMigrationJobRequest,MigrationJob> getMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<GetMigrationJobRequest,MigrationJob>

listConnectionProfilesSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListConnectionProfilesRequest,ListConnectionProfilesResponse,ListConnectionProfilesPagedResponse>

listMigrationJobsSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListMigrationJobsRequest,ListMigrationJobsResponse,ListMigrationJobsPagedResponse>

promoteMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<PromoteMigrationJobRequest,MigrationJob,OperationMetadata>

promoteMigrationJobSettings()

public UnaryCallSettings<PromoteMigrationJobRequest,Operation> promoteMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<PromoteMigrationJobRequest,Operation>

restartMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<RestartMigrationJobRequest,MigrationJob,OperationMetadata>

restartMigrationJobSettings()

public UnaryCallSettings<RestartMigrationJobRequest,Operation> restartMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<RestartMigrationJobRequest,Operation>

resumeMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<ResumeMigrationJobRequest,MigrationJob,OperationMetadata>

resumeMigrationJobSettings()

public UnaryCallSettings<ResumeMigrationJobRequest,Operation> resumeMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<ResumeMigrationJobRequest,Operation>

startMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<StartMigrationJobRequest,MigrationJob,OperationMetadata>

startMigrationJobSettings()

public UnaryCallSettings<StartMigrationJobRequest,Operation> startMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<StartMigrationJobRequest,Operation>

stopMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<StopMigrationJobRequest,MigrationJob,OperationMetadata>

stopMigrationJobSettings()

public UnaryCallSettings<StopMigrationJobRequest,Operation> stopMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<StopMigrationJobRequest,Operation>

toBuilder()

public DataMigrationServiceSettings.Builder toBuilder()

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

Returns
Type	Description
DataMigrationServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateConnectionProfileOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<UpdateConnectionProfileRequest,ConnectionProfile,OperationMetadata>

updateConnectionProfileSettings()

public UnaryCallSettings<UpdateConnectionProfileRequest,Operation> updateConnectionProfileSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateConnectionProfileRequest,Operation>

updateMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<UpdateMigrationJobRequest,MigrationJob,OperationMetadata>

updateMigrationJobSettings()

public UnaryCallSettings<UpdateMigrationJobRequest,Operation> updateMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateMigrationJobRequest,Operation>

verifyMigrationJobOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<VerifyMigrationJobRequest,MigrationJob,OperationMetadata>

verifyMigrationJobSettings()

public UnaryCallSettings<VerifyMigrationJobRequest,Operation> verifyMigrationJobSettings()

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

Returns
Type	Description
UnaryCallSettings<VerifyMigrationJobRequest,Operation>