Class: OCI::GenerativeAiAgent::Models::HttpEndpointAuthSource

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

Overview

A credential source and configuration for a specific scope to HTTP Endpoint tools.

Constant Summary collapse

HTTP_ENDPOINT_AUTH_SCOPE_ENUM = 
[
  HTTP_ENDPOINT_AUTH_SCOPE_AGENT = 'AGENT'.freeze,
  HTTP_ENDPOINT_AUTH_SCOPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HttpEndpointAuthSource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 54

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

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

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

  self.http_endpoint_auth_scope_config = attributes[:'httpEndpointAuthScopeConfig'] if attributes[:'httpEndpointAuthScopeConfig']

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

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

Instance Attribute Details

#http_endpoint_auth_scope ⇒ String

[Required] Specifies the level from which credentials should be resolved.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 20

def http_endpoint_auth_scope
  @http_endpoint_auth_scope
end

#http_endpoint_auth_scope_config ⇒ OCI::GenerativeAiAgent::Models::HttpEndpointAuthScopeConfig

This attribute is required.

Returns:



24
25
26
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 24

def http_endpoint_auth_scope_config
  @http_endpoint_auth_scope_config
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'http_endpoint_auth_scope': :'httpEndpointAuthScope',
    'http_endpoint_auth_scope_config': :'httpEndpointAuthScopeConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'http_endpoint_auth_scope': :'String',
    'http_endpoint_auth_scope_config': :'OCI::GenerativeAiAgent::Models::HttpEndpointAuthScopeConfig'
    # 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



93
94
95
96
97
98
99
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 93

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

  self.class == other.class &&
    http_endpoint_auth_scope == other.http_endpoint_auth_scope &&
    http_endpoint_auth_scope_config == other.http_endpoint_auth_scope_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



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

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


104
105
106
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 104

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 113

def hash
  [http_endpoint_auth_scope, http_endpoint_auth_scope_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 157

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



151
152
153
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_auth_source.rb', line 151

def to_s
  to_hash.to_s
end