Google Cloud Dms V1 Client - Class DataMigrationServiceClient (1.4.2)

Version 1.4.2

• 2.0.3 (latest)
• 2.0.2
• 1.5.5
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Dms V1 Client class 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.

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 parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\CloudDms\V1\DataMigrationServiceClient for the stable implementation

Namespace

Google \ Cloud \ CloudDms \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
options	array Optional. Options for configuring the service API wrapper.
↳ apiEndpoint	string The address of the API remote host. May optionally include the port, formatted as "
↳ credentials	string|array|FetchAuthTokenInterface|CredentialsWrapper The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig	array Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries	bool Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig	string|array Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport	string|TransportInterface The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig	array Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource	callable A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

applyConversionWorkspace

Applies draft tree onto a specific destination database.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::applyConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ApplyConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

commitConversionWorkspace

Marks all the data in the conversion workspace as committed.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::commitConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CommitConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

convertConversionWorkspace

Creates a draft tree schema for the destination database.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::convertConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ConvertConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createConnectionProfile

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreateConnectionProfileRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createConversionWorkspace

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreateConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createMappingRule

Creates a new mapping rule for a given conversion workspace.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createMappingRuleAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreateMappingRuleRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\MappingRule

createMigrationJob

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreateMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

createPrivateConnection

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createPrivateConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreatePrivateConnectionRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

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.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::deleteConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeleteConnectionProfileRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteConversionWorkspace

Deletes a single conversion workspace.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::deleteConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeleteConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deleteMappingRule

Deletes a single mapping rule.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::deleteMappingRuleAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeleteMappingRuleRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteMigrationJob

Deletes a single migration job.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::deleteMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeleteMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

deletePrivateConnection

Deletes a single Database Migration Service private connection.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::deletePrivateConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeletePrivateConnectionRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

describeConversionWorkspaceRevisions

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::describeConversionWorkspaceRevisionsAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DescribeConversionWorkspaceRevisionsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\DescribeConversionWorkspaceRevisionsResponse

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.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::describeDatabaseEntitiesAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DescribeDatabaseEntitiesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

fetchStaticIps

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::fetchStaticIpsAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\FetchStaticIpsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

generateSshScript

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::generateSshScriptAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GenerateSshScriptRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\SshScript

generateTcpProxyScript

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::generateTcpProxyScriptAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GenerateTcpProxyScriptRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\TcpProxyScript

getConnectionProfile

Gets details of a single connection profile.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetConnectionProfileRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\ConnectionProfile

getConversionWorkspace

Gets details of a single conversion workspace.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\ConversionWorkspace

getMappingRule

Gets the details of a mapping rule.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getMappingRuleAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetMappingRuleRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\MappingRule

getMigrationJob

Gets details of a single migration job.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\MigrationJob

getPrivateConnection

Gets details of a single private connection.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getPrivateConnectionAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetPrivateConnectionRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\PrivateConnection

importMappingRules

Imports the mapping rules for a given conversion workspace.

Supports various formats of external rules files.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::importMappingRulesAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ImportMappingRulesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

listConnectionProfiles

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listConnectionProfilesAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListConnectionProfilesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listConversionWorkspaces

Lists conversion workspaces in a given project and location.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listConversionWorkspacesAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListConversionWorkspacesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listMappingRules

Lists the mapping rules for a specific conversion workspace.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listMappingRulesAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListMappingRulesRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listMigrationJobs

Lists migration jobs in a given project and location.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listMigrationJobsAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListMigrationJobsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

listPrivateConnections

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listPrivateConnectionsAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListPrivateConnectionsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\PagedListResponse

promoteMigrationJob

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::promoteMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\PromoteMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

restartMigrationJob

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::restartMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\RestartMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

resumeMigrationJob

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::resumeMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ResumeMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

rollbackConversionWorkspace

Rolls back a conversion workspace to the last committed snapshot.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::rollbackConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\RollbackConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

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.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::searchBackgroundJobsAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\SearchBackgroundJobsRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\Cloud\CloudDms\V1\SearchBackgroundJobsResponse

seedConversionWorkspace

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::seedConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\SeedConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

startMigrationJob

Start an already created migration job.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::startMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\StartMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

stopMigrationJob

Stops a running migration job.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::stopMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\StopMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateConnectionProfile

Update the configuration of a single connection profile.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::updateConnectionProfileAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\UpdateConnectionProfileRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateConversionWorkspace

