Class: OCI::GoldenGate::Models::UpdateOciGenAiModelAuthDetails

Inherits:
UpdateAiModelAuthDetails show all
Defined in:
lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb

Overview

The information to update OCI Generative AI authentication details for an AI Model connection.

Constant Summary

Constants inherited from UpdateAiModelAuthDetails

OCI::GoldenGate::Models::UpdateAiModelAuthDetails::AUTH_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateAiModelAuthDetails

#auth_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateAiModelAuthDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOciGenAiModelAuthDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

  • :key_fingerprint (String) —

    The value to assign to the #key_fingerprint property

  • :region (String) —

    The value to assign to the #region property

  • :tenancy_id (String) —

    The value to assign to the #tenancy_id property

  • :user_id (String) —

    The value to assign to the #user_id property



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 91

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

  attributes['authType'] = 'OCI_GEN_AI'

  super(attributes)

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

  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']

  self.key_fingerprint = attributes[:'keyFingerprint'] if attributes[:'keyFingerprint']

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

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

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

  self.tenancy_id = attributes[:'tenancyId'] if attributes[:'tenancyId']

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

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

  self.user_id = attributes[:'userId'] if attributes[:'userId']

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

  self.user_id = attributes[:'user_id'] if attributes[:'user_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) 


19
20
21
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 19

def api_key
  @api_key
end

#api_key_secret_id ⇒ String

API key secret OCID for the AI model connection.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 24

def api_key_secret_id
  @api_key_secret_id
end

#key_fingerprint ⇒ String

OCI Generative AI key fingerprint.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 29

def key_fingerprint
  @key_fingerprint
end

#region ⇒ String

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 35

def region
  @region
end

#tenancy_id ⇒ String

OCI Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 41

def tenancy_id
  @tenancy_id
end

#user_id ⇒ String

OCI Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 47

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'auth_type': :'authType',
    'api_key': :'apiKey',
    'api_key_secret_id': :'apiKeySecretId',
    'key_fingerprint': :'keyFingerprint',
    'region': :'region',
    'tenancy_id': :'tenancyId',
    'user_id': :'userId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'auth_type': :'String',
    'api_key': :'String',
    'api_key_secret_id': :'String',
    'key_fingerprint': :'String',
    'region': :'String',
    'tenancy_id': :'String',
    'user_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



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 141

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

  self.class == other.class &&
    auth_type == other.auth_type &&
    api_key == other.api_key &&
    api_key_secret_id == other.api_key_secret_id &&
    key_fingerprint == other.key_fingerprint &&
    region == other.region &&
    tenancy_id == other.tenancy_id &&
    user_id == other.user_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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 177

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


157
158
159
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 157

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 166

def hash
  [auth_type, api_key, api_key_secret_id, key_fingerprint, region, tenancy_id, user_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 210

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



204
205
206
 
# File 'lib/oci/golden_gate/models/update_oci_gen_ai_model_auth_details.rb', line 204

def to_s
  to_hash.to_s
end