Struct DataMigrationService 

pub struct DataMigrationService { /* private fields */ }

Implements a client for the Database Migration API.

Example

let client = DataMigrationService::builder().build().await?;
// use `client` to make requests to the Database Migration API.

Service Description

Database Migration service

Configuration

To configure DataMigrationService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://datamigration.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

DataMigrationService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap DataMigrationService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl DataMigrationService

pub fn builder() -> ClientBuilder

Returns a builder for DataMigrationService.

let client = DataMigrationService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: DataMigrationService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn list_migration_jobs(&self) -> ListMigrationJobs

Lists migration jobs in a given project and location.

pub fn get_migration_job(&self) -> GetMigrationJob

Gets details of a single migration job.

pub fn create_migration_job(&self) -> CreateMigrationJob

Creates a new migration job in a given project and location.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_migration_job(&self) -> UpdateMigrationJob

Updates the parameters of a single migration job.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_migration_job(&self) -> DeleteMigrationJob

Deletes a single migration job.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn start_migration_job(&self) -> StartMigrationJob

Start an already created migration job.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn stop_migration_job(&self) -> StopMigrationJob

Stops a running migration job.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn resume_migration_job(&self) -> ResumeMigrationJob

Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn promote_migration_job(&self) -> PromoteMigrationJob

Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn verify_migration_job(&self) -> VerifyMigrationJob

Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn restart_migration_job(&self) -> RestartMigrationJob

Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn generate_ssh_script(&self) -> GenerateSshScript

Generate a SSH configuration script to configure the reverse SSH connectivity.

pub fn generate_tcp_proxy_script(&self) -> GenerateTcpProxyScript

Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

pub fn list_connection_profiles(&self) -> ListConnectionProfiles

Retrieves a list of all connection profiles in a given project and location.

pub fn get_connection_profile(&self) -> GetConnectionProfile

Gets details of a single connection profile.

pub fn create_connection_profile(&self) -> CreateConnectionProfile

Creates a new connection profile in a given project and location.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_connection_profile(&self) -> UpdateConnectionProfile

Update the configuration of a single connection profile.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_connection_profile(&self) -> DeleteConnectionProfile

Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_private_connection(&self) -> CreatePrivateConnection

Creates a new private connection in a given project and location.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_private_connection(&self) -> GetPrivateConnection

Gets details of a single private connection.

pub fn list_private_connections(&self) -> ListPrivateConnections

Retrieves a list of private connections in a given project and location.

pub fn delete_private_connection(&self) -> DeletePrivateConnection

Deletes a single Database Migration Service private connection.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_conversion_workspace(&self) -> GetConversionWorkspace

Gets details of a single conversion workspace.

pub fn list_conversion_workspaces(&self) -> ListConversionWorkspaces

Lists conversion workspaces in a given project and location.

pub fn create_conversion_workspace(&self) -> CreateConversionWorkspace

Creates a new conversion workspace in a given project and location.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_conversion_workspace(&self) -> UpdateConversionWorkspace

Updates the parameters of a single conversion workspace.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_conversion_workspace(&self) -> DeleteConversionWorkspace

Deletes a single conversion workspace.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_mapping_rule(&self) -> CreateMappingRule

Creates a new mapping rule for a given conversion workspace.

pub fn delete_mapping_rule(&self) -> DeleteMappingRule

Deletes a single mapping rule.

pub fn list_mapping_rules(&self) -> ListMappingRules

Lists the mapping rules for a specific conversion workspace.

pub fn get_mapping_rule(&self) -> GetMappingRule

Gets the details of a mapping rule.

pub fn seed_conversion_workspace(&self) -> SeedConversionWorkspace

Imports a snapshot of the source database into the conversion workspace.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn import_mapping_rules(&self) -> ImportMappingRules

Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn convert_conversion_workspace(&self) -> ConvertConversionWorkspace

Creates a draft tree schema for the destination database.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn commit_conversion_workspace(&self) -> CommitConversionWorkspace

Marks all the data in the conversion workspace as committed.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn rollback_conversion_workspace(&self) -> RollbackConversionWorkspace

Rolls back a conversion workspace to the last committed snapshot.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn apply_conversion_workspace(&self) -> ApplyConversionWorkspace

Applies draft tree onto a specific destination database.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn describe_database_entities(&self) -> DescribeDatabaseEntities

Describes the database entities tree for a specific conversion workspace and a specific tree type.

Database entities are not resources like conversion workspaces or mapping rules, and they can’t be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.

pub fn search_background_jobs(&self) -> SearchBackgroundJobs

Searches/lists the background jobs for a specific conversion workspace.

The background jobs are not resources like conversion workspaces or mapping rules, and they can’t be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.

pub fn describe_conversion_workspace_revisions( &self, ) -> DescribeConversionWorkspaceRevisions

Retrieves a list of committed revisions of a specific conversion workspace.

pub fn fetch_static_ips(&self) -> FetchStaticIps

Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for DataMigrationService

fn clone(&self) -> DataMigrationService

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataMigrationService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.