Package com.google.cloud.clouddms.v1 (2.28.0)

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

AlloyDbConnectionProfile

Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster.

Protobuf type google.cloud.clouddms.v1.AlloyDbConnectionProfile

AlloyDbConnectionProfile.Builder

Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster.

Protobuf type google.cloud.clouddms.v1.AlloyDbConnectionProfile

AlloyDbSettings

Settings for creating an AlloyDB cluster.

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings

AlloyDbSettings.Builder

Settings for creating an AlloyDB cluster.

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings

AlloyDbSettings.EncryptionConfig

EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key).

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.EncryptionConfig

AlloyDbSettings.EncryptionConfig.Builder

EncryptionConfig describes the encryption config of a cluster that is encrypted with a CMEK (customer-managed encryption key).

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.EncryptionConfig

AlloyDbSettings.PrimaryInstanceSettings

Settings for the cluster's primary instance

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings

AlloyDbSettings.PrimaryInstanceSettings.Builder

Settings for the cluster's primary instance

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings

AlloyDbSettings.PrimaryInstanceSettings.MachineConfig

MachineConfig describes the configuration of a machine.

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig

AlloyDbSettings.PrimaryInstanceSettings.MachineConfig.Builder

MachineConfig describes the configuration of a machine.

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.PrimaryInstanceSettings.MachineConfig

AlloyDbSettings.UserPassword

The username/password for a database user. Used for specifying initial users at cluster creation time.

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.UserPassword

AlloyDbSettings.UserPassword.Builder

The username/password for a database user. Used for specifying initial users at cluster creation time.

Protobuf type google.cloud.clouddms.v1.AlloyDbSettings.UserPassword

ApplyConversionWorkspaceRequest

Request message for 'ApplyConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.ApplyConversionWorkspaceRequest

ApplyConversionWorkspaceRequest.Builder

Request message for 'ApplyConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.ApplyConversionWorkspaceRequest

ApplyHash

Apply a hash function on the value.

Protobuf type google.cloud.clouddms.v1.ApplyHash

ApplyHash.Builder

Apply a hash function on the value.

Protobuf type google.cloud.clouddms.v1.ApplyHash

AssignSpecificValue

Set to a specific value (value is converted to fit the target data type)

Protobuf type google.cloud.clouddms.v1.AssignSpecificValue

AssignSpecificValue.Builder

Set to a specific value (value is converted to fit the target data type)

Protobuf type google.cloud.clouddms.v1.AssignSpecificValue

BackgroundJobLogEntry

Execution log of a background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry

BackgroundJobLogEntry.ApplyJobDetails

Details regarding an Apply background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry.ApplyJobDetails

BackgroundJobLogEntry.ApplyJobDetails.Builder

Details regarding an Apply background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry.ApplyJobDetails

BackgroundJobLogEntry.Builder

Execution log of a background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry

BackgroundJobLogEntry.ConvertJobDetails

Details regarding a Convert background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry.ConvertJobDetails

BackgroundJobLogEntry.ConvertJobDetails.Builder

Details regarding a Convert background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry.ConvertJobDetails

BackgroundJobLogEntry.ImportRulesJobDetails

Details regarding an Import Rules background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry.ImportRulesJobDetails

BackgroundJobLogEntry.ImportRulesJobDetails.Builder

Details regarding an Import Rules background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry.ImportRulesJobDetails

BackgroundJobLogEntry.SeedJobDetails

Details regarding a Seed background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry.SeedJobDetails

BackgroundJobLogEntry.SeedJobDetails.Builder

Details regarding a Seed background job.

Protobuf type google.cloud.clouddms.v1.BackgroundJobLogEntry.SeedJobDetails

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

ColumnEntity

Column is not used as an independent entity, it is retrieved as part of a Table entity.

Protobuf type google.cloud.clouddms.v1.ColumnEntity

ColumnEntity.Builder

Column is not used as an independent entity, it is retrieved as part of a Table entity.

Protobuf type google.cloud.clouddms.v1.ColumnEntity

CommitConversionWorkspaceRequest

