Class: OCI::GoldenGate::Models::AiModelConnection

Inherits:
Connection
  • Object
show all
Defined in:
lib/oci/golden_gate/models/ai_model_connection.rb

Overview

Represents the metadata of an AI Model Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM =
[
  TECHNOLOGY_TYPE_AI_MODEL = 'AI_MODEL'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PROVIDER_TYPE_ENUM =
[
  PROVIDER_TYPE_OCI_GENERATIVE_AI = 'OCI_GENERATIVE_AI'.freeze,
  PROVIDER_TYPE_GEMINI = 'GEMINI'.freeze,
  PROVIDER_TYPE_OPEN_AI = 'OPEN_AI'.freeze,
  PROVIDER_TYPE_VOYAGE_AI = 'VOYAGE_AI'.freeze,
  PROVIDER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Connection

Connection::CONNECTION_TYPE_ENUM, Connection::LIFECYCLE_STATE_ENUM, Connection::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from Connection

#cluster_placement_group_id, #compartment_id, #connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #locks, #nsg_ids, #routing_method, #security_attributes, #subnet_id, #subscription_id, #system_tags, #time_created, #time_updated, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AiModelConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 154

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

  attributes['connectionType'] = 'AI_MODEL'

  super(attributes)

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

  self.technology_type = attributes[:'technologyType'] if attributes[:'technologyType']

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

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

  self.provider_type = attributes[:'providerType'] if attributes[:'providerType']

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

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

  self.model_key = attributes[:'modelKey'] if attributes[:'modelKey']

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

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

  self.max_input_chars = attributes[:'maxInputChars'] if attributes[:'maxInputChars']

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

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

  self.auth_details = attributes[:'authDetails'] if attributes[:'authDetails']

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

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

Instance Attribute Details

#auth_detailsOCI::GoldenGate::Models::AiModelAuthDetails



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

def auth_details
  @auth_details
end

#max_input_charsInteger

Maximum number of input characters supported by this AI model connection.

Returns:

  • (Integer)


44
45
46
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 44

def max_input_chars
  @max_input_chars
end

#model_keyString

[Required] AI model identifier.

Returns:

  • (String)


39
40
41
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 39

def model_key
  @model_key
end

#provider_typeString

AI Provider type used by the AI Model Connection.

Returns:

  • (String)


34
35
36
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 34

def provider_type
  @provider_type
end

#technology_typeString

[Required] The AI Model technology type.

Returns:

  • (String)


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

def technology_type
  @technology_type
end

Class Method Details

.attribute_mapObject

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



50
51
52
53
54
55
56
57
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
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'locks': :'locks',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'subscription_id': :'subscriptionId',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'security_attributes': :'securityAttributes',
    'technology_type': :'technologyType',
    'provider_type': :'providerType',
    'model_key': :'modelKey',
    'max_input_chars': :'maxInputChars',
    'auth_details': :'authDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



86
87
88
89
90
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
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 86

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'subscription_id': :'String',
    'cluster_placement_group_id': :'String',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'technology_type': :'String',
    'provider_type': :'String',
    'model_key': :'String',
    'max_input_chars': :'Integer',
    'auth_details': :'OCI::GoldenGate::Models::AiModelAuthDetails'
    # 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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 228

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    locks == other.locks &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    subscription_id == other.subscription_id &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    security_attributes == other.security_attributes &&
    technology_type == other.technology_type &&
    provider_type == other.provider_type &&
    model_key == other.model_key &&
    max_input_chars == other.max_input_chars &&
    auth_details == other.auth_details
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 285

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


265
266
267
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 265

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



274
275
276
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 274

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, locks, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, routing_method, does_use_secret_ids, subscription_id, cluster_placement_group_id, security_attributes, technology_type, provider_type, model_key, max_input_chars, auth_details].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



318
319
320
321
322
323
324
325
326
327
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 318

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



312
313
314
# File 'lib/oci/golden_gate/models/ai_model_connection.rb', line 312

def to_s
  to_hash.to_s
end