Class: OCI::GenerativeAiAgent::Models::HttpEndpointToolConfig

Inherits:
ToolConfig
  • Object
show all
Defined in:
lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb

Overview

The configuration for HTTP endpoint Tool.

Constant Summary

Constants inherited from ToolConfig

ToolConfig::TOOL_CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ToolConfig

#tool_config_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ToolConfig

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ HttpEndpointToolConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 58

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

  attributes['toolConfigType'] = 'HTTP_ENDPOINT_TOOL_CONFIG'

  super(attributes)

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

  self.api_schema = attributes[:'apiSchema'] if attributes[:'apiSchema']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.http_endpoint_auth_config = attributes[:'httpEndpointAuthConfig'] if attributes[:'httpEndpointAuthConfig']

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

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

Instance Attribute Details

#api_schema ⇒ OCI::GenerativeAiAgent::Models::ApiSchemaInputLocation

This attribute is required.

Returns:



15
16
17
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 15

def api_schema
  @api_schema
end

#http_endpoint_auth_config ⇒ OCI::GenerativeAiAgent::Models::HttpEndpointAuthConfig

This attribute is required.

Returns:



23
24
25
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 23

def http_endpoint_auth_config
  @http_endpoint_auth_config
end

#subnet_id ⇒ String

[Required] The subnet ID from agent developer tenancy through which the egress is going to be routed.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 19

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_config_type': :'toolConfigType',
    'api_schema': :'apiSchema',
    'subnet_id': :'subnetId',
    'http_endpoint_auth_config': :'httpEndpointAuthConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_config_type': :'String',
    'api_schema': :'OCI::GenerativeAiAgent::Models::ApiSchemaInputLocation',
    'subnet_id': :'String',
    'http_endpoint_auth_config': :'OCI::GenerativeAiAgent::Models::HttpEndpointAuthConfig'
    # 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



94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 94

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

  self.class == other.class &&
    tool_config_type == other.tool_config_type &&
    api_schema == other.api_schema &&
    subnet_id == other.subnet_id &&
    http_endpoint_auth_config == other.http_endpoint_auth_config
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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 127

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


107
108
109
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 116

def hash
  [tool_config_type, api_schema, subnet_id, http_endpoint_auth_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 160

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



154
155
156
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_tool_config.rb', line 154

def to_s
  to_hash.to_s
end