Class: OCI::DisasterRecovery::Models::DrPlanUserDefinedStep

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

Overview

The details for a user-defined step in a DR plan. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

STEP_TYPE_ENUM = 
[
  STEP_TYPE_RUN_OBJECTSTORE_SCRIPT_PRECHECK = 'RUN_OBJECTSTORE_SCRIPT_PRECHECK'.freeze,
  STEP_TYPE_RUN_LOCAL_SCRIPT_PRECHECK = 'RUN_LOCAL_SCRIPT_PRECHECK'.freeze,
  STEP_TYPE_INVOKE_FUNCTION_PRECHECK = 'INVOKE_FUNCTION_PRECHECK'.freeze,
  STEP_TYPE_RUN_OBJECTSTORE_SCRIPT = 'RUN_OBJECTSTORE_SCRIPT'.freeze,
  STEP_TYPE_RUN_LOCAL_SCRIPT = 'RUN_LOCAL_SCRIPT'.freeze,
  STEP_TYPE_INVOKE_FUNCTION = 'INVOKE_FUNCTION'.freeze,
  STEP_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DrPlanUserDefinedStep

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :step_type (String) —

    The value to assign to the #step_type property



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 89

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

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

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

Instance Attribute Details

#step_type ⇒ String

[Required] The type of the user-defined step.

RUN_OBJECTSTORE_SCRIPT_PRECHECK - A step which performs a precheck on a script stored in OCI object storage.

RUN_LOCAL_SCRIPT_PRECHECK - A step which performs a precheck on a script which resides locally on a compute instance.

INVOKE_FUNCTION_PRECHECK - A step which performs a precheck on an OCI function. See docs.oracle.com/en-us/iaas/Content/Functions/home.htm.

RUN_OBJECTSTORE_SCRIPT - A step which runs a script stored in OCI object storage.

RUN_LOCAL_SCRIPT - A step which runs a script that resides locally on a compute instance.

INVOKE_FUNCTION - A step which invokes an OCI function. See docs.oracle.com/en-us/iaas/Content/Functions/home.htm.

Returns:

  • (String) 


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

def step_type
  @step_type
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'step_type': :'stepType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 67

def self.get_subtype(object_hash)
  type = object_hash[:'stepType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DisasterRecovery::Models::InvokeFunctionStep' if type == 'INVOKE_FUNCTION'
  return 'OCI::DisasterRecovery::Models::InvokeFunctionPrecheckStep' if type == 'INVOKE_FUNCTION_PRECHECK'
  return 'OCI::DisasterRecovery::Models::RunLocalScriptUserDefinedStep' if type == 'RUN_LOCAL_SCRIPT'
  return 'OCI::DisasterRecovery::Models::LocalScriptPrecheckStep' if type == 'RUN_LOCAL_SCRIPT_PRECHECK'
  return 'OCI::DisasterRecovery::Models::ObjectStoreScriptPrecheckStep' if type == 'RUN_OBJECTSTORE_SCRIPT_PRECHECK'
  return 'OCI::DisasterRecovery::Models::RunObjectStoreScriptUserDefinedStep' if type == 'RUN_OBJECTSTORE_SCRIPT'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DisasterRecovery::Models::DrPlanUserDefinedStep'
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'step_type': :'String'
    # 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



122
123
124
125
126
127
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 122

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

  self.class == other.class &&
    step_type == other.step_type
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 152

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


132
133
134
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 141

def hash
  [step_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 185

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



179
180
181
 
# File 'lib/oci/disaster_recovery/models/dr_plan_user_defined_step.rb', line 179

def to_s
  to_hash.to_s
end