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. Sample code to get started:
$dataMigrationServiceClient = new DataMigrationServiceClient();
try {
$formattedParent = $dataMigrationServiceClient->connectionProfileName('[PROJECT]', '[LOCATION]', '[CONNECTION_PROFILE]');
$connectionProfileId = 'connection_profile_id';
$connectionProfile = new ConnectionProfile();
$operationResponse = $dataMigrationServiceClient->createConnectionProfile($formattedParent, $connectionProfileId, $connectionProfile);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $dataMigrationServiceClient->createConnectionProfile($formattedParent, $connectionProfileId, $connectionProfile);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $dataMigrationServiceClient->resumeOperation($operationName, 'createConnectionProfile');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$dataMigrationServiceClient->close();
}
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.
Methods
connectionProfileName
Formats a string containing the fully-qualified path to represent a connection_profile resource.
project
string
location
string
connectionProfile
string
string
locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
migrationJobName
Formats a string containing the fully-qualified path to represent a migration_job resource.
project
string
location
string
migrationJob
string
string
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}
- location: projects/{project}/locations/{location}
- migrationJob: projects/{project}/locations/{location}/migrationJobs/{migration_job}
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
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
__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.
createConnectionProfile
Creates a new connection profile in a given project and location.
parent
string
Required. The parent, which owns this collection of connection profiles.
connectionProfileId
string
Required. The connection profile identifier.
connectionProfile
Google\Cloud\CloudDms\V1\ConnectionProfile
Required. The create request body including the connection profile data
optionalArgs
array
Optional.
↳ requestId
string
A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\ConnectionProfile;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent, which owns this collection of connection profiles. Please see
* {@see DataMigrationServiceClient::connectionProfileName()} for help formatting this field.
* @param string $connectionProfileId The connection profile identifier.
*/
function create_connection_profile_sample(
string $formattedParent,
string $connectionProfileId
): void {
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$connectionProfile = new ConnectionProfile();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->createConnectionProfile(
$formattedParent,
$connectionProfileId,
$connectionProfile
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ConnectionProfile $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataMigrationServiceClient::connectionProfileName(
'[PROJECT]',
'[LOCATION]',
'[CONNECTION_PROFILE]'
);
$connectionProfileId = '[CONNECTION_PROFILE_ID]';
create_connection_profile_sample($formattedParent, $connectionProfileId);
}
createMigrationJob
Creates a new migration job in a given project and location.
parent
string
Required. The parent, which owns this collection of migration jobs.
migrationJobId
string
Required. The ID of the instance to create.
migrationJob
optionalArgs
array
Optional.
↳ requestId
string
A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
use Google\Cloud\CloudDms\V1\MigrationJob\Type;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent, which owns this collection of migration jobs. Please see
* {@see DataMigrationServiceClient::locationName()} for help formatting this field.
* @param string $migrationJobId The ID of the instance to create.
* @param int $migrationJobType The migration job type.
* @param string $migrationJobSource The resource name (URI) of the source connection profile.
* @param string $migrationJobDestination The resource name (URI) of the destination connection profile.
*/
function create_migration_job_sample(
string $formattedParent,
string $migrationJobId,
int $migrationJobType,
string $migrationJobSource,
string $migrationJobDestination
): void {
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$migrationJob = (new MigrationJob())
->setType($migrationJobType)
->setSource($migrationJobSource)
->setDestination($migrationJobDestination);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->createMigrationJob(
$formattedParent,
$migrationJobId,
$migrationJob
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MigrationJob $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataMigrationServiceClient::locationName('[PROJECT]', '[LOCATION]');
$migrationJobId = '[MIGRATION_JOB_ID]';
$migrationJobType = Type::TYPE_UNSPECIFIED;
$migrationJobSource = '[SOURCE]';
$migrationJobDestination = '[DESTINATION]';
create_migration_job_sample(
$formattedParent,
$migrationJobId,
$migrationJobType,
$migrationJobSource,
$migrationJobDestination
);
}
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.
name
string
Required. Name of the connection profile resource to delete.
optionalArgs
array
Optional.
↳ requestId
string
A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
↳ force
bool
In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedName Name of the connection profile resource to delete. Please see
* {@see DataMigrationServiceClient::connectionProfileName()} for help formatting this field.
*/
function delete_connection_profile_sample(string $formattedName): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->deleteConnectionProfile($formattedName);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataMigrationServiceClient::connectionProfileName(
'[PROJECT]',
'[LOCATION]',
'[CONNECTION_PROFILE]'
);
delete_connection_profile_sample($formattedName);
}
deleteMigrationJob
Deletes a single migration job.
name
string
Required. Name of the migration job resource to delete.
optionalArgs
array
Optional.
↳ requestId
string
A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
↳ force
bool
The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedName Name of the migration job resource to delete. Please see
* {@see DataMigrationServiceClient::migrationJobName()} for help formatting this field.
*/
function delete_migration_job_sample(string $formattedName): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->deleteMigrationJob($formattedName);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataMigrationServiceClient::migrationJobName(
'[PROJECT]',
'[LOCATION]',
'[MIGRATION_JOB]'
);
delete_migration_job_sample($formattedName);
}
generateSshScript
Generate a SSH configuration script to configure the reverse SSH connectivity.
vm
string
Required. Bastion VM Instance name to use or to create.
optionalArgs
array
Optional.
↳ migrationJob
string
Name of the migration job resource to generate the SSH script.
↳ vmCreationConfig
VmCreationConfig
The VM creation configuration
↳ vmSelectionConfig
VmSelectionConfig
The VM selection configuration
↳ vmPort
int
The port that will be open on the bastion host
↳ 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.
use Google\ApiCore\ApiException;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\SshScript;
/**
* @param string $vm Bastion VM Instance name to use or to create.
*/
function generate_ssh_script_sample(string $vm): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var SshScript $response */
$response = $dataMigrationServiceClient->generateSshScript($vm);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$vm = '[VM]';
generate_ssh_script_sample($vm);
}
getConnectionProfile
Gets details of a single connection profile.
name
string
Required. Name of the connection profile resource to get.
optionalArgs
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.
use Google\ApiCore\ApiException;
use Google\Cloud\CloudDms\V1\ConnectionProfile;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
/**
* @param string $formattedName Name of the connection profile resource to get. Please see
* {@see DataMigrationServiceClient::connectionProfileName()} for help formatting this field.
*/
function get_connection_profile_sample(string $formattedName): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var ConnectionProfile $response */
$response = $dataMigrationServiceClient->getConnectionProfile($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataMigrationServiceClient::connectionProfileName(
'[PROJECT]',
'[LOCATION]',
'[CONNECTION_PROFILE]'
);
get_connection_profile_sample($formattedName);
}
getMigrationJob
Gets details of a single migration job.
name
string
Required. Name of the migration job resource to get.
optionalArgs
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.
use Google\ApiCore\ApiException;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
/**
* @param string $formattedName Name of the migration job resource to get. Please see
* {@see DataMigrationServiceClient::migrationJobName()} for help formatting this field.
*/
function get_migration_job_sample(string $formattedName): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var MigrationJob $response */
$response = $dataMigrationServiceClient->getMigrationJob($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataMigrationServiceClient::migrationJobName(
'[PROJECT]',
'[LOCATION]',
'[MIGRATION_JOB]'
);
get_migration_job_sample($formattedName);
}
listConnectionProfiles
Retrieve a list of all connection profiles in a given project and location.
parent
string
Required. The parent, which owns this collection of connection profiles.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter
string
A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list connection profiles created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify mySql.username = %lt;my_username%gt;to list all connection profiles configured to connect with a specific username.
↳ orderBy
string
the order by fields for the result.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudDms\V1\ConnectionProfile;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
/**
* @param string $formattedParent The parent, which owns this collection of connection profiles. Please see
* {@see DataMigrationServiceClient::locationName()} for help formatting this field.
*/
function list_connection_profiles_sample(string $formattedParent): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataMigrationServiceClient->listConnectionProfiles($formattedParent);
/** @var ConnectionProfile $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataMigrationServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_connection_profiles_sample($formattedParent);
}
listMigrationJobs
Lists migration jobs in a given project and location.
parent
string
Required. The parent, which owns this collection of migrationJobs.
optionalArgs
array
Optional.
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ filter
string
A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z.You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4"to select all migration jobs connecting through the specific SSH tunnel bastion.
↳ orderBy
string
Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
/**
* @param string $formattedParent The parent, which owns this collection of migrationJobs. Please see
* {@see DataMigrationServiceClient::locationName()} for help formatting this field.
*/
function list_migration_jobs_sample(string $formattedParent): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataMigrationServiceClient->listMigrationJobs($formattedParent);
/** @var MigrationJob $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataMigrationServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_migration_jobs_sample($formattedParent);
}
promoteMigrationJob
Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
optionalArgs
array
Optional.
↳ name
string
Name of the migration job resource to promote.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function promote_migration_job_sample(): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->promoteMigrationJob();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MigrationJob $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
restartMigrationJob
Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
optionalArgs
array
Optional.
↳ name
string
Name of the migration job resource to restart.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function restart_migration_job_sample(): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->restartMigrationJob();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MigrationJob $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
resumeMigrationJob
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
optionalArgs
array
Optional.
↳ name
string
Name of the migration job resource to resume.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function resume_migration_job_sample(): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->resumeMigrationJob();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MigrationJob $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
startMigrationJob
Start an already created migration job.
optionalArgs
array
Optional.
↳ name
string
Name of the migration job resource to start.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function start_migration_job_sample(): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->startMigrationJob();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MigrationJob $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
stopMigrationJob
Stops a running migration job.
optionalArgs
array
Optional.
↳ name
string
Name of the migration job resource to stop.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function stop_migration_job_sample(): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->stopMigrationJob();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MigrationJob $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateConnectionProfile
Update the configuration of a single connection profile.
updateMask
Google\Protobuf\FieldMask
Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update.
connectionProfile
optionalArgs
array
Optional.
↳ requestId
string
A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\ConnectionProfile;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_connection_profile_sample(): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$connectionProfile = new ConnectionProfile();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->updateConnectionProfile($updateMask, $connectionProfile);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ConnectionProfile $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateMigrationJob
Updates the parameters of a single migration job.
updateMask
Google\Protobuf\FieldMask
Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update.
migrationJob
optionalArgs
array
Optional.
↳ requestId
string
A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
use Google\Cloud\CloudDms\V1\MigrationJob\Type;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* @param int $migrationJobType The migration job type.
* @param string $migrationJobSource The resource name (URI) of the source connection profile.
* @param string $migrationJobDestination The resource name (URI) of the destination connection profile.
*/
function update_migration_job_sample(
int $migrationJobType,
string $migrationJobSource,
string $migrationJobDestination
): void {
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$migrationJob = (new MigrationJob())
->setType($migrationJobType)
->setSource($migrationJobSource)
->setDestination($migrationJobDestination);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->updateMigrationJob($updateMask, $migrationJob);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MigrationJob $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$migrationJobType = Type::TYPE_UNSPECIFIED;
$migrationJobSource = '[SOURCE]';
$migrationJobDestination = '[DESTINATION]';
update_migration_job_sample($migrationJobType, $migrationJobSource, $migrationJobDestination);
}
verifyMigrationJob
Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.
optionalArgs
array
Optional.
↳ name
string
Name of the migration job resource to verify.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\CloudDms\V1\DataMigrationServiceClient;
use Google\Cloud\CloudDms\V1\MigrationJob;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function verify_migration_job_sample(): void
{
// Create a client.
$dataMigrationServiceClient = new DataMigrationServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataMigrationServiceClient->verifyMigrationJob();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var MigrationJob $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
Constants
SERVICE_NAME
Value: 'google.cloud.clouddms.v1.DataMigrationService'
The name of the service.
SERVICE_ADDRESS
Value: 'datamigration.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.