Class: OCI::DisasterRecovery::Models::DrPlanExecution

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

Overview

The details of a DR plan execution.

Constant Summary collapse

PLAN_EXECUTION_TYPE_ENUM = 
[
  PLAN_EXECUTION_TYPE_SWITCHOVER = 'SWITCHOVER'.freeze,
  PLAN_EXECUTION_TYPE_SWITCHOVER_PRECHECK = 'SWITCHOVER_PRECHECK'.freeze,
  PLAN_EXECUTION_TYPE_FAILOVER = 'FAILOVER'.freeze,
  PLAN_EXECUTION_TYPE_FAILOVER_PRECHECK = 'FAILOVER_PRECHECK'.freeze,
  PLAN_EXECUTION_TYPE_START_DRILL = 'START_DRILL'.freeze,
  PLAN_EXECUTION_TYPE_START_DRILL_PRECHECK = 'START_DRILL_PRECHECK'.freeze,
  PLAN_EXECUTION_TYPE_STOP_DRILL = 'STOP_DRILL'.freeze,
  PLAN_EXECUTION_TYPE_STOP_DRILL_PRECHECK = 'STOP_DRILL_PRECHECK'.freeze,
  PLAN_EXECUTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_PAUSING = 'PAUSING'.freeze,
  LIFECYCLE_STATE_PAUSED = 'PAUSED'.freeze,
  LIFECYCLE_STATE_RESUMING = 'RESUMING'.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 = {}) ⇒ DrPlanExecution

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 261

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

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

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

  self.plan_execution_type = attributes[:'planExecutionType'] if attributes[:'planExecutionType']

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

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

  self.execution_options = attributes[:'executionOptions'] if attributes[:'executionOptions']

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

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

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

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

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

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

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

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

  self.execution_duration_in_sec = attributes[:'executionDurationInSec'] if attributes[:'executionDurationInSec']

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

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

  self.group_executions = attributes[:'groupExecutions'] if attributes[:'groupExecutions']

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

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

  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 this DR plan execution.

Example: ocid1.compartment.oc1..uniqueID

Returns:

  • (String) 


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

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


167
168
169
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 167

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The display name of the DR plan execution.

Example: Execution - EBS Switchover PHX to IAD

Returns:

  • (String) 


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

def display_name
  @display_name
end

#dr_protection_group_id ⇒ String

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

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 82

def dr_protection_group_id
  @dr_protection_group_id
end

#execution_duration_in_sec ⇒ Integer

The total duration in seconds taken to complete the DR plan execution.

Example: 750

Returns:

  • (Integer) 


138
139
140
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 138

def execution_duration_in_sec
  @execution_duration_in_sec
end

#execution_options ⇒ OCI::DisasterRecovery::Models::DrPlanExecutionOptions

This attribute is required.

Returns:



75
76
77
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 75

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


160
161
162
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 160

def freeform_tags
  @freeform_tags
end

#group_executions ⇒ Array<OCI::DisasterRecovery::Models::DrPlanGroupExecution>

[Required] A list of groups executed in this DR plan execution.

Returns:



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

def group_executions
  @group_executions
end

#id ⇒ String

[Required] The OCID of the DR plan execution.

Example: ocid1.drplanexecution.oc1..uniqueID

Returns:

  • (String) 


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

def id
  @id
end

#life_cycle_details ⇒ String

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

Returns:

  • (String) 


153
154
155
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 153

def life_cycle_details
  @life_cycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the DR plan execution.

Returns:

  • (String) 


148
149
150
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 148

def lifecycle_state
  @lifecycle_state
end

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

This attribute is required.

Returns:



102
103
104
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 102

def log_location
  @log_location
end

#peer_dr_protection_group_id ⇒ String

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

Example: ocid1.drprotectiongroup.oc1..uniqueID

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 90

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) 


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

def peer_region
  @peer_region
end

#plan_execution_type ⇒ String

[Required] The type of the DR plan executed.

Returns:

  • (String) 


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

def plan_execution_type
  @plan_execution_type
end

#plan_id ⇒ String

[Required] The OCID of the DR plan.

Example: ocid1.drplan.oc1..uniqueID

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 66

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


174
175
176
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 174

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_ended ⇒ DateTime

The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string.

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

Returns:

  • (DateTime) 


131
132
133
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 131

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

The date and time at which DR plan execution began. An RFC3339 formatted datetime string.

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

Returns:

  • (DateTime) 


116
117
118
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 116

def time_started
  @time_started
end

#time_updated ⇒ DateTime

[Required] The time when DR plan execution was last updated. An RFC3339 formatted datetime string.

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

Returns:

  • (DateTime) 


123
124
125
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 123

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'plan_id': :'planId',
    'plan_execution_type': :'planExecutionType',
    'execution_options': :'executionOptions',
    'dr_protection_group_id': :'drProtectionGroupId',
    'peer_dr_protection_group_id': :'peerDrProtectionGroupId',
    'peer_region': :'peerRegion',
    'log_location': :'logLocation',
    'time_created': :'timeCreated',
    'time_started': :'timeStarted',
    'time_updated': :'timeUpdated',
    'time_ended': :'timeEnded',
    'execution_duration_in_sec': :'executionDurationInSec',
    'group_executions': :'groupExecutions',
    '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.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'plan_id': :'String',
    'plan_execution_type': :'String',
    'execution_options': :'OCI::DisasterRecovery::Models::DrPlanExecutionOptions',
    'dr_protection_group_id': :'String',
    'peer_dr_protection_group_id': :'String',
    'peer_region': :'String',
    'log_location': :'OCI::DisasterRecovery::Models::ObjectStorageLogLocation',
    'time_created': :'DateTime',
    'time_started': :'DateTime',
    'time_updated': :'DateTime',
    'time_ended': :'DateTime',
    'execution_duration_in_sec': :'Integer',
    'group_executions': :'Array<OCI::DisasterRecovery::Models::DrPlanGroupExecution>',
    '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



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 423

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    plan_id == other.plan_id &&
    plan_execution_type == other.plan_execution_type &&
    execution_options == other.execution_options &&
    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 &&
    log_location == other.log_location &&
    time_created == other.time_created &&
    time_started == other.time_started &&
    time_updated == other.time_updated &&
    time_ended == other.time_ended &&
    execution_duration_in_sec == other.execution_duration_in_sec &&
    group_executions == other.group_executions &&
    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



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 473

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


453
454
455
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 453

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



462
463
464
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 462

def hash
  [id, compartment_id, display_name, plan_id, plan_execution_type, execution_options, dr_protection_group_id, peer_dr_protection_group_id, peer_region, log_location, time_created, time_started, time_updated, time_ended, execution_duration_in_sec, group_executions, 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



506
507
508
509
510
511
512
513
514
515
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 506

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



500
501
502
 
# File 'lib/oci/disaster_recovery/models/dr_plan_execution.rb', line 500

def to_s
  to_hash.to_s
end