Request message for 'CommitConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.CommitConversionWorkspaceRequest

CommitConversionWorkspaceRequest.Builder

Request message for 'CommitConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.CommitConversionWorkspaceRequest

ConditionalColumnSetValue

Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated.

The rule filter field can refer to one or more entities.

The rule scope can be one of: Column.

Protobuf type google.cloud.clouddms.v1.ConditionalColumnSetValue

ConditionalColumnSetValue.Builder

Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated.

The rule filter field can refer to one or more entities.

The rule scope can be one of: Column.

Protobuf type google.cloud.clouddms.v1.ConditionalColumnSetValue

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.Builder

Builder for projects/{project}/locations/{location}/connectionProfiles/{connection_profile}.

ConstraintEntity

Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.

Protobuf type google.cloud.clouddms.v1.ConstraintEntity

ConstraintEntity.Builder

Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.

Protobuf type google.cloud.clouddms.v1.ConstraintEntity

ConversionWorkspace

The main conversion workspace resource entity.

Protobuf type google.cloud.clouddms.v1.ConversionWorkspace

ConversionWorkspace.Builder

The main conversion workspace resource entity.

Protobuf type google.cloud.clouddms.v1.ConversionWorkspace

ConversionWorkspaceInfo

A conversion workspace's version.

Protobuf type google.cloud.clouddms.v1.ConversionWorkspaceInfo

ConversionWorkspaceInfo.Builder

A conversion workspace's version.

Protobuf type google.cloud.clouddms.v1.ConversionWorkspaceInfo

ConversionWorkspaceName.Builder

Builder for projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

ConversionWorkspaceResourcesProto

ConvertConversionWorkspaceRequest

Request message for 'ConvertConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.ConvertConversionWorkspaceRequest

ConvertConversionWorkspaceRequest.Builder

Request message for 'ConvertConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.ConvertConversionWorkspaceRequest

ConvertRowIdToColumn

Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property.

The rule filter field can refer to one or more entities.

The rule scope can be one of: Table.

This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined.

Protobuf type google.cloud.clouddms.v1.ConvertRowIdToColumn

ConvertRowIdToColumn.Builder

Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property.

The rule filter field can refer to one or more entities.

The rule scope can be one of: Table.

This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined.

Protobuf type google.cloud.clouddms.v1.ConvertRowIdToColumn

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

CreateConversionWorkspaceRequest

Request message to create a new Conversion Workspace in the specified project and region.

Protobuf type google.cloud.clouddms.v1.CreateConversionWorkspaceRequest

CreateConversionWorkspaceRequest.Builder

Request message to create a new Conversion Workspace in the specified project and region.

Protobuf type google.cloud.clouddms.v1.CreateConversionWorkspaceRequest

CreateMappingRuleRequest

Request message for 'CreateMappingRule' command.

Protobuf type google.cloud.clouddms.v1.CreateMappingRuleRequest

CreateMappingRuleRequest.Builder

Request message for 'CreateMappingRule' command.

Protobuf type google.cloud.clouddms.v1.CreateMappingRuleRequest

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

CreatePrivateConnectionRequest

Request message to create a new private connection in the specified project and region.

Protobuf type google.cloud.clouddms.v1.CreatePrivateConnectionRequest

CreatePrivateConnectionRequest.Builder

Request message to create a new private connection in the specified project and region.

Protobuf type google.cloud.clouddms.v1.CreatePrivateConnectionRequest

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.DescribeDatabaseEntitiesFixedSizeCollection

DataMigrationServiceClient.DescribeDatabaseEntitiesPage

DataMigrationServiceClient.DescribeDatabaseEntitiesPagedResponse

DataMigrationServiceClient.FetchStaticIpsFixedSizeCollection

DataMigrationServiceClient.FetchStaticIpsPage

DataMigrationServiceClient.FetchStaticIpsPagedResponse

DataMigrationServiceClient.ListConnectionProfilesFixedSizeCollection

DataMigrationServiceClient.ListConnectionProfilesPage

DataMigrationServiceClient.ListConnectionProfilesPagedResponse

DataMigrationServiceClient.ListConversionWorkspacesFixedSizeCollection

