Class: OCI::GenerativeAiAgent::Models::OciOpenSearchIndexConfig

Inherits:
IndexConfig
  • Object
show all
Defined in:
lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb

Overview

The details of customer managed OCI OpenSearch.

Constant Summary

Constants inherited from IndexConfig

IndexConfig::INDEX_CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from IndexConfig

#index_config_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from IndexConfig

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OciOpenSearchIndexConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 58

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

  attributes['indexConfigType'] = 'OCI_OPEN_SEARCH_INDEX_CONFIG'

  super(attributes)

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

  self.cluster_id = attributes[:'clusterId'] if attributes[:'clusterId']

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

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

  self.secret_detail = attributes[:'secretDetail'] if attributes[:'secretDetail']

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

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

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

Instance Attribute Details

#cluster_id ⇒ String

[Required] The OCID of the OpenSearch Cluster.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 15

def cluster_id
  @cluster_id
end

#indexes ⇒ Array<OCI::GenerativeAiAgent::Models::Index>

[Required] Index configuration for open search.

Returns:



23
24
25
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 23

def indexes
  @indexes
end

#secret_detail ⇒ OCI::GenerativeAiAgent::Models::SecretDetail

This attribute is required.

Returns:



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

def secret_detail
  @secret_detail
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'index_config_type': :'indexConfigType',
    'cluster_id': :'clusterId',
    'secret_detail': :'secretDetail',
    'indexes': :'indexes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'index_config_type': :'String',
    'cluster_id': :'String',
    'secret_detail': :'OCI::GenerativeAiAgent::Models::SecretDetail',
    'indexes': :'Array<OCI::GenerativeAiAgent::Models::Index>'
    # 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



90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 90

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

  self.class == other.class &&
    index_config_type == other.index_config_type &&
    cluster_id == other.cluster_id &&
    secret_detail == other.secret_detail &&
    indexes == other.indexes
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 123

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


103
104
105
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 103

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 112

def hash
  [index_config_type, cluster_id, secret_detail, indexes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 156

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



150
151
152
 
# File 'lib/oci/generative_ai_agent/models/oci_open_search_index_config.rb', line 150

def to_s
  to_hash.to_s
end