Class: OCI::DisasterRecovery::Models::UpdateDrPlanStepDetails

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

Overview

The details for updating a DR plan step.

Constant Summary collapse

ERROR_MODE_ENUM = 
[
  ERROR_MODE_STOP_ON_ERROR = 'STOP_ON_ERROR'.freeze,
  ERROR_MODE_CONTINUE_ON_ERROR = 'CONTINUE_ON_ERROR'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDrPlanStepDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 95

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

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

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?

  self.user_defined_step = attributes[:'userDefinedStep'] if attributes[:'userDefinedStep']

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

  self.user_defined_step = attributes[:'user_defined_step'] if attributes[:'user_defined_step']
end

Instance Attribute Details

#display_name ⇒ String

The display name of the step in a group.

Example: My_STEP_3A - EBS Start - STAGE A

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 28

def display_name
  @display_name
end

#error_mode ⇒ String

The error mode for this step. The default error mode for the step is STOP_ON_ERROR.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 34

def error_mode
  @error_mode
end

#id ⇒ String

The unique id of the step.

Example: sgid1.step..uniqueID

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 21

def id
  @id
end

#is_enabled ⇒ BOOLEAN

A flag indicating whether this step should be enabled for execution. The default value for the isEnabled flag is true.

Example: true

Returns:

  • (BOOLEAN) 


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

def is_enabled
  @is_enabled
end

#timeout ⇒ Integer

The timeout in seconds for executing this step. When creating a new step, if no timeout is specified, the default timeout is set to 3600 seconds.

Example: 600

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 42

def timeout
  @timeout
end

#user_defined_step ⇒ OCI::DisasterRecovery::Models::UpdateDrPlanUserDefinedStepDetails

Returns:



53
54
55
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 53

def user_defined_step
  @user_defined_step
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 56

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'error_mode': :'errorMode',
    'timeout': :'timeout',
    'is_enabled': :'isEnabled',
    'user_defined_step': :'userDefinedStep'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'error_mode': :'String',
    'timeout': :'Integer',
    'is_enabled': :'BOOLEAN',
    'user_defined_step': :'OCI::DisasterRecovery::Models::UpdateDrPlanUserDefinedStepDetails'
    # 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



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 145

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    error_mode == other.error_mode &&
    timeout == other.timeout &&
    is_enabled == other.is_enabled &&
    user_defined_step == other.user_defined_step
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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 180

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



169
170
171
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 169

def hash
  [id, display_name, error_mode, timeout, is_enabled, user_defined_step].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 213

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



207
208
209
 
# File 'lib/oci/disaster_recovery/models/update_dr_plan_step_details.rb', line 207

def to_s
  to_hash.to_s
end