Class: OCI::DisasterRecovery::Models::DrProtectionGroup

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

Overview

The details of a DR protection group.

Constant Summary collapse

ROLE_ENUM = 
[
  ROLE_PRIMARY = 'PRIMARY'.freeze,
  ROLE_STANDBY = 'STANDBY'.freeze,
  ROLE_UNCONFIGURED = 'UNCONFIGURED'.freeze,
  ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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_SUB_STATE_ENUM = 
[
  LIFECYCLE_SUB_STATE_DR_DRILL_IN_PROGRESS = 'DR_DRILL_IN_PROGRESS'.freeze,
  LIFECYCLE_SUB_STATE_DR_PLAN_EXECUTION_IN_PROGRESS = 'DR_PLAN_EXECUTION_IN_PROGRESS'.freeze,
  LIFECYCLE_SUB_STATE_AUTOMATIC_DR_PLAN_EXECUTION_IN_PROGRESS = 'AUTOMATIC_DR_PLAN_EXECUTION_IN_PROGRESS'.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 = {}) ⇒ DrProtectionGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 206

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

  self.peer_id = attributes[:'peerId'] if attributes[:'peerId']

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

  self.peer_id = attributes[:'peer_id'] if attributes[:'peer_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.log_location = attributes[:'logLocation'] if attributes[:'logLocation']

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

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

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

  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.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.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.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 protection group.

Example: ocid1.compartment.oc1..uniqueID

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 50

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


127
128
129
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 127

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The display name of the DR protection group.

Example: EBS PHX Group

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 57

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. Exists for cross-compatibility only.

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

Returns:

  • (Hash<String, String>) 


120
121
122
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 120

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the DR protection group.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 43

def id
  @id
end

#life_cycle_details ⇒ String

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

Returns:

  • (String) 


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

def life_cycle_details
  @life_cycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the DR protection group.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#lifecycle_sub_state ⇒ String

The current sub-state of the DR protection group.

Returns:

  • (String) 


113
114
115
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 113

def lifecycle_sub_state
  @lifecycle_sub_state
end

#log_location ⇒ OCI::DisasterRecovery::Models::ObjectStorageLogLocation

Returns:



79
80
81
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 79

def log_location
  @log_location
end

#members ⇒ Array<OCI::DisasterRecovery::Models::DrProtectionGroupMember>

A list of DR protection group members.

Returns:



84
85
86
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 84

def members
  @members
end

#peer_id ⇒ String

The OCID of the peer DR protection group.

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 69

def peer_id
  @peer_id
end

#peer_region ⇒ String

The region of the peer DR protection group.

Example: us-ashburn-1

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 76

def peer_region
  @peer_region
end

#role ⇒ String

[Required] The role of the DR protection group.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 62

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


134
135
136
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 134

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 91

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 137

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'role': :'role',
    'peer_id': :'peerId',
    'peer_region': :'peerRegion',
    'log_location': :'logLocation',
    'members': :'members',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'life_cycle_details': :'lifeCycleDetails',
    'lifecycle_sub_state': :'lifecycleSubState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 161

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'role': :'String',
    'peer_id': :'String',
    'peer_region': :'String',
    'log_location': :'OCI::DisasterRecovery::Models::ObjectStorageLogLocation',
    'members': :'Array<OCI::DisasterRecovery::Models::DrProtectionGroupMember>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'life_cycle_details': :'String',
    'lifecycle_sub_state': :'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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 343

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    role == other.role &&
    peer_id == other.peer_id &&
    peer_region == other.peer_region &&
    log_location == other.log_location &&
    members == other.members &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    life_cycle_details == other.life_cycle_details &&
    lifecycle_sub_state == other.lifecycle_sub_state &&
    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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 388

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


368
369
370
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 368

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



377
378
379
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 377

def hash
  [id, compartment_id, display_name, role, peer_id, peer_region, log_location, members, time_created, time_updated, lifecycle_state, life_cycle_details, lifecycle_sub_state, 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



421
422
423
424
425
426
427
428
429
430
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 421

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



415
416
417
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group.rb', line 415

def to_s
  to_hash.to_s
end