Class: OCI::GoldenGate::Models::CreateApiKeyAiModelAuthDetails

Inherits:
CreateAiModelAuthDetails show all
Defined in:
lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb

Overview

The information about new API key authentication details for an AI Model connection.

Constant Summary

Constants inherited from CreateAiModelAuthDetails

OCI::GoldenGate::Models::CreateAiModelAuthDetails::AUTH_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateAiModelAuthDetails

#auth_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateAiModelAuthDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateApiKeyAiModelAuthDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :base_url (String) —

    The value to assign to the #base_url property

  • :api_key (String) —

    The value to assign to the #api_key property

  • :api_key_secret_id (String) —

    The value to assign to the #api_key_secret_id property



65
66
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
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 65

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

  attributes['authType'] = 'API_KEY'

  super(attributes)

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

  self.base_url = attributes[:'baseUrl'] if attributes[:'baseUrl']

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

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

  self.api_key = attributes[:'apiKey'] if attributes[:'apiKey']

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

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

  self.api_key_secret_id = attributes[:'apiKeySecretId'] if attributes[:'apiKeySecretId']

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

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

Instance Attribute Details

#api_key ⇒ String

API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 25

def api_key
  @api_key
end

#api_key_secret_id ⇒ String

API key secret OCID for the AI model connection.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 30

def api_key_secret_id
  @api_key_secret_id
end

#base_url ⇒ String

Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 17

def base_url
  @base_url
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'auth_type': :'authType',
    'base_url': :'baseUrl',
    'api_key': :'apiKey',
    'api_key_secret_id': :'apiKeySecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'auth_type': :'String',
    'base_url': :'String',
    'api_key': :'String',
    'api_key_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



101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 101

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

  self.class == other.class &&
    auth_type == other.auth_type &&
    base_url == other.base_url &&
    api_key == other.api_key &&
    api_key_secret_id == other.api_key_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



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

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


114
115
116
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 114

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 123

def hash
  [auth_type, base_url, api_key, api_key_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



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 167

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



161
162
163
 
# File 'lib/oci/golden_gate/models/create_api_key_ai_model_auth_details.rb', line 161

def to_s
  to_hash.to_s
end