DataMigrationServiceClient.ListConversionWorkspacesPage

DataMigrationServiceClient.ListConversionWorkspacesPagedResponse

DataMigrationServiceClient.ListMappingRulesFixedSizeCollection

DataMigrationServiceClient.ListMappingRulesPage

DataMigrationServiceClient.ListMappingRulesPagedResponse

DataMigrationServiceClient.ListMigrationJobsFixedSizeCollection

DataMigrationServiceClient.ListMigrationJobsPage

DataMigrationServiceClient.ListMigrationJobsPagedResponse

DataMigrationServiceClient.ListPrivateConnectionsFixedSizeCollection

DataMigrationServiceClient.ListPrivateConnectionsPage

DataMigrationServiceClient.ListPrivateConnectionsPagedResponse

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.

DatabaseEngineInfo

The type and version of a source or destination database.

Protobuf type google.cloud.clouddms.v1.DatabaseEngineInfo

DatabaseEngineInfo.Builder

The type and version of a source or destination database.

Protobuf type google.cloud.clouddms.v1.DatabaseEngineInfo

DatabaseEntity

The base entity type for all the database related entities. The message contains the entity name, the name of its parent, the entity type, and the specific details per entity type.

Protobuf type google.cloud.clouddms.v1.DatabaseEntity

DatabaseEntity.Builder

The base entity type for all the database related entities. The message contains the entity name, the name of its parent, the entity type, and the specific details per entity type.

Protobuf type google.cloud.clouddms.v1.DatabaseEntity

DatabaseInstanceEntity

DatabaseInstance acts as a parent entity to other database entities.

Protobuf type google.cloud.clouddms.v1.DatabaseInstanceEntity

DatabaseInstanceEntity.Builder

DatabaseInstance acts as a parent entity to other database entities.

Protobuf type google.cloud.clouddms.v1.DatabaseInstanceEntity

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

DeleteConversionWorkspaceRequest

Request message for 'DeleteConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.DeleteConversionWorkspaceRequest

DeleteConversionWorkspaceRequest.Builder

Request message for 'DeleteConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.DeleteConversionWorkspaceRequest

DeleteMappingRuleRequest

Request message for 'DeleteMappingRule' request.

Protobuf type google.cloud.clouddms.v1.DeleteMappingRuleRequest

DeleteMappingRuleRequest.Builder

Request message for 'DeleteMappingRule' request.

Protobuf type google.cloud.clouddms.v1.DeleteMappingRuleRequest

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

DeletePrivateConnectionRequest

Request message to delete a private connection.

Protobuf type google.cloud.clouddms.v1.DeletePrivateConnectionRequest

DeletePrivateConnectionRequest.Builder

Request message to delete a private connection.

Protobuf type google.cloud.clouddms.v1.DeletePrivateConnectionRequest

DescribeConversionWorkspaceRevisionsRequest

Request message for 'DescribeConversionWorkspaceRevisions' request.

Protobuf type google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsRequest

DescribeConversionWorkspaceRevisionsRequest.Builder

Request message for 'DescribeConversionWorkspaceRevisions' request.

Protobuf type google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsRequest

DescribeConversionWorkspaceRevisionsResponse

Response message for 'DescribeConversionWorkspaceRevisions' request.

Protobuf type google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse

DescribeConversionWorkspaceRevisionsResponse.Builder

Response message for 'DescribeConversionWorkspaceRevisions' request.

Protobuf type google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse

DescribeDatabaseEntitiesRequest

Request message for 'DescribeDatabaseEntities' request.

Protobuf type google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest

DescribeDatabaseEntitiesRequest.Builder

Request message for 'DescribeDatabaseEntities' request.

Protobuf type google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest

DescribeDatabaseEntitiesResponse

Response message for 'DescribeDatabaseEntities' request.

Protobuf type google.cloud.clouddms.v1.DescribeDatabaseEntitiesResponse

DescribeDatabaseEntitiesResponse.Builder

Response message for 'DescribeDatabaseEntities' request.

Protobuf type google.cloud.clouddms.v1.DescribeDatabaseEntitiesResponse

