Class: OCI::DisasterRecovery::Models::UpdateInvokeFunctionUserDefinedStepDetails

Inherits:
UpdateDrPlanUserDefinedStepDetails show all
Defined in:
lib/oci/disaster_recovery/models/update_invoke_function_user_defined_step_details.rb

Overview

The details for updating an Invoke Oracle Function step.

Constant Summary

Constants inherited from UpdateDrPlanUserDefinedStepDetails

OCI::DisasterRecovery::Models::UpdateDrPlanUserDefinedStepDetails::STEP_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateDrPlanUserDefinedStepDetails

#step_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateDrPlanUserDefinedStepDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateInvokeFunctionUserDefinedStepDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :function_id (String)

    The value to assign to the #function_id property

  • :request_body (String)

    The value to assign to the #request_body property



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

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

  attributes['stepType'] = 'INVOKE_FUNCTION'

  super(attributes)

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

  self.function_id = attributes[:'functionId'] if attributes[:'functionId']

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

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

  self.request_body = attributes[:'requestBody'] if attributes[:'requestBody']

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

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

Instance Attribute Details

#function_idString

[Required] The OCID of function to be invoked.

Example: ocid1.fnfunc.oc1..uniqueID

Returns:

  • (String)


18
19
20
# File 'lib/oci/disaster_recovery/models/update_invoke_function_user_defined_step_details.rb', line 18

def function_id
  @function_id
end

#request_bodyString

The request body for the function.

Example: { \"FnParam1\", \"FnParam2\" }

Returns:

  • (String)


25
26
27
# File 'lib/oci/disaster_recovery/models/update_invoke_function_user_defined_step_details.rb', line 25

def request_body
  @request_body
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'step_type': :'stepType',
    'function_id': :'functionId',
    'request_body': :'requestBody'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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



87
88
89
90
91
92
93
94
# File 'lib/oci/disaster_recovery/models/update_invoke_function_user_defined_step_details.rb', line 87

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

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



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

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


99
100
101
# File 'lib/oci/disaster_recovery/models/update_invoke_function_user_defined_step_details.rb', line 99

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



108
109
110
# File 'lib/oci/disaster_recovery/models/update_invoke_function_user_defined_step_details.rb', line 108

def hash
  [step_type, function_id, request_body].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
# File 'lib/oci/disaster_recovery/models/update_invoke_function_user_defined_step_details.rb', line 152

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



146
147
148
# File 'lib/oci/disaster_recovery/models/update_invoke_function_user_defined_step_details.rb', line 146

def to_s
  to_hash.to_s
end