Class: OCI::CloudMigrations::Models::MigrationPlanSummary

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

Overview

Summary of the migration plan.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MigrationPlanSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



157
158
159
160
161
162
163
164
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
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 157

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

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

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

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

  self.migration_plan_stats = attributes[:'migrationPlanStats'] if attributes[:'migrationPlanStats']

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

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

  self.calculated_limits = attributes[:'calculatedLimits'] if attributes[:'calculatedLimits']

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

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

  self.target_environments = attributes[:'targetEnvironments'] if attributes[:'targetEnvironments']

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

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

  self.reference_to_rms_stack = attributes[:'referenceToRmsStack'] if attributes[:'referenceToRmsStack']

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

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

  self.source_migration_plan_id = attributes[:'sourceMigrationPlanId'] if attributes[:'sourceMigrationPlanId']

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

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

  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

#calculated_limits ⇒ Hash<String, Integer>

[Required] Limits of the resources that are needed for migration. Example: 2, "VCN": 1

Returns:

  • (Hash<String, Integer>) 


52
53
54
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 52

def calculated_limits
  @calculated_limits
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the migration plan.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 17

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 21

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The unique Oracle ID (OCID) that is immutable on creation.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 13

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


37
38
39
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 37

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the migration plan.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 33

def lifecycle_state
  @lifecycle_state
end

#migration_id ⇒ String

[Required] The OCID of the associated migration.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 41

def migration_id
  @migration_id
end

#migration_plan_stats ⇒ OCI::CloudMigrations::Models::MigrationPlanStats

Returns:



48
49
50
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 48

def migration_plan_stats
  @migration_plan_stats
end

#reference_to_rms_stack ⇒ String

OCID of the referenced ORM job.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 60

def reference_to_rms_stack
  @reference_to_rms_stack
end

#source_migration_plan_id ⇒ String

Source migraiton plan ID to be cloned.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 64

def source_migration_plan_id
  @source_migration_plan_id
end

#strategies ⇒ Array<OCI::CloudMigrations::Models::ResourceAssessmentStrategy>

[Required] List of strategies for the resources to be migrated.

Returns:



45
46
47
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 45

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


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

def system_tags
  @system_tags
end

#target_environments ⇒ Array<OCI::CloudMigrations::Models::TargetEnvironment>

[Required] List of target environments.

Returns:



56
57
58
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 56

def target_environments
  @target_environments
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


25
26
27
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 25

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


29
30
31
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 29

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 85

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'migration_id': :'migrationId',
    'strategies': :'strategies',
    'migration_plan_stats': :'migrationPlanStats',
    'calculated_limits': :'calculatedLimits',
    'target_environments': :'targetEnvironments',
    'reference_to_rms_stack': :'referenceToRmsStack',
    'source_migration_plan_id': :'sourceMigrationPlanId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'migration_id': :'String',
    'strategies': :'Array<OCI::CloudMigrations::Models::ResourceAssessmentStrategy>',
    'migration_plan_stats': :'OCI::CloudMigrations::Models::MigrationPlanStats',
    'calculated_limits': :'Hash<String, Integer>',
    'target_environments': :'Array<OCI::CloudMigrations::Models::TargetEnvironment>',
    'reference_to_rms_stack': :'String',
    'source_migration_plan_id': :'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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 265

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    migration_id == other.migration_id &&
    strategies == other.strategies &&
    migration_plan_stats == other.migration_plan_stats &&
    calculated_limits == other.calculated_limits &&
    target_environments == other.target_environments &&
    reference_to_rms_stack == other.reference_to_rms_stack &&
    source_migration_plan_id == other.source_migration_plan_id &&
    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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 311

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


291
292
293
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 291

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 300

def hash
  [id, compartment_id, display_name, time_created, time_updated, lifecycle_state, lifecycle_details, migration_id, strategies, migration_plan_stats, calculated_limits, target_environments, reference_to_rms_stack, source_migration_plan_id, 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



344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 344

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



338
339
340
 
# File 'lib/oci/cloud_migrations/models/migration_plan_summary.rb', line 338

def to_s
  to_hash.to_s
end