Class: OCI::DisasterRecovery::Models::InvokeFunctionStep

Inherits:
DrPlanUserDefinedStep show all
Defined in:
lib/oci/disaster_recovery/models/invoke_function_step.rb

Overview

Invoke Oracle function step details.

Constant Summary

Constants inherited from DrPlanUserDefinedStep

DrPlanUserDefinedStep::STEP_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DrPlanUserDefinedStep

#step_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DrPlanUserDefinedStep

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ InvokeFunctionStep

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

  • :function_region (String) —

    The value to assign to the #function_region property

  • :request_body (String) —

    The value to assign to the #request_body property



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 67

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

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

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

  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_id ⇒ String

[Required] The OCID of function to be invoked.

Example: ocid1.fnfunc.oc1..uniqueID

Returns:

  • (String) 


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

def function_id
  @function_id
end

#function_region ⇒ String

[Required] The region in which the function is deployed.

Example: us-ashburn-1

Returns:

  • (String) 


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

def function_region
  @function_region
end

#request_body ⇒ String

The request body for the function.

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 32

def request_body
  @request_body
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 35

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

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 47

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



103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 103

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

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 136

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 125

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 169

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



163
164
165
 
# File 'lib/oci/disaster_recovery/models/invoke_function_step.rb', line 163

def to_s
  to_hash.to_s
end