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.



2213
2214
2215
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2213

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) 


2072
2073
2074
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2072

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:



2077
2078
2079
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2077

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) 


2084
2085
2086
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2084

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) 


2089
2090
2091
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2089

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:



2094
2095
2096
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2094

def destination_database
  @destination_database
end

#display_name ⇒ String

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

Returns:

  • (String) 


2099
2100
2101
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2099

def display_name
  @display_name
end

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

Dump flags definition. Corresponds to the JSON property dumpFlags

Returns:



2104
2105
2106
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2104

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) 


2111
2112
2113
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2111

def dump_path
  @dump_path
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) 


2117
2118
2119
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2117

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) 


2122
2123
2124
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2122

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:



2132
2133
2134
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2132

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) 


2140
2141
2142
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2140

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


2148
2149
2150
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2148

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) 


2154
2155
2156
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2154

def name
  @name
end

#phase ⇒ String

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

Returns:

  • (String) 


2159
2160
2161
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2159

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:



2169
2170
2171
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2169

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) 


2174
2175
2176
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2174

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:



2179
2180
2181
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2179

def source_database
  @source_database
end

#state ⇒ String

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

Returns:

  • (String) 


2184
2185
2186
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2184

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:



2192
2193
2194
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2192

def static_ip_connectivity
  @static_ip_connectivity
end

#type ⇒ String

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

Returns:

  • (String) 


2197
2198
2199
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2197

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) 


2204
2205
2206
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2204

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:



2211
2212
2213
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2211

def vpc_peering_connectivity
  @vpc_peering_connectivity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2218

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