Class: Google::Apis::DatamigrationV1::MigrationJob

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datamigration_v1/classes.rb,
lib/google/apis/datamigration_v1/representations.rb,
lib/google/apis/datamigration_v1/representations.rb

Overview

Represents a Database Migration Service migration job object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MigrationJob

Returns a new instance of MigrationJob.



3544
3545
3546
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3544

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cmek_key_name ⇒ 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] Corresponds to the JSON property cmekKeyName

Returns:

  • (String) 


3340
3341
3342
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3340

def cmek_key_name
  @cmek_key_name
end

#conversion_workspace ⇒ Google::Apis::DatamigrationV1::ConversionWorkspaceInfo

A conversion workspace's version. Corresponds to the JSON property conversionWorkspace

Returns:



3345
3346
3347
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3345

def conversion_workspace
  @conversion_workspace
end

#create_time ⇒ 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". Corresponds to the JSON property createTime

Returns:

  • (String) 


3352
3353
3354
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3352

def create_time
  @create_time
end

#destination ⇒ String

Required. The resource name (URI) of the destination connection profile. Corresponds to the JSON property destination

Returns:

  • (String) 


3357
3358
3359
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3357

def destination
  @destination
end

#destination_database ⇒ Google::Apis::DatamigrationV1::DatabaseType

A message defining the database engine and provider. Corresponds to the JSON property destinationDatabase

Returns:



3362
3363
3364
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3362

def destination_database
  @destination_database
end

#display_name ⇒ String

The migration job display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


3367
3368
3369
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3367

def display_name
  @display_name
end

#dump_flags ⇒ Google::Apis::DatamigrationV1::DumpFlags

Dump flags definition. Corresponds to the JSON property dumpFlags

Returns:



3372
3373
3374
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3372

def dump_flags
  @dump_flags
end

#dump_path ⇒ 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. Corresponds to the JSON property dumpPath

Returns:

  • (String) 


3379
3380
3381
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3379

def dump_path
  @dump_path
end

#dump_type ⇒ String

Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only. Corresponds to the JSON property dumpType

Returns:

  • (String) 


3385
3386
3387
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3385

def dump_type
  @dump_type
end

#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". Corresponds to the JSON property duration

Returns:

  • (String) 


3391
3392
3393
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3391

def duration
  @duration
end

#end_time ⇒ String

Output only. If the migration job is completed, the time when it was completed. Corresponds to the JSON property endTime

Returns:

  • (String) 


3396
3397
3398
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3396

def end_time
  @end_time
end

#error ⇒ Google::Apis::DatamigrationV1::Status

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. Corresponds to the JSON property error

Returns:



3406
3407
3408
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3406

def error
  @error
end

#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. Corresponds to the JSON property filter

Returns:

  • (String) 


3414
3415
3416
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3414

def filter
  @filter
end

#labels ⇒ Hash<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". Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


3422
3423
3424
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3422

def labels
  @labels
end

#name ⇒ String

The name (URI) of this migration job resource, in the form of: projects/ project/locations/location/migrationJobs/migrationJob. Corresponds to the JSON property name

Returns:

  • (String) 


3428
3429
3430
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3428

def name
  @name
end

#objects_config ⇒ Google::Apis::DatamigrationV1::MigrationJobObjectsConfig

Configuration for the objects to be migrated. Corresponds to the JSON property objectsConfig

Returns:



3433
3434
3435
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3433

def objects_config
  @objects_config
end

#oracle_to_postgres_config ⇒ Google::Apis::DatamigrationV1::OracleToPostgresConfig

Configuration for heterogeneous Oracle to Cloud SQL for PostgreSQL and ** Oracle to AlloyDB for PostgreSQL** migrations. Corresponds to the JSON property oracleToPostgresConfig

Returns:



3439
3440
3441
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3439

def oracle_to_postgres_config
  @oracle_to_postgres_config
end

#original_migration_name ⇒ String

Optional. A failback replication pointer to the resource name (URI) of the original migration job. Corresponds to the JSON property originalMigrationName

Returns:

  • (String) 


3445
3446
3447
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3445

def original_migration_name
  @original_migration_name
end

#performance_config ⇒ Google::Apis::DatamigrationV1::PerformanceConfig

Performance configuration definition. Corresponds to the JSON property performanceConfig

Returns:



3450
3451
3452
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3450

def performance_config
  @performance_config
end

#phase ⇒ String

Output only. The current migration job phase. Corresponds to the JSON property phase

Returns:

  • (String) 


3455
3456
3457
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3455

def phase
  @phase
end

#postgres_to_sqlserver_config ⇒ Google::Apis::DatamigrationV1::PostgresToSqlServerConfig

Configuration for heterogeneous failback migrations from PostgreSQL to SQL Server. Corresponds to the JSON property postgresToSqlserverConfig

Returns:



3461
3462
3463
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3461

def postgres_to_sqlserver_config
  @postgres_to_sqlserver_config
end

#purpose ⇒ String

Output only. Migration job mode. Migration jobs can be standard forward jobs or failback migration jobs. Corresponds to the JSON property purpose

Returns:

  • (String) 


3467
3468
3469
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3467

