MigrationJob

import type { MigrationJob } from "https://googleapis.deno.dev/v1/datamigration:v1.ts";

Represents a Database Migration Service migration job object.

interface MigrationJob {

cmekKeyName?: string;

conversionWorkspace?: ConversionWorkspaceInfo;

readonly createTime?: Date;

destination?: string;

destinationDatabase?: DatabaseType;

displayName?: string;

dumpFlags?: DumpFlags;

dumpPath?: string;

dumpType?: "DUMP_TYPE_UNSPECIFIED" | "LOGICAL" | "PHYSICAL";

readonly duration?: number;

readonly endTime?: Date;

readonly error?: Status;

filter?: string;

labels?: {

[key: string]: string;

};

name?: string;

oracleToPostgresConfig?: OracleToPostgresConfig;

performanceConfig?: PerformanceConfig;

readonly phase?:

| "PHASE_UNSPECIFIED"

| "FULL_DUMP"

| "CDC"

| "PROMOTE_IN_PROGRESS"

| "WAITING_FOR_SOURCE_WRITES_TO_STOP"

| "PREPARING_THE_DUMP"

| "READY_FOR_PROMOTE";

reverseSshConnectivity?: ReverseSshConnectivity;

source?: string;

sourceDatabase?: DatabaseType;

sqlserverHomogeneousMigrationJobConfig?: SqlServerHomogeneousMigrationJobConfig;

state?:

| "STATE_UNSPECIFIED"

| "MAINTENANCE"

| "DRAFT"

| "CREATING"

| "NOT_STARTED"

| "RUNNING"

| "FAILED"

| "COMPLETED"

| "DELETING"

| "STOPPING"

| "STOPPED"

| "DELETED"

| "UPDATING"

| "STARTING"

| "RESTARTING"

| "RESUMING";

staticIpConnectivity?: StaticIpConnectivity;

type?: "TYPE_UNSPECIFIED" | "ONE_TIME" | "CONTINUOUS";

readonly updateTime?: Date;

vpcPeeringConnectivity?: VpcPeeringConnectivity;

}

§Properties

cmekKeyName?: string

[src]

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]

conversionWorkspace?: ConversionWorkspaceInfo

[src]

The conversion workspace used by the migration.

readonly createTime?: Date

[src]

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".

destination?: string

[src]

Required. The resource name (URI) of the destination connection profile.

destinationDatabase?: DatabaseType

[src]

The database engine type and provider of the destination.

displayName?: string

[src]

The migration job display name.

dumpFlags?: DumpFlags

[src]

The initial dump flags. This field and the "dump_path" field are mutually exclusive.

dumpPath?: string

[src]

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.

dumpType?: "DUMP_TYPE_UNSPECIFIED" | "LOGICAL" | "PHYSICAL"

[src]

Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.

readonly duration?: number

[src]

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".

readonly endTime?: Date

[src]

Output only. If the migration job is completed, the time when it was completed.

readonly error?: Status

[src]

Output only. The error details in case of state FAILED.

filter?: string

[src]

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.

labels?: {

[key: string]: string;

}

[src]

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" }.

name?: string

[src]

The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

oracleToPostgresConfig?: OracleToPostgresConfig

[src]

Configuration for heterogeneous Oracle to Cloud SQL for PostgreSQL and Oracle to AlloyDB for PostgreSQL migrations.

performanceConfig?: PerformanceConfig

[src]

Optional. Data dump parallelism settings used by the migration.

[src]

Output only. The current migration job phase.

reverseSshConnectivity?: ReverseSshConnectivity

[src]

The details needed to communicate to the source over Reverse SSH tunnel connectivity.

source?: string

[src]

Required. The resource name (URI) of the source connection profile.

sourceDatabase?: DatabaseType

[src]

The database engine type and provider of the source.

sqlserverHomogeneousMigrationJobConfig?: SqlServerHomogeneousMigrationJobConfig

[src]

Optional. Configuration for SQL Server homogeneous migration.

[src]

The current migration job state.

staticIpConnectivity?: StaticIpConnectivity

[src]

static ip connectivity data (default, no additional details needed).

type?: "TYPE_UNSPECIFIED" | "ONE_TIME" | "CONTINUOUS"

[src]

Required. The migration job type.

readonly updateTime?: Date

[src]

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".

vpcPeeringConnectivity?: VpcPeeringConnectivity

[src]

The details of the VPC network that the source database is located in.