DoubleComparisonFilter

Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue

Protobuf type google.cloud.clouddms.v1.DoubleComparisonFilter

DoubleComparisonFilter.Builder

Filter based on relation between source value and compare value of type double in ConditionalColumnSetValue

Protobuf type google.cloud.clouddms.v1.DoubleComparisonFilter

EntityDdl

A single DDL statement for a specific entity

Protobuf type google.cloud.clouddms.v1.EntityDdl

EntityDdl.Builder

A single DDL statement for a specific entity

Protobuf type google.cloud.clouddms.v1.EntityDdl

EntityIssue

Issue related to the entity.

Protobuf type google.cloud.clouddms.v1.EntityIssue

EntityIssue.Builder

Issue related to the entity.

Protobuf type google.cloud.clouddms.v1.EntityIssue

EntityIssue.Position

Issue position.

Protobuf type google.cloud.clouddms.v1.EntityIssue.Position

EntityIssue.Position.Builder

Issue position.

Protobuf type google.cloud.clouddms.v1.EntityIssue.Position

EntityMapping

Details of the mappings of a database entity.

Protobuf type google.cloud.clouddms.v1.EntityMapping

EntityMapping.Builder

Details of the mappings of a database entity.

Protobuf type google.cloud.clouddms.v1.EntityMapping

EntityMappingLogEntry

A single record of a rule which was used for a mapping.

Protobuf type google.cloud.clouddms.v1.EntityMappingLogEntry

EntityMappingLogEntry.Builder

A single record of a rule which was used for a mapping.

Protobuf type google.cloud.clouddms.v1.EntityMappingLogEntry

EntityMove

Options to configure rule type EntityMove. The rule is used to move an entity to a new schema.

The rule filter field can refer to one or more entities.

The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT

Protobuf type google.cloud.clouddms.v1.EntityMove

EntityMove.Builder

Options to configure rule type EntityMove. The rule is used to move an entity to a new schema.

The rule filter field can refer to one or more entities.

The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT

Protobuf type google.cloud.clouddms.v1.EntityMove

FetchStaticIpsRequest

Request message for 'FetchStaticIps' request.

Protobuf type google.cloud.clouddms.v1.FetchStaticIpsRequest

FetchStaticIpsRequest.Builder

Request message for 'FetchStaticIps' request.

Protobuf type google.cloud.clouddms.v1.FetchStaticIpsRequest

FetchStaticIpsResponse

Response message for a 'FetchStaticIps' request.

Protobuf type google.cloud.clouddms.v1.FetchStaticIpsResponse

FetchStaticIpsResponse.Builder

Response message for a 'FetchStaticIps' request.

Protobuf type google.cloud.clouddms.v1.FetchStaticIpsResponse

FilterTableColumns

Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table.

The rule filter field can refer to one entity.

The rule scope can be: Table

Only one of the two lists can be specified for the rule.

Protobuf type google.cloud.clouddms.v1.FilterTableColumns

FilterTableColumns.Builder

Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table.

The rule filter field can refer to one entity.

The rule scope can be: Table

Only one of the two lists can be specified for the rule.

Protobuf type google.cloud.clouddms.v1.FilterTableColumns

ForwardSshTunnelConnectivity

Forward SSH Tunnel connectivity.

Protobuf type google.cloud.clouddms.v1.ForwardSshTunnelConnectivity

ForwardSshTunnelConnectivity.Builder

Forward SSH Tunnel connectivity.

Protobuf type google.cloud.clouddms.v1.ForwardSshTunnelConnectivity

FunctionEntity

Function's parent is a schema.

Protobuf type google.cloud.clouddms.v1.FunctionEntity

FunctionEntity.Builder

Function's parent is a schema.

Protobuf type google.cloud.clouddms.v1.FunctionEntity

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

GenerateTcpProxyScriptRequest

Request message for 'GenerateTcpProxyScript' request.

Protobuf type google.cloud.clouddms.v1.GenerateTcpProxyScriptRequest

GenerateTcpProxyScriptRequest.Builder

Request message for 'GenerateTcpProxyScript' request.

