Class: OCI::DisasterRecovery::Models::DrPlan

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/disaster_recovery/models/dr_plan.rb

Overview

The details of a DR plan.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_SWITCHOVER = 'SWITCHOVER'.freeze,
  TYPE_FAILOVER = 'FAILOVER'.freeze,
  TYPE_START_DRILL = 'START_DRILL'.freeze,
  TYPE_STOP_DRILL = 'STOP_DRILL'.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_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_SUB_STATE_ENUM = 
[
  LIFECYCLE_SUB_STATE_NEEDS_REFRESH = 'NEEDS_REFRESH'.freeze,
  LIFECYCLE_SUB_STATE_NEEDS_VERIFICATION = 'NEEDS_VERIFICATION'.freeze,
  LIFECYCLE_SUB_STATE_REFRESHING = 'REFRESHING'.freeze,
  LIFECYCLE_SUB_STATE_VERIFYING = 'VERIFYING'.freeze,
  LIFECYCLE_SUB_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DrPlan

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

  • :type (String) —

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

  • :dr_protection_group_id (String) —

    The value to assign to the #dr_protection_group_id property

  • :peer_dr_protection_group_id (String) —

    The value to assign to the #peer_dr_protection_group_id property

  • :peer_region (String) —

    The value to assign to the #peer_region property

  • :source_plan_id (String) —

    The value to assign to the #source_plan_id property

  • :plan_groups (Array<OCI::DisasterRecovery::Models::DrPlanGroup>) —

    The value to assign to the #plan_groups property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_sub_state (String) —

    The value to assign to the #lifecycle_sub_state property

  • :life_cycle_details (String) —

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



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
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 225

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

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

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

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

  self.peer_dr_protection_group_id = attributes[:'peerDrProtectionGroupId'] if attributes[:'peerDrProtectionGroupId']

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

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

  self.peer_region = attributes[:'peerRegion'] if attributes[:'peerRegion']

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

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

  self.source_plan_id = attributes[:'sourcePlanId'] if attributes[:'sourcePlanId']

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

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

  self.plan_groups = attributes[:'planGroups'] if attributes[:'planGroups']

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

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

  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_sub_state = attributes[:'lifecycleSubState'] if attributes[:'lifecycleSubState']

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

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

  self.life_cycle_details = attributes[:'lifeCycleDetails'] if attributes[:'lifeCycleDetails']

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

  self.life_cycle_details = attributes[:'life_cycle_details'] if attributes[:'life_cycle_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 compartment containing the DR plan.

Example: ocid1.compartment.oc1..uniqueID

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 59

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: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


143
144
145
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 143

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The display name of the DR plan.

Example: EBS Switchover PHX to IAD

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 52

def display_name
  @display_name
end

#dr_protection_group_id ⇒ String

[Required] The OCID of the DR protection group to which this DR plan belongs.

Example: ocid1.drplan.oc1..uniqueID

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 85

def dr_protection_group_id
  @dr_protection_group_id
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


136
137
138
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 136

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the DR plan.

Example: ocid1.drplan.oc1..uniqueID

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 45

def id
  @id
end

#life_cycle_details ⇒ String

A message describing the DR plan's current state in more detail.

Returns:

  • (String) 


129
130
131
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 129

def life_cycle_details
  @life_cycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the DR plan.

Returns:

  • (String) 


119
120
121
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 119

def lifecycle_state
  @lifecycle_state
end

#lifecycle_sub_state ⇒ String

The current state of the DR plan.

Returns:

  • (String) 


124
125
126
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 124

def lifecycle_sub_state
  @lifecycle_sub_state
end

#peer_dr_protection_group_id ⇒ String

[Required] The OCID of the peer DR protection group associated with this plan's DR protection group.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 93

def peer_dr_protection_group_id
  @peer_dr_protection_group_id
end

#peer_region ⇒ String

[Required] The region of the peer DR protection group associated with this plan's DR protection group.

Example: us-ashburn-1

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 101

def peer_region
  @peer_region
end

#plan_groups ⇒ Array<OCI::DisasterRecovery::Models::DrPlanGroup>

[Required] The list of groups in this DR plan.

Returns:



114
115
116
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 114

def plan_groups
  @plan_groups
end

#source_plan_id ⇒ String

If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan. If this DR plan was not cloned, then the value for this will be null.

Example: ocid1.drplan.oc1..uniqueID

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 109

def source_plan_id
  @source_plan_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>>) 


150
151
152
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 150

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the DR plan was created. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 71

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the DR plan was updated. An RFC3339 formatted datetime string.

Example: 2019-03-29T09:36:42Z

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 78

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of the DR plan.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 64

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 153

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'dr_protection_group_id': :'drProtectionGroupId',
    'peer_dr_protection_group_id': :'peerDrProtectionGroupId',
    'peer_region': :'peerRegion',
    'source_plan_id': :'sourcePlanId',
    'plan_groups': :'planGroups',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_sub_state': :'lifecycleSubState',
    'life_cycle_details': :'lifeCycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 178

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'dr_protection_group_id': :'String',
    'peer_dr_protection_group_id': :'String',
    'peer_region': :'String',
    'source_plan_id': :'String',
    'plan_groups': :'Array<OCI::DisasterRecovery::Models::DrPlanGroup>',
    'lifecycle_state': :'String',
    'lifecycle_sub_state': :'String',
    'life_cycle_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
393
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 372

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    type == other.type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    dr_protection_group_id == other.dr_protection_group_id &&
    peer_dr_protection_group_id == other.peer_dr_protection_group_id &&
    peer_region == other.peer_region &&
    source_plan_id == other.source_plan_id &&
    plan_groups == other.plan_groups &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_sub_state == other.lifecycle_sub_state &&
    life_cycle_details == other.life_cycle_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



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

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


398
399
400
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 398

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



407
408
409
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 407

def hash
  [id, display_name, compartment_id, type, time_created, time_updated, dr_protection_group_id, peer_dr_protection_group_id, peer_region, source_plan_id, plan_groups, lifecycle_state, lifecycle_sub_state, life_cycle_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



451
452
453
454
455
456
457
458
459
460
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 451

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



445
446
447
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 445

def to_s
  to_hash.to_s
end