REST Resource: projects.locations.services.migrationExecutions

Resource: MigrationExecution

The details of a migration execution resource.

JSON representation 
{
  "name": string,
  "createTime": string,
  "endTime": string,
  "state": enum (State),
  "phase": enum (Phase),
  "stateMessage": string,

  // Union field migration_config can be only one of the following:
  "cloudSqlMigrationConfig": {
    object (CloudSQLMigrationConfig)
  }
  // End of list of possible types for union field migration_config.
}
Fields
name

string

Output only. The relative resource name of the migration execution, in the following form: projects/{projectNumber}/locations/{locationId}/services/{serviceId}/migrationExecutions/{migration_execution_id}
createTime

string (Timestamp format)

Output only. The time when the migration execution was started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. The time when the migration execution finished.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The current state of the migration execution.
phase

enum (Phase)

Output only. The current phase of the migration execution.
stateMessage

string

Output only. Additional information about the current state of the migration execution.
Union field migration_config. Configuration information required by Dataproc Metastore for starting the migration process migration_config can be only one of the following:
cloudSqlMigrationConfig

object (CloudSQLMigrationConfig)

Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore.

CloudSQLMigrationConfig

Configuration information for migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore.

JSON representation 
{
  "cdcConfig": {
    object (CdcConfig)
  },
  "cloudSqlConnectionConfig": {
    object (CloudSQLConnectionConfig)
  }
}
Fields
cdcConfig

object (CdcConfig)

Required. Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore. Dataproc Metastore switches to using its backend database after the cutover phase of migration.
cloudSqlConnectionConfig

object (CloudSQLConnectionConfig)

Required. Configuration information to establish customer database connection before the cutover phase of migration

CdcConfig

Configuration information to start the Change Data Capture (CDC) streams from customer database to backend database of Dataproc Metastore.

JSON representation 
{
  "vpcNetwork": string,
  "subnetIpRange": string,
  "username": string,
  "password": string,
  "reverseProxySubnet": string,
  "bucket": string,
  "rootPath": string
}
Fields
vpcNetwork

string

Required. Fully qualified name of the Cloud SQL instance's VPC network or the shared VPC network that Datastream will peer to, in the following format: projects/{projectId}/locations/global/networks/{network_id}. More context in https://cloud.google.com/datastream/docs/network-connectivity-options#privateconnectivity
subnetIpRange

string

Required. A /29 CIDR IP range for peering with datastream.
username

string

Required. The username that the Datastream service should use for the MySQL connection.
password

string

Required. Input only. The password for the user that Datastream service should use for the MySQL connection. This field is not returned on request.
reverseProxySubnet

string

Required. The URL of the subnetwork resource to create the VM instance hosting the reverse proxy in. More context in https://cloud.google.com/datastream/docs/private-connectivity#reverse-csql-proxy The subnetwork should reside in the network provided in the request that Datastream will peer to and should be in the same region as Datastream, in the following format. projects/{projectId}/regions/{region_id}/subnetworks/{subnetwork_id}
bucket

string

Optional. The bucket to write the intermediate stream event data in. The bucket name must be without any prefix like "gs://". See the bucket naming requirements. This field is optional. If not set, the Artifacts Cloud Storage bucket will be used.
rootPath

string

Optional. The root path inside the Cloud Storage bucket. The stream event data will be written to this path. The default value is /migration.

CloudSQLConnectionConfig

Configuration information to establish customer database connection before the cutover phase of migration

JSON representation 
{
  "instanceConnectionName": string,
  "ipAddress": string,
  "port": integer,
  "hiveDatabaseName": string,
  "username": string,
  "password": string,
  "proxySubnet": string,
  "natSubnet": string
}
Fields
instanceConnectionName

string

Required. Cloud SQL database connection name (projectId:region:instance_name)
ipAddress

string

Required. The private IP address of the Cloud SQL instance.
port

integer

Required. The network port of the database.
hiveDatabaseName

string

Required. The hive database name.
username

string

Required. The username that Dataproc Metastore service will use to connect to the database.
password

string

Required. Input only. The password for the user that Dataproc Metastore service will be using to connect to the database. This field is not returned on request.
proxySubnet

string

Required. The relative resource name of the subnetwork to deploy the SOCKS5 proxy service in. The subnetwork should reside in a network through which the Cloud SQL instance is accessible. The resource name should be in the format, projects/{projectId}/regions/{region_id}/subnetworks/{subnetwork_id}
natSubnet

string

Required. The relative resource name of the subnetwork to be used for Private Service Connect. Note that this cannot be a regular subnet and is used only for NAT. (https://cloud.google.com/vpc/docs/about-vpc-hosted-services#psc-subnets) This subnet is used to publish the SOCKS5 proxy service. The subnet size must be at least /29 and it should reside in a network through which the Cloud SQL instance is accessible. The resource name should be in the format, projects/{projectId}/regions/{region_id}/subnetworks/{subnetwork_id}

State

The current state of the migration execution.

Enums
STATE_UNSPECIFIED The state of the migration execution is unknown.
STARTING The migration execution is starting.
RUNNING The migration execution is running.
CANCELLING The migration execution is in the process of being cancelled.
AWAITING_USER_ACTION The migration execution is awaiting user action.
SUCCEEDED The migration execution has completed successfully.
FAILED The migration execution has failed.
CANCELLED The migration execution is cancelled.
DELETING The migration execution is being deleted.

Phase

The current phase of the migration execution.

Enums
PHASE_UNSPECIFIED The phase of the migration execution is unknown.
REPLICATION Replication phase refers to the migration phase when Dataproc Metastore is running a pipeline to replicate changes in the customer database to its backend database. During this phase, Dataproc Metastore uses the customer database as the hive metastore backend database.
CUTOVER Cutover phase refers to the migration phase when Dataproc Metastore switches to using its own backend database. Migration enters this phase when customer is done migrating all their clusters/workloads to Dataproc Metastore and triggers CompleteMigration.

Methods

delete

 Deletes a single migration execution.

get

 Gets details of a single migration execution.

list

 Lists migration executions on a service.