Class: OCI::GenerativeAi::Models::CreateSchemasDatabaseToolsConnectionDetails

Inherits:
CreateSchemasDetails
  • Object
show all
Defined in:
lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb

Overview

Array of database schemas or database objects included in the enrichment pipeline for data sources connected via an OCI Database Tools connection.

Constant Summary

Constants inherited from CreateSchemasDetails

OCI::GenerativeAi::Models::CreateSchemasDetails::CONNECTION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateSchemasDetails

#connection_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateSchemasDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateSchemasDatabaseToolsConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb', line 48

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

  attributes['connectionType'] = 'DATABASE_TOOLS_CONNECTION'

  super(attributes)

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

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

Instance Attribute Details

#schemas ⇒ Array<OCI::GenerativeAi::Models::SchemaItem>

[Required] Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.

Returns:



19
20
21
 
# File 'lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb', line 19

def schemas
  @schemas
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/models/create_schemas_database_tools_connection_details.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'schemas': :'schemas'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'schemas': :'Array<OCI::GenerativeAi::Models::SchemaItem>'
    # 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



68
69
70
71
72
73
74
 
# File 'lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb', line 68

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    schemas == other.schemas
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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb', line 99

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


79
80
81
 
# File 'lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb', line 79

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



88
89
90
 
# File 'lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb', line 88

def hash
  [connection_type, schemas].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb', line 132

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



126
127
128
 
# File 'lib/oci/generative_ai/models/create_schemas_database_tools_connection_details.rb', line 126

def to_s
  to_hash.to_s
end