Class: OCI::DatabaseMigration::Models::MigrationSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/migration_summary.rb

Overview

Migration resource This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

DATABASE_COMBINATION_ENUM = 
[
  DATABASE_COMBINATION_MYSQL = 'MYSQL'.freeze,
  DATABASE_COMBINATION_ORACLE = 'ORACLE'.freeze,
  DATABASE_COMBINATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_ONLINE = 'ONLINE'.freeze,
  TYPE_OFFLINE = 'OFFLINE'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_DETAILS_ENUM = 
[
  LIFECYCLE_DETAILS_READY = 'READY'.freeze,
  LIFECYCLE_DETAILS_ABORTING = 'ABORTING'.freeze,
  LIFECYCLE_DETAILS_VALIDATING = 'VALIDATING'.freeze,
  LIFECYCLE_DETAILS_VALIDATED = 'VALIDATED'.freeze,
  LIFECYCLE_DETAILS_WAITING = 'WAITING'.freeze,
  LIFECYCLE_DETAILS_MIGRATING = 'MIGRATING'.freeze,
  LIFECYCLE_DETAILS_DONE = 'DONE'.freeze,
  LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MigrationSummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :database_combination (String) —

    The value to assign to the #database_combination property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :type (String) —

    The value to assign to the #type property

  • :source_database_connection_id (String) —

    The value to assign to the #source_database_connection_id property

  • :target_database_connection_id (String) —

    The value to assign to the #target_database_connection_id property

  • :executing_job_id (String) —

    The value to assign to the #executing_job_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :time_last_migration (DateTime) —

    The value to assign to the #time_last_migration property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 218

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.database_combination = attributes[:'databaseCombination'] if attributes[:'databaseCombination']

  raise 'You cannot provide both :databaseCombination and :database_combination' if attributes.key?(:'databaseCombination') && attributes.key?(:'database_combination')

  self.database_combination = attributes[:'database_combination'] if attributes[:'database_combination']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.type = attributes[:'type'] if attributes[:'type']

  self.source_database_connection_id = attributes[:'sourceDatabaseConnectionId'] if attributes[:'sourceDatabaseConnectionId']

  raise 'You cannot provide both :sourceDatabaseConnectionId and :source_database_connection_id' if attributes.key?(:'sourceDatabaseConnectionId') && attributes.key?(:'source_database_connection_id')

  self.source_database_connection_id = attributes[:'source_database_connection_id'] if attributes[:'source_database_connection_id']

  self.target_database_connection_id = attributes[:'targetDatabaseConnectionId'] if attributes[:'targetDatabaseConnectionId']

  raise 'You cannot provide both :targetDatabaseConnectionId and :target_database_connection_id' if attributes.key?(:'targetDatabaseConnectionId') && attributes.key?(:'target_database_connection_id')

  self.target_database_connection_id = attributes[:'target_database_connection_id'] if attributes[:'target_database_connection_id']

  self.executing_job_id = attributes[:'executingJobId'] if attributes[:'executingJobId']

  raise 'You cannot provide both :executingJobId and :executing_job_id' if attributes.key?(:'executingJobId') && attributes.key?(:'executing_job_id')

  self.executing_job_id = attributes[:'executing_job_id'] if attributes[:'executing_job_id']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.time_last_migration = attributes[:'timeLastMigration'] if attributes[:'timeLastMigration']

  raise 'You cannot provide both :timeLastMigration and :time_last_migration' if attributes.key?(:'timeLastMigration') && attributes.key?(:'time_last_migration')

  self.time_last_migration = attributes[:'time_last_migration'] if attributes[:'time_last_migration']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

  raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details')

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the resource being referenced.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 71

def compartment_id
  @compartment_id
end

#database_combination ⇒ String

[Required] The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 61

def database_combination
  @database_combination
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


124
125
126
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 124

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 67

def display_name
  @display_name
end

#executing_job_id ⇒ String

The OCID of the resource being referenced.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 89

def executing_job_id
  @executing_job_id
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: "Finance"

Returns:

  • (Hash<String, String>) 


118
119
120
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 118

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource being referenced.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 55

def id
  @id
end

#lifecycle_details ⇒ String

Additional status related to the execution and current state of the Migration.

Returns:

  • (String) 


112
113
114
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 112

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Migration resource.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 108

def lifecycle_state
  @lifecycle_state
end

#source_database_connection_id ⇒ String

[Required] The OCID of the resource being referenced.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 81

def source_database_connection_id
  @source_database_connection_id
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


130
131
132
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 130

def system_tags
  @system_tags
end

#target_database_connection_id ⇒ String

[Required] The OCID of the resource being referenced.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 85

def target_database_connection_id
  @target_database_connection_id
end

#time_created ⇒ DateTime

[Required] An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


94
95
96
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 94

def time_created
  @time_created
end

#time_last_migration ⇒ DateTime

An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 104

def time_last_migration
  @time_last_migration
end

#time_updated ⇒ DateTime

An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

Returns:

  • (DateTime) 


99
100
101
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 99

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 77

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 133

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'database_combination': :'databaseCombination',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'source_database_connection_id': :'sourceDatabaseConnectionId',
    'target_database_connection_id': :'targetDatabaseConnectionId',
    'executing_job_id': :'executingJobId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_last_migration': :'timeLastMigration',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 185

def self.get_subtype(object_hash)
  type = object_hash[:'databaseCombination'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DatabaseMigration::Models::OracleMigrationSummary' if type == 'ORACLE'
  return 'OCI::DatabaseMigration::Models::MySqlMigrationSummary' if type == 'MYSQL'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseMigration::Models::MigrationSummary'
end

.swagger_types ⇒ Object

Attribute type mapping.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 157

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'database_combination': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'type': :'String',
    'source_database_connection_id': :'String',
    'target_database_connection_id': :'String',
    'executing_job_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_last_migration': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 372

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    database_combination == other.database_combination &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    type == other.type &&
    source_database_connection_id == other.source_database_connection_id &&
    target_database_connection_id == other.target_database_connection_id &&
    executing_job_id == other.executing_job_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_last_migration == other.time_last_migration &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 417

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


397
398
399
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 397

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



406
407
408
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 406

def hash
  [id, database_combination, display_name, compartment_id, type, source_database_connection_id, target_database_connection_id, executing_job_id, time_created, time_updated, time_last_migration, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



450
451
452
453
454
455
456
457
458
459
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 450

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



444
445
446
 
# File 'lib/oci/database_migration/models/migration_summary.rb', line 444

def to_s
  to_hash.to_s
end