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 \ ClientMethods
__construct
Constructor.
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() .
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.
commitConversionWorkspace
Marks all the data in the conversion workspace as committed.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::commitConversionWorkspaceAsync() .
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.
convertConversionWorkspace
Creates a draft tree schema for the destination database.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::convertConversionWorkspaceAsync() .
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.
createConnectionProfile
Creates a new connection profile in a given project and location.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createConnectionProfileAsync() .
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.
createConversionWorkspace
Creates a new conversion workspace in a given project and location.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createConversionWorkspaceAsync() .
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.
createMappingRule
Creates a new mapping rule for a given conversion workspace.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createMappingRuleAsync() .
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.
createMigrationJob
Creates a new migration job in a given project and location.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createMigrationJobAsync() .
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.
createPrivateConnection
Creates a new private connection in a given project and location.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::createPrivateConnectionAsync() .
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.
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() .
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.
deleteConversionWorkspace
Deletes a single conversion workspace.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::deleteConversionWorkspaceAsync() .
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.
deleteMappingRule
Deletes a single mapping rule.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::deleteMappingRuleAsync() .
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() .
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.
deletePrivateConnection
Deletes a single Database Migration Service private connection.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::deletePrivateConnectionAsync() .
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.
describeConversionWorkspaceRevisions
Retrieves a list of committed revisions of a specific conversion workspace.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::describeConversionWorkspaceRevisionsAsync() .
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.
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() .
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.
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() .
request
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.
generateSshScript
Generate a SSH configuration script to configure the reverse SSH connectivity.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::generateSshScriptAsync() .
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.
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() .
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.
getConnectionProfile
Gets details of a single connection profile.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getConnectionProfileAsync() .
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.
getConversionWorkspace
Gets details of a single conversion workspace.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getConversionWorkspaceAsync() .
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.
getMappingRule
Gets the details of a mapping rule.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getMappingRuleAsync() .
request
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.
getMigrationJob
Gets details of a single migration job.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getMigrationJobAsync() .
request
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.
getPrivateConnection
Gets details of a single private connection.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::getPrivateConnectionAsync() .
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.
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() .
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.
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() .
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.
listConversionWorkspaces
Lists conversion workspaces in a given project and location.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listConversionWorkspacesAsync() .
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.
listMappingRules
Lists the mapping rules for a specific conversion workspace.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listMappingRulesAsync() .
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.
listMigrationJobs
Lists migration jobs in a given project and location.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listMigrationJobsAsync() .
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.
listPrivateConnections
Retrieves a list of private connections in a given project and location.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::listPrivateConnectionsAsync() .
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.
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() .
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.
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() .
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.
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() .
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.
rollbackConversionWorkspace
Rolls back a conversion workspace to the last committed snapshot.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::rollbackConversionWorkspaceAsync() .
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.
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() .
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.
seedConversionWorkspace
Imports a snapshot of the source database into the conversion workspace.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::seedConversionWorkspaceAsync() .
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.
startMigrationJob
Start an already created migration job.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::startMigrationJobAsync() .
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.
stopMigrationJob
Stops a running migration job.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::stopMigrationJobAsync() .
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.
updateConnectionProfile
Update the configuration of a single connection profile.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::updateConnectionProfileAsync() .
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.
updateConversionWorkspace
Updates the parameters of a single conversion workspace.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::updateConversionWorkspaceAsync() .
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.
updateMigrationJob
Updates the parameters of a single migration job.
The async variant is Google\Cloud\CloudDms\V1\Client\DataMigrationServiceClient::updateMigrationJobAsync() .
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.
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() .
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.
applyConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
commitConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
convertConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createMappingRuleAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createPrivateConnectionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteMappingRuleAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deletePrivateConnectionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
describeConversionWorkspaceRevisionsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
describeDatabaseEntitiesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
fetchStaticIpsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
generateSshScriptAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
generateTcpProxyScriptAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getMappingRuleAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getPrivateConnectionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
importMappingRulesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listConnectionProfilesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listConversionWorkspacesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listMappingRulesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listMigrationJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listPrivateConnectionsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
promoteMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
restartMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
resumeMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
rollbackConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
searchBackgroundJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
seedConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
startMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
stopMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateConnectionProfileAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateConversionWorkspaceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
verifyMigrationJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::connectionProfileName
Formats a string containing the fully-qualified path to represent a connection_profile resource.
project
string
location
string
connectionProfile
string
string
static::conversionWorkspaceName
Formats a string containing the fully-qualified path to represent a conversion_workspace resource.
project
string
location
string
conversionWorkspace
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::mappingRuleName
Formats a string containing the fully-qualified path to represent a mapping_rule resource.
project
string
location
string
conversionWorkspace
string
mappingRule
string
string
static::migrationJobName
Formats a string containing the fully-qualified path to represent a migration_job resource.
project
string
location
string
migrationJob
string
string
static::networksName
Formats a string containing the fully-qualified path to represent a networks resource.
project
string
network
string
string
static::privateConnectionName
Formats a string containing the fully-qualified path to represent a private_connection resource.
project
string
location
string
privateConnection
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
