Class: OCI::GenerativeAiAgentRuntime::Models::RequiredAction

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent_runtime/models/required_action.rb

Overview

Represents an action that needs to be performed by the user or client.

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

Direct Known Subclasses

FunctionCallingRequiredAction

Constant Summary collapse

REQUIRED_ACTION_TYPE_ENUM = 
[
  REQUIRED_ACTION_TYPE_HUMAN_APPROVAL_REQUIRED_ACTION = 'HUMAN_APPROVAL_REQUIRED_ACTION'.freeze,
  REQUIRED_ACTION_TYPE_FUNCTION_CALLING_REQUIRED_ACTION = 'FUNCTION_CALLING_REQUIRED_ACTION'.freeze,
  REQUIRED_ACTION_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 = {}) ⇒ RequiredAction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :action_id (String) —

    The value to assign to the #action_id property

  • :required_action_type (String) —

    The value to assign to the #required_action_type property



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 71

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

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

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

  self.required_action_type = attributes[:'requiredActionType'] if attributes[:'requiredActionType']

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

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

Instance Attribute Details

#action_id ⇒ String

[Required] The unique identifier for the action to be performed.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 22

def action_id
  @action_id
end

#required_action_type ⇒ String

[Required] Specifies the type of action. Used for determining the action subtype.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 26

def required_action_type
  @required_action_type
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'action_id': :'actionId',
    'required_action_type': :'requiredActionType'
    # 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.



53
54
55
56
57
58
59
60
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 53

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

  return 'OCI::GenerativeAiAgentRuntime::Models::FunctionCallingRequiredAction' if type == 'FUNCTION_CALLING_REQUIRED_ACTION'

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

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 39

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



110
111
112
113
114
115
116
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 110

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

  self.class == other.class &&
    action_id == other.action_id &&
    required_action_type == other.required_action_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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 141

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


121
122
123
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 121

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 130

def hash
  [action_id, required_action_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 174

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



168
169
170
 
# File 'lib/oci/generative_ai_agent_runtime/models/required_action.rb', line 168

def to_s
  to_hash.to_s
end