Protobuf type google.cloud.clouddms.v1.GenerateTcpProxyScriptRequest

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

GetConversionWorkspaceRequest

Request message for 'GetConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.GetConversionWorkspaceRequest

GetConversionWorkspaceRequest.Builder

Request message for 'GetConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.GetConversionWorkspaceRequest

GetMappingRuleRequest

Request message for 'GetMappingRule' request.

Protobuf type google.cloud.clouddms.v1.GetMappingRuleRequest

GetMappingRuleRequest.Builder

Request message for 'GetMappingRule' request.

Protobuf type google.cloud.clouddms.v1.GetMappingRuleRequest

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

GetPrivateConnectionRequest

Request message to get a private connection resource.

Protobuf type google.cloud.clouddms.v1.GetPrivateConnectionRequest

GetPrivateConnectionRequest.Builder

Request message to get a private connection resource.

Protobuf type google.cloud.clouddms.v1.GetPrivateConnectionRequest

ImportMappingRulesRequest

Request message for 'ImportMappingRules' request.

Protobuf type google.cloud.clouddms.v1.ImportMappingRulesRequest

ImportMappingRulesRequest.Builder

Request message for 'ImportMappingRules' request.

Protobuf type google.cloud.clouddms.v1.ImportMappingRulesRequest

ImportMappingRulesRequest.RulesFile

Details of a single rules file.

Protobuf type google.cloud.clouddms.v1.ImportMappingRulesRequest.RulesFile

ImportMappingRulesRequest.RulesFile.Builder

Details of a single rules file.

Protobuf type google.cloud.clouddms.v1.ImportMappingRulesRequest.RulesFile

IndexEntity

Index is not used as an independent entity, it is retrieved as part of a Table entity.

Protobuf type google.cloud.clouddms.v1.IndexEntity

IndexEntity.Builder

Index is not used as an independent entity, it is retrieved as part of a Table entity.

Protobuf type google.cloud.clouddms.v1.IndexEntity

IntComparisonFilter

Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue

Protobuf type google.cloud.clouddms.v1.IntComparisonFilter

IntComparisonFilter.Builder

Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue

Protobuf type google.cloud.clouddms.v1.IntComparisonFilter

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

ListConversionWorkspacesRequest

Retrieve a list of all conversion workspaces in a given project and location.

Protobuf type google.cloud.clouddms.v1.ListConversionWorkspacesRequest

ListConversionWorkspacesRequest.Builder

Retrieve a list of all conversion workspaces in a given project and location.

Protobuf type google.cloud.clouddms.v1.ListConversionWorkspacesRequest

ListConversionWorkspacesResponse

Response message for 'ListConversionWorkspaces' request.

Protobuf type google.cloud.clouddms.v1.ListConversionWorkspacesResponse

ListConversionWorkspacesResponse.Builder

Response message for 'ListConversionWorkspaces' request.

Protobuf type google.cloud.clouddms.v1.ListConversionWorkspacesResponse

ListMappingRulesRequest

Retrieve a list of all mapping rules in a given conversion workspace.

Protobuf type google.cloud.clouddms.v1.ListMappingRulesRequest

ListMappingRulesRequest.Builder

Retrieve a list of all mapping rules in a given conversion workspace.

Protobuf type google.cloud.clouddms.v1.ListMappingRulesRequest

ListMappingRulesResponse

Response message for 'ListMappingRulesRequest' request.

Protobuf type google.cloud.clouddms.v1.ListMappingRulesResponse

ListMappingRulesResponse.Builder

Response message for 'ListMappingRulesRequest' request.

Protobuf type google.cloud.clouddms.v1.ListMappingRulesResponse

ListMigrationJobsRequest

Retrieves a list of all migration jobs in a given project and location.

Protobuf type google.cloud.clouddms.v1.ListMigrationJobsRequest

ListMigrationJobsRequest.Builder

Retrieves 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

ListPrivateConnectionsRequest

Request message to retrieve a list of private connections in a given project and location.

Protobuf type google.cloud.clouddms.v1.ListPrivateConnectionsRequest

ListPrivateConnectionsRequest.Builder

