Class: OCI::GenerativeAiAgent::Models::HttpEndpointBasicAuthScopeConfig

Inherits:
HttpEndpointAuthScopeConfig show all
Defined in:
lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb

Overview

Specifies HTTP Basic Authentication using base64-encoded username:password credentials injected into the Authorization header.

  • If authScope = AGENT: Credentials are securely retrieved from OCI Vault.

Constant Summary

Constants inherited from HttpEndpointAuthScopeConfig

OCI::GenerativeAiAgent::Models::HttpEndpointAuthScopeConfig::HTTP_ENDPOINT_AUTH_SCOPE_CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from HttpEndpointAuthScopeConfig

#http_endpoint_auth_scope_config_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from HttpEndpointAuthScopeConfig

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ HttpEndpointBasicAuthScopeConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vault_secret_id (String) —

    The value to assign to the #vault_secret_id property



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 48

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

  attributes['httpEndpointAuthScopeConfigType'] = 'HTTP_ENDPOINT_BASIC_AUTH_SCOPE_CONFIG'

  super(attributes)

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

  self.vault_secret_id = attributes[:'vaultSecretId'] if attributes[:'vaultSecretId']

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

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

Instance Attribute Details

#vault_secret_id ⇒ String

The OCID of the vault secret with username:password. Required when authScope is AGENT.

Returns:

  • (String) 


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

def vault_secret_id
  @vault_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'http_endpoint_auth_scope_config_type': :'httpEndpointAuthScopeConfigType',
    'vault_secret_id': :'vaultSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 32

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



72
73
74
75
76
77
78
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 72

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

  self.class == other.class &&
    http_endpoint_auth_scope_config_type == other.http_endpoint_auth_scope_config_type &&
    vault_secret_id == other.vault_secret_id
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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 103

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


83
84
85
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 83

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



92
93
94
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 92

def hash
  [http_endpoint_auth_scope_config_type, vault_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 136

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



130
131
132
 
# File 'lib/oci/generative_ai_agent/models/http_endpoint_basic_auth_scope_config.rb', line 130

def to_s
  to_hash.to_s
end