Updates the parameters of a single conversion workspace.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::updateConversionWorkspaceAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\UpdateConversionWorkspaceRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

updateMigrationJob

Updates the parameters of a single migration job.

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::updateMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\UpdateMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

verifyMigrationJob

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

The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::verifyMigrationJobAsync() .

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\VerifyMigrationJobRequest A request to house fields associated with the call.
callOptions	array Optional.
↳ retrySettings	RetrySettings|array Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
Google\ApiCore\OperationResponse

applyConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ApplyConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

commitConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CommitConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

convertConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ConvertConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreateConnectionProfileRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreateConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createMappingRuleAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreateMappingRuleRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreateMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createPrivateConnectionAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\CreatePrivateConnectionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeleteConnectionProfileRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeleteConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteMappingRuleAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeleteMappingRuleRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeleteMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deletePrivateConnectionAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DeletePrivateConnectionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

describeConversionWorkspaceRevisionsAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DescribeConversionWorkspaceRevisionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

describeDatabaseEntitiesAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\DescribeDatabaseEntitiesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

fetchStaticIpsAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\FetchStaticIpsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

generateSshScriptAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GenerateSshScriptRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

generateTcpProxyScriptAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GenerateTcpProxyScriptRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetConnectionProfileRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getMappingRuleAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetMappingRuleRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getPrivateConnectionAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\GetPrivateConnectionRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

importMappingRulesAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ImportMappingRulesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listConnectionProfilesAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListConnectionProfilesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listConversionWorkspacesAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListConversionWorkspacesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listMappingRulesAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListMappingRulesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listMigrationJobsAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListMigrationJobsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listPrivateConnectionsAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ListPrivateConnectionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

promoteMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\PromoteMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

restartMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\RestartMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

resumeMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\ResumeMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

rollbackConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\RollbackConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

searchBackgroundJobsAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\SearchBackgroundJobsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

seedConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\SeedConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

startMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\StartMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

stopMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\StopMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateConnectionProfileAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\UpdateConnectionProfileRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateConversionWorkspaceAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\UpdateConversionWorkspaceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\UpdateMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

verifyMigrationJobAsync

Parameters
Name	Description
request	Google\Cloud\CloudDms\V1\VerifyMigrationJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
operationName	string The name of the long running operation
methodName	string The name of the method used to start the operation

Returns
Type	Description
Google\ApiCore\OperationResponse

static::connectionProfileName

Formats a string containing the fully-qualified path to represent a connection_profile resource.

Parameters
Name	Description
project	string
location	string
connectionProfile	string

Returns
Type	Description
string	The formatted connection_profile resource.

static::conversionWorkspaceName

Formats a string containing the fully-qualified path to represent a conversion_workspace resource.

Parameters
Name	Description
project	string
location	string
conversionWorkspace	string

Returns
Type	Description
string	The formatted conversion_workspace resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted location resource.

static::mappingRuleName

Formats a string containing the fully-qualified path to represent a mapping_rule resource.

Parameters
Name	Description
project	string
location	string
conversionWorkspace	string
mappingRule	string

Returns
Type	Description
string	The formatted mapping_rule resource.

static::migrationJobName

Formats a string containing the fully-qualified path to represent a migration_job resource.

Parameters
Name	Description
project	string
location	string
migrationJob	string

Returns
Type	Description
string	The formatted migration_job resource.

static::networksName

Formats a string containing the fully-qualified path to represent a networks resource.

Parameters
Name	Description
project	string
network	string

Returns
Type	Description
string	The formatted networks resource.

static::privateConnectionName

Formats a string containing the fully-qualified path to represent a private_connection resource.

Parameters
Name	Description
project	string
location	string
privateConnection	string

Returns
Type	Description
string	The formatted private_connection resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

• connectionProfile: projects/{project}/locations/{location}/connectionProfiles/{connection_profile}
• conversionWorkspace: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}
• location: projects/{project}/locations/{location}
• mappingRule: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule}
• migrationJob: projects/{project}/locations/{location}/migrationJobs/{migration_job}
• networks: projects/{project}/global/networks/{network}
• privateConnection: projects/{project}/locations/{location}/privateConnections/{private_connection}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
formattedName	string The formatted name string
template	string Optional name of template to match

Returns
Type	Description
array	An associative array from name component IDs to component values.