Request message to retrieve a list of private connections in a given project and location.

Protobuf type google.cloud.clouddms.v1.ListPrivateConnectionsRequest

ListPrivateConnectionsResponse

Response message for 'ListPrivateConnections' request.

Protobuf type google.cloud.clouddms.v1.ListPrivateConnectionsResponse

ListPrivateConnectionsResponse.Builder

Response message for 'ListPrivateConnections' request.

Protobuf type google.cloud.clouddms.v1.ListPrivateConnectionsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

MappingRule

Definition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema.

Protobuf type google.cloud.clouddms.v1.MappingRule

MappingRule.Builder

Protobuf type google.cloud.clouddms.v1.MappingRule

MappingRuleFilter

A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields.

Protobuf type google.cloud.clouddms.v1.MappingRuleFilter

MappingRuleFilter.Builder

A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields.

Protobuf type google.cloud.clouddms.v1.MappingRuleFilter

MappingRuleName

MappingRuleName.Builder

Builder for projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule}.

MaterializedViewEntity

MaterializedView's parent is a schema.

Protobuf type google.cloud.clouddms.v1.MaterializedViewEntity

MaterializedViewEntity.Builder

MaterializedView's parent is a schema.

Protobuf type google.cloud.clouddms.v1.MaterializedViewEntity

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

MigrationJob.DumpFlag

Dump flag definition.

Protobuf type google.cloud.clouddms.v1.MigrationJob.DumpFlag

MigrationJob.DumpFlag.Builder

Dump flag definition.

Protobuf type google.cloud.clouddms.v1.MigrationJob.DumpFlag

MigrationJob.DumpFlags

Dump flags definition.

Protobuf type google.cloud.clouddms.v1.MigrationJob.DumpFlags

MigrationJob.DumpFlags.Builder

Dump flags definition.

Protobuf type google.cloud.clouddms.v1.MigrationJob.DumpFlags

MigrationJob.PerformanceConfig

Performance configuration definition.

Protobuf type google.cloud.clouddms.v1.MigrationJob.PerformanceConfig

MigrationJob.PerformanceConfig.Builder

Performance configuration definition.

Protobuf type google.cloud.clouddms.v1.MigrationJob.PerformanceConfig

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

MultiColumnDatatypeChange

Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once.

The rule filter field can refer to one or more entities.

The rule scope can be one of:Column.

This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields).

Protobuf type google.cloud.clouddms.v1.MultiColumnDatatypeChange

MultiColumnDatatypeChange.Builder

Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once.

The rule filter field can refer to one or more entities.

The rule scope can be one of:Column.

Protobuf type google.cloud.clouddms.v1.MultiColumnDatatypeChange

MultiEntityRename

Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities.

The rule filter field can refer to one or more entities.

The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT

Protobuf type google.cloud.clouddms.v1.MultiEntityRename

MultiEntityRename.Builder

Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities.

The rule filter field can refer to one or more entities.

The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT

Protobuf type google.cloud.clouddms.v1.MultiEntityRename

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

OracleConnectionProfile

Specifies connection parameters required specifically for Oracle databases.

Protobuf type google.cloud.clouddms.v1.OracleConnectionProfile

OracleConnectionProfile.Builder

Specifies connection parameters required specifically for Oracle databases.

Protobuf type google.cloud.clouddms.v1.OracleConnectionProfile

PackageEntity

Package's parent is a schema.

Protobuf type google.cloud.clouddms.v1.PackageEntity

PackageEntity.Builder

Package's parent is a schema.

Protobuf type google.cloud.clouddms.v1.PackageEntity

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

PrivateConnection

The PrivateConnection resource is used to establish private connectivity with the customer's network.

Protobuf type google.cloud.clouddms.v1.PrivateConnection

PrivateConnection.Builder

The PrivateConnection resource is used to establish private connectivity with the customer's network.

Protobuf type google.cloud.clouddms.v1.PrivateConnection

PrivateConnectionName

PrivateConnectionName.Builder

Builder for projects/{project}/locations/{location}/privateConnections/{private_connection}.

PrivateConnectivity

Private Connectivity.

