Class: OCI::CloudMigrations::Models::Migration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_migrations/models/migration.rb

Overview

A top-level container to track all aspects of a long-running migration workflow to OCI.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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
MIGRATION_TYPE_ENUM = 
[
  MIGRATION_TYPE_OCI = 'OCI'.freeze,
  MIGRATION_TYPE_OLVM = 'OLVM'.freeze,
  MIGRATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Migration

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id 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

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :replication_schedule_id (String) —

    The value to assign to the #replication_schedule_id property

  • :is_completed (BOOLEAN) —

    The value to assign to the #is_completed property

  • :migration_type (String) —

    The value to assign to the #migration_type property

  • :migration_config (OCI::CloudMigrations::Models::MigrationConfig) —

    The value to assign to the #migration_config 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

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

    The value to assign to the #security_attributes property



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 165

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.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.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.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.replication_schedule_id = attributes[:'replicationScheduleId'] if attributes[:'replicationScheduleId']

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

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

  self.is_completed = attributes[:'isCompleted'] unless attributes[:'isCompleted'].nil?

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

  self.is_completed = attributes[:'is_completed'] unless attributes[:'is_completed'].nil?

  self.migration_type = attributes[:'migrationType'] if attributes[:'migrationType']
  self.migration_type = "OCI" if migration_type.nil? && !attributes.key?(:'migrationType') # rubocop:disable Style/StringLiterals

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

  self.migration_type = attributes[:'migration_type'] if attributes[:'migration_type']
  self.migration_type = "OCI" if migration_type.nil? && !attributes.key?(:'migrationType') && !attributes.key?(:'migration_type') # rubocop:disable Style/StringLiterals

  self.migration_config = attributes[:'migrationConfig'] if attributes[:'migrationConfig']

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

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

  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']

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment Identifier

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 39

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


82
83
84
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 82

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Migration Identifier that can be renamed

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 35

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


76
77
78
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 76

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 31

def id
  @id
end

#is_completed ⇒ BOOLEAN

Indicates whether migration is marked as completed.

Returns:

  • (BOOLEAN) 


63
64
65
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 63

def is_completed
  @is_completed
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 47

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of migration.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 43

def lifecycle_state
  @lifecycle_state
end

#migration_config ⇒ OCI::CloudMigrations::Models::MigrationConfig

Returns:



70
71
72
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 70

def migration_config
  @migration_config
end

#migration_type ⇒ String

Type of migration project (OCI/OLVM). This determines the target environment for the migration.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 67

def migration_type
  @migration_type
end

#replication_schedule_id ⇒ String

Replication schedule identifier

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 59

def replication_schedule_id
  @replication_schedule_id
end

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

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


96
97
98
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 96

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


88
89
90
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 88

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time when the migration project was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 51

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time when the migration project was updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 55

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 99

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'replication_schedule_id': :'replicationScheduleId',
    'is_completed': :'isCompleted',
    'migration_type': :'migrationType',
    'migration_config': :'migrationConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'replication_schedule_id': :'String',
    'is_completed': :'BOOLEAN',
    'migration_type': :'String',
    'migration_config': :'OCI::CloudMigrations::Models::MigrationConfig',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 293

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    replication_schedule_id == other.replication_schedule_id &&
    is_completed == other.is_completed &&
    migration_type == other.migration_type &&
    migration_config == other.migration_config &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    security_attributes == other.security_attributes
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 337

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


317
318
319
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 317

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



326
327
328
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 326

def hash
  [id, display_name, compartment_id, lifecycle_state, lifecycle_details, time_created, time_updated, replication_schedule_id, is_completed, migration_type, migration_config, freeform_tags, defined_tags, system_tags, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



370
371
372
373
374
375
376
377
378
379
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 370

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



364
365
366
 
# File 'lib/oci/cloud_migrations/models/migration.rb', line 364

def to_s
  to_hash.to_s
end