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.



921
922
923
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 921

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

Instance Attribute Details

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


806
807
808
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 806

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) 


811
812
813
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 811

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:



816
817
818
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 816

def destination_database
  @destination_database
end

#display_name ⇒ String

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

Returns:

  • (String) 


821
822
823
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 821

def display_name
  @display_name
end

#dump_path ⇒ String

The path to the dump file in Google Cloud Storage, in the format: (gs://[ BUCKET_NAME]/[OBJECT_NAME]). Corresponds to the JSON property dumpPath

Returns:

  • (String) 


827
828
829
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 827

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) 


833
834
835
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 833

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) 


838
839
840
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 838

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:



848
849
850
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 848

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


856
857
858
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 856

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) 


862
863
864
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 862

def name
  @name
end

#phase ⇒ String

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

Returns:

  • (String) 


867
868
869
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 867

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:



877
878
879
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 877

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) 


882
883
884
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 882

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:



887
888
889
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 887

def source_database
  @source_database
end

#state ⇒ String

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

Returns:

  • (String) 


892
893
894
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 892

def state
  @state
end

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

The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. Corresponds to the JSON property staticIpConnectivity

Returns:



900
901
902
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 900

def static_ip_connectivity
  @static_ip_connectivity
end

#type ⇒ String

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

Returns:

  • (String) 


905
906
907
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 905

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) 


912
913
914
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 912

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:



919
920
921
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 919

def vpc_peering_connectivity
  @vpc_peering_connectivity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 926

def update!(**args)
  @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_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)
  @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