Protobuf type google.cloud.clouddms.v1.PrivateConnectivity

PrivateConnectivity.Builder

Private Connectivity.

Protobuf type google.cloud.clouddms.v1.PrivateConnectivity

PrivateServiceConnectConnectivity

Private Service Connect connectivity

Protobuf type google.cloud.clouddms.v1.PrivateServiceConnectConnectivity

PrivateServiceConnectConnectivity.Builder

Private Service Connect connectivity

Protobuf type google.cloud.clouddms.v1.PrivateServiceConnectConnectivity

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

Protobuf type google.cloud.clouddms.v1.ReverseSshConnectivity

RollbackConversionWorkspaceRequest

Request message for 'RollbackConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.RollbackConversionWorkspaceRequest

RollbackConversionWorkspaceRequest.Builder

Request message for 'RollbackConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.RollbackConversionWorkspaceRequest

RoundToScale

This allows the data to change scale, for example if the source is 2 digits after the decimal point, specify round to scale value = 2. If for example the value needs to be converted to an integer, use round to scale value = 0.

Protobuf type google.cloud.clouddms.v1.RoundToScale

RoundToScale.Builder

Protobuf type google.cloud.clouddms.v1.RoundToScale

SchemaEntity

Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which support it). For some database engines, the terms schema and user can be used interchangeably when they refer to a namespace or a collection of other database entities. Can store additional information which is schema specific.

Protobuf type google.cloud.clouddms.v1.SchemaEntity

SchemaEntity.Builder

Protobuf type google.cloud.clouddms.v1.SchemaEntity

SearchBackgroundJobsRequest

Request message for 'SearchBackgroundJobs' request.

Protobuf type google.cloud.clouddms.v1.SearchBackgroundJobsRequest

SearchBackgroundJobsRequest.Builder

Request message for 'SearchBackgroundJobs' request.

Protobuf type google.cloud.clouddms.v1.SearchBackgroundJobsRequest

SearchBackgroundJobsResponse

Response message for 'SearchBackgroundJobs' request.

Protobuf type google.cloud.clouddms.v1.SearchBackgroundJobsResponse

SearchBackgroundJobsResponse.Builder

Response message for 'SearchBackgroundJobs' request.

Protobuf type google.cloud.clouddms.v1.SearchBackgroundJobsResponse

SeedConversionWorkspaceRequest

Request message for 'SeedConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.SeedConversionWorkspaceRequest

SeedConversionWorkspaceRequest.Builder

Request message for 'SeedConversionWorkspace' request.

Protobuf type google.cloud.clouddms.v1.SeedConversionWorkspaceRequest

SequenceEntity

Sequence's parent is a schema.

Protobuf type google.cloud.clouddms.v1.SequenceEntity

SequenceEntity.Builder

Sequence's parent is a schema.

Protobuf type google.cloud.clouddms.v1.SequenceEntity

SetTablePrimaryKey

Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table.

The rule filter field can refer to one entity.

The rule scope can be one of: Table.

Protobuf type google.cloud.clouddms.v1.SetTablePrimaryKey

SetTablePrimaryKey.Builder

Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table.

The rule filter field can refer to one entity.

The rule scope can be one of: Table.

Protobuf type google.cloud.clouddms.v1.SetTablePrimaryKey

SingleColumnChange

Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column.

The rule filter field can refer to one entity.

The rule scope can be one of: Column.

When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column..

Protobuf type google.cloud.clouddms.v1.SingleColumnChange

SingleColumnChange.Builder

Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column.

The rule filter field can refer to one entity.

The rule scope can be one of: Column.

When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column..

Protobuf type google.cloud.clouddms.v1.SingleColumnChange

SingleEntityRename

Options to configure rule type SingleEntityRename. The rule is used to rename an entity.

The rule filter field can refer to only one entity.

The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym

Protobuf type google.cloud.clouddms.v1.SingleEntityRename

SingleEntityRename.Builder

Options to configure rule type SingleEntityRename. The rule is used to rename an entity.

The rule filter field can refer to only one entity.

The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym

Protobuf type google.cloud.clouddms.v1.SingleEntityRename