Class: OCI::DisasterRecovery::Models::DrPlanSummary
- Inherits:
-
Object
- Object
- OCI::DisasterRecovery::Models::DrPlanSummary
- Defined in:
- lib/oci/disaster_recovery/models/dr_plan_summary.rb
Overview
The summary 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
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the DR plan.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] The display name of the DR plan.
-
#dr_protection_group_id ⇒ String
[Required] The OCID of the DR protection group to which this DR plan belongs.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the DR plan.
-
#life_cycle_details ⇒ String
A message describing the DR plan's current state in more detail.
-
#lifecycle_state ⇒ String
[Required] The current state of the DR plan.
-
#peer_dr_protection_group_id ⇒ String
[Required] The OCID of the peer DR protection group associated with this plan's DR protection group.
-
#peer_region ⇒ String
[Required] The region of the peer DR protection group associated with this plan's DR protection group.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
[Required] The date and time the DR plan was created.
-
#time_updated ⇒ DateTime
[Required] The date and time the DR plan was updated.
-
#type ⇒ String
[Required] The type of the DR plan.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DrPlanSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ DrPlanSummary
Initializes the object
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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 194 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.type = attributes[:'type'] if attributes[:'type'] 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = 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
44 45 46 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 44 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\"}}
121 122 123 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 121 def @defined_tags end |
#display_name ⇒ String
[Required] The display name of the DR plan.
Example: EBS Switchover PHX to IAD
51 52 53 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 51 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.drprotectiongroup.oc1..uniqueID
65 66 67 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 65 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\"}
114 115 116 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 114 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the DR plan.
Example: ocid1.drplan.oc1..uniqueID
37 38 39 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 37 def id @id end |
#life_cycle_details ⇒ String
A message describing the DR plan's current state in more detail.
107 108 109 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 107 def life_cycle_details @life_cycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the DR plan.
Example: ACTIVE
102 103 104 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 102 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
73 74 75 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 73 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
81 82 83 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 81 def peer_region @peer_region 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\"}}
128 129 130 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 128 def @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
88 89 90 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 88 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
95 96 97 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 95 def time_updated @time_updated end |
#type ⇒ String
[Required] The type of the DR plan.
Example: SWITCHOVER
58 59 60 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 58 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 131 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'type': :'type', 'dr_protection_group_id': :'drProtectionGroupId', 'peer_dr_protection_group_id': :'peerDrProtectionGroupId', 'peer_region': :'peerRegion', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', '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.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 153 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'display_name': :'String', 'type': :'String', 'dr_protection_group_id': :'String', 'peer_dr_protection_group_id': :'String', 'peer_region': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', '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.
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 310 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && display_name == other.display_name && type == other.type && 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 && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && life_cycle_details == other.life_cycle_details && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 353 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
333 334 335 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 333 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
342 343 344 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 342 def hash [id, compartment_id, display_name, type, dr_protection_group_id, peer_dr_protection_group_id, peer_region, time_created, time_updated, lifecycle_state, life_cycle_details, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
386 387 388 389 390 391 392 393 394 395 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 386 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
380 381 382 |
# File 'lib/oci/disaster_recovery/models/dr_plan_summary.rb', line 380 def to_s to_hash.to_s end |