- 2.53.0 (latest)
- 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
A client to Database Migration API
The interfaces provided are listed below, along with usage samples.
DataMigrationServiceClient
Service Description: Database Migration service
Sample for DataMigrationServiceClient:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
MigrationJobName name = MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]");
MigrationJob response = dataMigrationServiceClient.getMigrationJob(name);
}
Classes
CloudSqlConnectionProfile
Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.
Protobuf type google.cloud.clouddms.v1.CloudSqlConnectionProfile
CloudSqlConnectionProfile.Builder
Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.
Protobuf type google.cloud.clouddms.v1.CloudSqlConnectionProfile
CloudSqlSettings
Settings for creating a Cloud SQL database instance.
Protobuf type google.cloud.clouddms.v1.CloudSqlSettings
CloudSqlSettings.Builder
Settings for creating a Cloud SQL database instance.
Protobuf type google.cloud.clouddms.v1.CloudSqlSettings
ClouddmsProto
ClouddmsResourcesProto
ConnectionProfile
A connection profile definition.
Protobuf type google.cloud.clouddms.v1.ConnectionProfile
ConnectionProfile.Builder
A connection profile definition.
Protobuf type google.cloud.clouddms.v1.ConnectionProfile
ConnectionProfileName
ConnectionProfileName.Builder
Builder for projects/{project}/locations/{location}/connectionProfiles/{connection_profile}.
CreateConnectionProfileRequest
Request message for 'CreateConnectionProfile' request.
Protobuf type google.cloud.clouddms.v1.CreateConnectionProfileRequest
CreateConnectionProfileRequest.Builder
Request message for 'CreateConnectionProfile' request.
Protobuf type google.cloud.clouddms.v1.CreateConnectionProfileRequest
CreateMigrationJobRequest
Request message to create a new Database Migration Service migration job in the specified project and region.
Protobuf type google.cloud.clouddms.v1.CreateMigrationJobRequest
CreateMigrationJobRequest.Builder
Request message to create a new Database Migration Service migration job in the specified project and region.
Protobuf type google.cloud.clouddms.v1.CreateMigrationJobRequest
DataMigrationServiceClient
Service Description: Database Migration service
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
MigrationJobName name = MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]");
MigrationJob response = dataMigrationServiceClient.getMigrationJob(name);
}
Note: close() needs to be called on the DataMigrationServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataMigrationServiceSettings to create(). For example:
To customize credentials:
// 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 dataMigrationServiceSettings =
DataMigrationServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create(dataMigrationServiceSettings);
To customize the endpoint:
// 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 dataMigrationServiceSettings =
DataMigrationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create(dataMigrationServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
DataMigrationServiceClient.ListConnectionProfilesFixedSizeCollection
DataMigrationServiceClient.ListConnectionProfilesPage
DataMigrationServiceClient.ListConnectionProfilesPagedResponse
DataMigrationServiceClient.ListMigrationJobsFixedSizeCollection
DataMigrationServiceClient.ListMigrationJobsPage
DataMigrationServiceClient.ListMigrationJobsPagedResponse
DataMigrationServiceGrpc
Database Migration service
DataMigrationServiceGrpc.DataMigrationServiceBlockingStub
A stub to allow clients to do synchronous rpc calls to service DataMigrationService.
Database Migration service
DataMigrationServiceGrpc.DataMigrationServiceFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service DataMigrationService.
Database Migration service
DataMigrationServiceGrpc.DataMigrationServiceImplBase
Base class for the server implementation of the service DataMigrationService.
Database Migration service
DataMigrationServiceGrpc.DataMigrationServiceStub
A stub to allow clients to do asynchronous rpc calls to service DataMigrationService.
Database Migration service
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();
DataMigrationServiceSettings.Builder
Builder for DataMigrationServiceSettings.
DatabaseType
A message defining the database engine and provider.
Protobuf type google.cloud.clouddms.v1.DatabaseType
DatabaseType.Builder
A message defining the database engine and provider.
Protobuf type google.cloud.clouddms.v1.DatabaseType
DeleteConnectionProfileRequest
Request message for 'DeleteConnectionProfile' request.
Protobuf type google.cloud.clouddms.v1.DeleteConnectionProfileRequest
DeleteConnectionProfileRequest.Builder
Request message for 'DeleteConnectionProfile' request.
Protobuf type google.cloud.clouddms.v1.DeleteConnectionProfileRequest
DeleteMigrationJobRequest
Request message for 'DeleteMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.DeleteMigrationJobRequest
DeleteMigrationJobRequest.Builder
Request message for 'DeleteMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.DeleteMigrationJobRequest
GenerateSshScriptRequest
Request message for 'GenerateSshScript' request.
Protobuf type google.cloud.clouddms.v1.GenerateSshScriptRequest
GenerateSshScriptRequest.Builder
Request message for 'GenerateSshScript' request.
Protobuf type google.cloud.clouddms.v1.GenerateSshScriptRequest
GetConnectionProfileRequest
Request message for 'GetConnectionProfile' request.
Protobuf type google.cloud.clouddms.v1.GetConnectionProfileRequest
GetConnectionProfileRequest.Builder
Request message for 'GetConnectionProfile' request.
Protobuf type google.cloud.clouddms.v1.GetConnectionProfileRequest
GetMigrationJobRequest
Request message for 'GetMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.GetMigrationJobRequest
GetMigrationJobRequest.Builder
Request message for 'GetMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.GetMigrationJobRequest
ListConnectionProfilesRequest
Request message for 'ListConnectionProfiles' request.
Protobuf type google.cloud.clouddms.v1.ListConnectionProfilesRequest
ListConnectionProfilesRequest.Builder
Request message for 'ListConnectionProfiles' request.
Protobuf type google.cloud.clouddms.v1.ListConnectionProfilesRequest
ListConnectionProfilesResponse
Response message for 'ListConnectionProfiles' request.
Protobuf type google.cloud.clouddms.v1.ListConnectionProfilesResponse
ListConnectionProfilesResponse.Builder
Response message for 'ListConnectionProfiles' request.
Protobuf type google.cloud.clouddms.v1.ListConnectionProfilesResponse
ListMigrationJobsRequest
Retrieve a list of all migration jobs in a given project and location.
Protobuf type google.cloud.clouddms.v1.ListMigrationJobsRequest
ListMigrationJobsRequest.Builder
Retrieve a list of all migration jobs in a given project and location.
Protobuf type google.cloud.clouddms.v1.ListMigrationJobsRequest
ListMigrationJobsResponse
Response message for 'ListMigrationJobs' request.
Protobuf type google.cloud.clouddms.v1.ListMigrationJobsResponse
ListMigrationJobsResponse.Builder
Response message for 'ListMigrationJobs' request.
Protobuf type google.cloud.clouddms.v1.ListMigrationJobsResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
MigrationJob
Represents a Database Migration Service migration job object.
Protobuf type google.cloud.clouddms.v1.MigrationJob
MigrationJob.Builder
Represents a Database Migration Service migration job object.
Protobuf type google.cloud.clouddms.v1.MigrationJob
MigrationJobName
MigrationJobName.Builder
Builder for projects/{project}/locations/{location}/migrationJobs/{migration_job}.
MigrationJobVerificationError
Error message of a verification Migration job.
Protobuf type google.cloud.clouddms.v1.MigrationJobVerificationError
MigrationJobVerificationError.Builder
Error message of a verification Migration job.
Protobuf type google.cloud.clouddms.v1.MigrationJobVerificationError
MySqlConnectionProfile
Specifies connection parameters required specifically for MySQL databases.
Protobuf type google.cloud.clouddms.v1.MySqlConnectionProfile
MySqlConnectionProfile.Builder
Specifies connection parameters required specifically for MySQL databases.
Protobuf type google.cloud.clouddms.v1.MySqlConnectionProfile
OperationMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.clouddms.v1.OperationMetadata
OperationMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.clouddms.v1.OperationMetadata
PostgreSqlConnectionProfile
Specifies connection parameters required specifically for PostgreSQL databases.
Protobuf type google.cloud.clouddms.v1.PostgreSqlConnectionProfile
PostgreSqlConnectionProfile.Builder
Specifies connection parameters required specifically for PostgreSQL databases.
Protobuf type google.cloud.clouddms.v1.PostgreSqlConnectionProfile
PromoteMigrationJobRequest
Request message for 'PromoteMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.PromoteMigrationJobRequest
PromoteMigrationJobRequest.Builder
Request message for 'PromoteMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.PromoteMigrationJobRequest
RestartMigrationJobRequest
Request message for 'RestartMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.RestartMigrationJobRequest
RestartMigrationJobRequest.Builder
Request message for 'RestartMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.RestartMigrationJobRequest
ResumeMigrationJobRequest
Request message for 'ResumeMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.ResumeMigrationJobRequest
ResumeMigrationJobRequest.Builder
Request message for 'ResumeMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.ResumeMigrationJobRequest
ReverseSshConnectivity
The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.
Protobuf type google.cloud.clouddms.v1.ReverseSshConnectivity
ReverseSshConnectivity.Builder
The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.
Protobuf type google.cloud.clouddms.v1.ReverseSshConnectivity
SqlAclEntry
An entry for an Access Control list.
Protobuf type google.cloud.clouddms.v1.SqlAclEntry
SqlAclEntry.Builder
An entry for an Access Control list.
Protobuf type google.cloud.clouddms.v1.SqlAclEntry
SqlIpConfig
IP Management configuration.
Protobuf type google.cloud.clouddms.v1.SqlIpConfig
SqlIpConfig.Builder
IP Management configuration.
Protobuf type google.cloud.clouddms.v1.SqlIpConfig
SshScript
Response message for 'GenerateSshScript' request.
Protobuf type google.cloud.clouddms.v1.SshScript
SshScript.Builder
Response message for 'GenerateSshScript' request.
Protobuf type google.cloud.clouddms.v1.SshScript
SslConfig
SSL configuration information.
Protobuf type google.cloud.clouddms.v1.SslConfig
SslConfig.Builder
SSL configuration information.
Protobuf type google.cloud.clouddms.v1.SslConfig
StartMigrationJobRequest
Request message for 'StartMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.StartMigrationJobRequest
StartMigrationJobRequest.Builder
Request message for 'StartMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.StartMigrationJobRequest
StaticIpConnectivity
The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required.
Protobuf type google.cloud.clouddms.v1.StaticIpConnectivity
StaticIpConnectivity.Builder
The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required.
Protobuf type google.cloud.clouddms.v1.StaticIpConnectivity
StopMigrationJobRequest
Request message for 'StopMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.StopMigrationJobRequest
StopMigrationJobRequest.Builder
Request message for 'StopMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.StopMigrationJobRequest
UpdateConnectionProfileRequest
Request message for 'UpdateConnectionProfile' request.
Protobuf type google.cloud.clouddms.v1.UpdateConnectionProfileRequest
UpdateConnectionProfileRequest.Builder
Request message for 'UpdateConnectionProfile' request.
Protobuf type google.cloud.clouddms.v1.UpdateConnectionProfileRequest
UpdateMigrationJobRequest
Request message for 'UpdateMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.UpdateMigrationJobRequest
UpdateMigrationJobRequest.Builder
Request message for 'UpdateMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.UpdateMigrationJobRequest
VerifyMigrationJobRequest
Request message for 'VerifyMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.VerifyMigrationJobRequest
VerifyMigrationJobRequest.Builder
Request message for 'VerifyMigrationJob' request.
Protobuf type google.cloud.clouddms.v1.VerifyMigrationJobRequest
VmCreationConfig
VM creation configuration message
Protobuf type google.cloud.clouddms.v1.VmCreationConfig
VmCreationConfig.Builder
VM creation configuration message
Protobuf type google.cloud.clouddms.v1.VmCreationConfig
VmSelectionConfig
VM selection configuration message
Protobuf type google.cloud.clouddms.v1.VmSelectionConfig
VmSelectionConfig.Builder
VM selection configuration message
Protobuf type google.cloud.clouddms.v1.VmSelectionConfig
VpcPeeringConnectivity
The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.
Protobuf type google.cloud.clouddms.v1.VpcPeeringConnectivity
VpcPeeringConnectivity.Builder
The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.
Protobuf type google.cloud.clouddms.v1.VpcPeeringConnectivity
Interfaces
CloudSqlConnectionProfileOrBuilder
CloudSqlSettingsOrBuilder
ConnectionProfileOrBuilder
CreateConnectionProfileRequestOrBuilder
CreateMigrationJobRequestOrBuilder
DataMigrationServiceGrpc.AsyncService
Database Migration service
DatabaseTypeOrBuilder
DeleteConnectionProfileRequestOrBuilder
DeleteMigrationJobRequestOrBuilder
GenerateSshScriptRequestOrBuilder
GetConnectionProfileRequestOrBuilder
GetMigrationJobRequestOrBuilder
ListConnectionProfilesRequestOrBuilder
ListConnectionProfilesResponseOrBuilder
ListMigrationJobsRequestOrBuilder
ListMigrationJobsResponseOrBuilder
MigrationJobOrBuilder
MigrationJobVerificationErrorOrBuilder
MySqlConnectionProfileOrBuilder
OperationMetadataOrBuilder
PostgreSqlConnectionProfileOrBuilder
PromoteMigrationJobRequestOrBuilder
RestartMigrationJobRequestOrBuilder
ResumeMigrationJobRequestOrBuilder
ReverseSshConnectivityOrBuilder
SqlAclEntryOrBuilder
SqlIpConfigOrBuilder
SshScriptOrBuilder
SslConfigOrBuilder
StartMigrationJobRequestOrBuilder
StaticIpConnectivityOrBuilder
StopMigrationJobRequestOrBuilder
UpdateConnectionProfileRequestOrBuilder
UpdateMigrationJobRequestOrBuilder
VerifyMigrationJobRequestOrBuilder
VmCreationConfigOrBuilder
VmSelectionConfigOrBuilder
VpcPeeringConnectivityOrBuilder
Enums
CloudSqlSettings.SqlActivationPolicy
Specifies when the instance should be activated.
Protobuf enum google.cloud.clouddms.v1.CloudSqlSettings.SqlActivationPolicy
CloudSqlSettings.SqlDataDiskType
The storage options for Cloud SQL databases.
Protobuf enum google.cloud.clouddms.v1.CloudSqlSettings.SqlDataDiskType
CloudSqlSettings.SqlDatabaseVersion
The database engine type and version.
Protobuf enum google.cloud.clouddms.v1.CloudSqlSettings.SqlDatabaseVersion
ConnectionProfile.ConnectionProfileCase
ConnectionProfile.State
The current connection profile state (e.g. DRAFT, READY, or FAILED).
Protobuf enum google.cloud.clouddms.v1.ConnectionProfile.State
DatabaseEngine
The database engine types.
Protobuf enum google.cloud.clouddms.v1.DatabaseEngine
DatabaseProvider
The database providers.
Protobuf enum google.cloud.clouddms.v1.DatabaseProvider
GenerateSshScriptRequest.VmConfigCase
MigrationJob.ConnectivityCase
MigrationJob.Phase
The current migration job phase.
Protobuf enum google.cloud.clouddms.v1.MigrationJob.Phase
MigrationJob.State
The current migration job states.
Protobuf enum google.cloud.clouddms.v1.MigrationJob.State
MigrationJob.Type
The type of migration job (one-time or continuous).
Protobuf enum google.cloud.clouddms.v1.MigrationJob.Type
MigrationJobVerificationError.ErrorCode
A general error code describing the type of error that occurred.
Protobuf enum google.cloud.clouddms.v1.MigrationJobVerificationError.ErrorCode
SqlAclEntry.ExpirationCase
SslConfig.SslType
Specifies The kind of ssl configuration used.
Protobuf enum google.cloud.clouddms.v1.SslConfig.SslType