Class: OCI::DisasterRecovery::Models::FailoverExecutionOptions

Inherits:
DrPlanExecutionOptions show all
Defined in:
lib/oci/disaster_recovery/models/failover_execution_options.rb

Overview

Options for failover execution.

Constant Summary

Constants inherited from DrPlanExecutionOptions

DrPlanExecutionOptions::PLAN_EXECUTION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DrPlanExecutionOptions

#plan_execution_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DrPlanExecutionOptions

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ FailoverExecutionOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 56

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['planExecutionType'] = 'FAILOVER'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.are_prechecks_enabled = attributes[:'arePrechecksEnabled'] unless attributes[:'arePrechecksEnabled'].nil?
  self.are_prechecks_enabled = false if are_prechecks_enabled.nil? && !attributes.key?(:'arePrechecksEnabled') # rubocop:disable Style/StringLiterals

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

  self.are_prechecks_enabled = attributes[:'are_prechecks_enabled'] unless attributes[:'are_prechecks_enabled'].nil?
  self.are_prechecks_enabled = false if are_prechecks_enabled.nil? && !attributes.key?(:'arePrechecksEnabled') && !attributes.key?(:'are_prechecks_enabled') # rubocop:disable Style/StringLiterals

  self.are_warnings_ignored = attributes[:'areWarningsIgnored'] unless attributes[:'areWarningsIgnored'].nil?
  self.are_warnings_ignored = true if are_warnings_ignored.nil? && !attributes.key?(:'areWarningsIgnored') # rubocop:disable Style/StringLiterals

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

  self.are_warnings_ignored = attributes[:'are_warnings_ignored'] unless attributes[:'are_warnings_ignored'].nil?
  self.are_warnings_ignored = true if are_warnings_ignored.nil? && !attributes.key?(:'areWarningsIgnored') && !attributes.key?(:'are_warnings_ignored') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#are_prechecks_enabled ⇒ BOOLEAN

A flag indicating whether prechecks should be executed before the plan execution.

Example: true

Returns:

  • (BOOLEAN) 


17
18
19
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 17

def are_prechecks_enabled
  @are_prechecks_enabled
end

#are_warnings_ignored ⇒ BOOLEAN

A flag indicating whether warnings should be ignored during the plan execution.

Example: false

Returns:

  • (BOOLEAN) 


24
25
26
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 24

def are_warnings_ignored
  @are_warnings_ignored
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'plan_execution_type': :'planExecutionType',
    'are_prechecks_enabled': :'arePrechecksEnabled',
    'are_warnings_ignored': :'areWarningsIgnored'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'plan_execution_type': :'String',
    'are_prechecks_enabled': :'BOOLEAN',
    'are_warnings_ignored': :'BOOLEAN'
    # 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



90
91
92
93
94
95
96
97
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 90

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

  self.class == other.class &&
    plan_execution_type == other.plan_execution_type &&
    are_prechecks_enabled == other.are_prechecks_enabled &&
    are_warnings_ignored == other.are_warnings_ignored
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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 122

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



111
112
113
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 111

def hash
  [plan_execution_type, are_prechecks_enabled, are_warnings_ignored].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 155

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



149
150
151
 
# File 'lib/oci/disaster_recovery/models/failover_execution_options.rb', line 149

def to_s
  to_hash.to_s
end