MigrationJobArgs class

The set of arguments for MigrationJob. The set of arguments for MigrationJob.

Constructors

MigrationJobArgs({Input<String>? cmekKeyName, Input<ConversionWorkspaceInfo>? conversionWorkspace, required Input<String> destination, Input<DatabaseType>? destinationDatabase, Input<String>? displayName, Input<DumpFlags>? dumpFlags, Input<String>? dumpPath, Input<String>? filter, Input<Map<String, String>>? labels, Input<String>? location, required Input<String> migrationJobId, Input<String>? name, Input<PerformanceConfig>? performanceConfig, Input<String>? project, Input<String>? requestId, Input<ReverseSshConnectivity>? reverseSshConnectivity, required Input<String> source, Input<DatabaseType>? sourceDatabase, Input<MigrationJobState>? state, Input<Map<String, dynamic>>? staticIpConnectivity, required Input<MigrationJobType> type, Input<VpcPeeringConnectivity>? vpcPeeringConnectivity})
Creates a new MigrationJobArgs. cmekKeyName 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 The conversion workspace used by the migration. destination The resource name (URI) of the destination connection profile. destinationDatabase The database engine type and provider of the destination. displayName The migration job display name. dumpFlags The initial dump flags. This field and the "dump_path" field are mutually exclusive. dumpPath 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. filter 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 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" }. location Optional. migrationJobId Required. The ID of the instance to create. name The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. performanceConfig Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only. project Optional. requestId Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is 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. reverseSshConnectivity The details needed to communicate to the source over Reverse SSH tunnel connectivity. source The resource name (URI) of the source connection profile. sourceDatabase The database engine type and provider of the source. state The current migration job state. staticIpConnectivity static ip connectivity data (default, no additional details needed). type The migration job type. vpcPeeringConnectivity The details of the VPC network that the source database is located in.
const
MigrationJobArgs.fromMap(Map<String, dynamic> map)
factory

Properties

cmekKeyName → Input<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
final
conversionWorkspace → Input<ConversionWorkspaceInfo>?
The conversion workspace used by the migration.
final
destination → Input<String>
The resource name (URI) of the destination connection profile.
final
destinationDatabase → Input<DatabaseType>?
The database engine type and provider of the destination.
final
displayName → Input<String>?
The migration job display name.
final
dumpFlags → Input<DumpFlags>?
The initial dump flags. This field and the "dump_path" field are mutually exclusive.
final
dumpPath → Input<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.
final
filter → Input<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.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>>?
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" }.
final
location → Input<String>?
final
migrationJobId → Input<String>
Required. The ID of the instance to create.
final
name → Input<String>?
The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
final
performanceConfig → Input<PerformanceConfig>?
Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
final
project → Input<String>?
final
requestId → Input<String>?
Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is 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.
final
reverseSshConnectivity → Input<ReverseSshConnectivity>?
The details needed to communicate to the source over Reverse SSH tunnel connectivity.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source → Input<String>
The resource name (URI) of the source connection profile.
final
sourceDatabase → Input<DatabaseType>?
The database engine type and provider of the source.
final
state → Input<MigrationJobState>?
The current migration job state.
final
staticIpConnectivity → Input<Map<String, dynamic>>?
static ip connectivity data (default, no additional details needed).
final
type → Input<MigrationJobType>
The migration job type.
final
vpcPeeringConnectivity → Input<VpcPeeringConnectivity>?
The details of the VPC network that the source database is located in.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited