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

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

  • :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

  • :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



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
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
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 198

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


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

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


122
123
124
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 122

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) 


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

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) 


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

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the DR plan.

Example: ocid1.drplan.oc1..uniqueID

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 37

def id
  @id
end

#life_cycle_details ⇒ String

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

Returns:

  • (String) 


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

def life_cycle_details
  @life_cycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the DR plan.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 103

def lifecycle_state
  @lifecycle_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) 


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

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) 


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

def peer_region
  @peer_region
end

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

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

Returns:



98
99
100
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 98

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


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

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) 


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

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) 


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

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of the DR plan.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 56

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'plan_groups': :'planGroups',
    'lifecycle_state': :'lifecycleState',
    'life_cycle_details': :'lifeCycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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 155

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',
    'plan_groups': :'Array<OCI::DisasterRecovery::Models::DrPlanGroup>',
    'lifecycle_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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 320

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 &&
    plan_groups == other.plan_groups &&
    lifecycle_state == other.lifecycle_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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 364

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


344
345
346
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 344

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



353
354
355
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 353

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



397
398
399
400
401
402
403
404
405
406
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 397

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



391
392
393
 
# File 'lib/oci/disaster_recovery/models/dr_plan.rb', line 391

def to_s
  to_hash.to_s
end