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.



3047
3048
3049
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3047

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) 


2890
2891
2892
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2890

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:



2895
2896
2897
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2895

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) 


2902
2903
2904
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2902

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) 


2907
2908
2909
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2907

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:



2912
2913
2914
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2912

def destination_database
  @destination_database
end

#display_name ⇒ String

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

Returns:

  • (String) 


2917
2918
2919
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2917

def display_name
  @display_name
end

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

Dump flags definition. Corresponds to the JSON property dumpFlags

Returns:



2922
2923
2924
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2922

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) 


2929
2930
2931
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2929

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) 


2935
2936
2937
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2935

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) 


2941
2942
2943
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2941

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) 


2946
2947
2948
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2946

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:



2956
2957
2958
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2956

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) 


2964
2965
2966
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2964

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>) 


2972
2973
2974
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2972

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) 


2978
2979
2980
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2978

def name
  @name
end

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

Performance configuration definition. Corresponds to the JSON property performanceConfig

Returns:



2983
2984
2985
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2983

def performance_config
  @performance_config
end

#phase ⇒ String

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

Returns:

  • (String) 


2988
2989
2990
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2988

def phase
  @phase
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:



2998
2999
3000
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2998

def reverse_ssh_connectivity
  @reverse_ssh_connectivity
end

#source ⇒ String

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

Returns:

  • (String) 


3003
3004
3005
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3003

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:



3008
3009
3010
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3008

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:



3013
3014
3015
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3013

def sqlserver_homogeneous_migration_job_config
  @sqlserver_homogeneous_migration_job_config
end

#state ⇒ String

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

Returns:

  • (String) 


3018
3019
3020
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3018

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:



3026
3027
3028
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3026

def static_ip_connectivity
  @static_ip_connectivity
end

#type ⇒ String

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

Returns:

  • (String) 


3031
3032
3033
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3031

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) 


3038
3039
3040
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3038

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:



3045
3046
3047
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3045

def vpc_peering_connectivity
  @vpc_peering_connectivity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 3052

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)
  @performance_config = args[:performance_config] if args.key?(:performance_config)
  @phase = args[:phase] if args.key?(:phase)
  @reverse_ssh_connectivity = args[:reverse_ssh_connectivity] if args.key?(:reverse_ssh_connectivity)
  @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)
  @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