migration_jobs

Overview

Name	migration_jobs
Type	Resource
Id	google.datamigration.migration_jobs

Fields

Name	Datatype	Description
name	string	The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
displayName	string	The migration job display name.
conversionWorkspace	object	A conversion workspace's version.
type	string	Required. The migration job type.
source	string	Required. The resource name (URI) of the source connection profile.
dumpPath	string	The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
destinationDatabase	object	A message defining the database engine and provider.
state	string	The current migration job state.
vpcPeeringConnectivity	object	The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.
reverseSshConnectivity	object	The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.
createTime	string	Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
updateTime	string	Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
labels	object	The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
duration	string	Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
destination	string	Required. The resource name (URI) of the destination connection profile.
cmekKeyName	string	The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
staticIpConnectivity	object	The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required.
filter	string	This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
sourceDatabase	object	A message defining the database engine and provider.
phase	string	Output only. The current migration job phase.
dumpFlags	object	Dump flags definition.
endTime	string	Output only. If the migration job is completed, the time when it was completed.
error	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
performanceConfig	object	Performance configuration definition.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, migrationJobsId, projectsId	Gets details of a single migration job.
list	SELECT	locationsId, projectsId	Lists migration jobs in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new migration job in a given project and location.
delete	DELETE	locationsId, migrationJobsId, projectsId	Deletes a single migration job.
_list	EXEC	locationsId, projectsId	Lists migration jobs in a given project and location.
generate_ssh_script	EXEC	locationsId, migrationJobsId, projectsId	Generate a SSH configuration script to configure the reverse SSH connectivity.
generate_tcp_proxy_script	EXEC	locationsId, migrationJobsId, projectsId	Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
patch	EXEC	locationsId, migrationJobsId, projectsId	Updates the parameters of a single migration job.
promote	EXEC	locationsId, migrationJobsId, projectsId	Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
restart	EXEC	locationsId, migrationJobsId, projectsId	Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
resume	EXEC	locationsId, migrationJobsId, projectsId	Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
start	EXEC	locationsId, migrationJobsId, projectsId	Start an already created migration job.
stop	EXEC	locationsId, migrationJobsId, projectsId	Stops a running migration job.
verify	EXEC	locationsId, migrationJobsId, projectsId	Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.