def purpose
  @purpose
end

#reverse_ssh_connectivity ⇒ Google::Apis::DatamigrationV1::ReverseSshConnectivity

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. Corresponds to the JSON property reverseSshConnectivity

Returns:



3477
3478
3479
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3477

def reverse_ssh_connectivity
  @reverse_ssh_connectivity
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


3482
3483
3484
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3482

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


3488
3489
3490
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3488

def satisfies_pzs
  @satisfies_pzs
end

#source ⇒ String

Required. The resource name (URI) of the source connection profile. Corresponds to the JSON property source

Returns:

  • (String) 


3494
3495
3496
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3494

def source
  @source
end

#source_database ⇒ Google::Apis::DatamigrationV1::DatabaseType

A message defining the database engine and provider. Corresponds to the JSON property sourceDatabase

Returns:



3499
3500
3501
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3499

def source_database
  @source_database
end

#sqlserver_homogeneous_migration_job_config ⇒ Google::Apis::DatamigrationV1::SqlServerHomogeneousMigrationJobConfig

Configuration for homogeneous migration to Cloud SQL for SQL Server. Corresponds to the JSON property sqlserverHomogeneousMigrationJobConfig

Returns:



3504
3505
3506
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3504

def sqlserver_homogeneous_migration_job_config
  @sqlserver_homogeneous_migration_job_config
end

#sqlserver_to_postgres_config ⇒ Google::Apis::DatamigrationV1::SqlServerToPostgresConfig

Configuration for heterogeneous SQL Server to Cloud SQL for PostgreSQL migrations. Corresponds to the JSON property sqlserverToPostgresConfig

Returns:



3510
3511
3512
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3510

def sqlserver_to_postgres_config
  @sqlserver_to_postgres_config
end

#state ⇒ String

The current migration job state. Corresponds to the JSON property state

Returns:

  • (String) 


3515
3516
3517
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3515

def state
  @state
end

#static_ip_connectivity ⇒ Google::Apis::DatamigrationV1::StaticIpConnectivity

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. Corresponds to the JSON property staticIpConnectivity

Returns:



3523
3524
3525
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3523

def static_ip_connectivity
  @static_ip_connectivity
end

#type ⇒ String

Required. The migration job type. Corresponds to the JSON property type

Returns:

  • (String) 


3528
3529
3530
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3528

def type
  @type
end

#update_time ⇒ 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". Corresponds to the JSON property updateTime

Returns:

  • (String) 


3535
3536
3537
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3535

def update_time
  @update_time
end

#vpc_peering_connectivity ⇒ Google::Apis::DatamigrationV1::VpcPeeringConnectivity

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. Corresponds to the JSON property vpcPeeringConnectivity

Returns:



3542
3543
3544
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3542

def vpc_peering_connectivity
  @vpc_peering_connectivity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3549

def update!(**args)
  @cmek_key_name = args[:cmek_key_name] if args.key?(:cmek_key_name)
  @conversion_workspace = args[:conversion_workspace] if args.key?(:conversion_workspace)
  @create_time = args[:create_time] if args.key?(:create_time)
  @destination = args[:destination] if args.key?(:destination)
  @destination_database = args[:destination_database] if args.key?(:destination_database)
  @display_name = args[:display_name] if args.key?(:display_name)
  @dump_flags = args[:dump_flags] if args.key?(:dump_flags)
  @dump_path = args[:dump_path] if args.key?(:dump_path)
  @dump_type = args[:dump_type] if args.key?(:dump_type)
  @duration = args[:duration] if args.key?(:duration)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @filter = args[:filter] if args.key?(:filter)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @objects_config = args[:objects_config] if args.key?(:objects_config)
  @oracle_to_postgres_config = args[:oracle_to_postgres_config] if args.key?(:oracle_to_postgres_config)
  @original_migration_name = args[:original_migration_name] if args.key?(:original_migration_name)
  @performance_config = args[:performance_config] if args.key?(:performance_config)
  @phase = args[:phase] if args.key?(:phase)
  @postgres_to_sqlserver_config = args[:postgres_to_sqlserver_config] if args.key?(:postgres_to_sqlserver_config)
  @purpose = args[:purpose] if args.key?(:purpose)
  @reverse_ssh_connectivity = args[:reverse_ssh_connectivity] if args.key?(:reverse_ssh_connectivity)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @source = args[:source] if args.key?(:source)
  @source_database = args[:source_database] if args.key?(:source_database)
  @sqlserver_homogeneous_migration_job_config = args[:sqlserver_homogeneous_migration_job_config] if args.key?(:sqlserver_homogeneous_migration_job_config)
  @sqlserver_to_postgres_config = args[:sqlserver_to_postgres_config] if args.key?(:sqlserver_to_postgres_config)
  @state = args[:state] if args.key?(:state)
  @static_ip_connectivity = args[:static_ip_connectivity] if args.key?(:static_ip_connectivity)
  @type = args[:type] if args.key?(:type)
  @update_time = args[:update_time] if args.key?(:update_time)
  @vpc_peering_connectivity = args[:vpc_peering_connectivity] if args.key?(:vpc_peering_connectivity)
end