class OCI::DataCatalog::Models::SuggestResults

The list of potential matches returned from the suggest operation for the given input text. The size of the list will be determined by the limit parameter.

Attributes

input_text[RW]

[Required] Input string for which the potential matches are computed. @return [String]

items[RW]

List of suggestions. @return [Array<OCI::DataCatalog::Models::SuggestListItem>]

search_latency_in_ms[RW]

Time taken to compute the result, in milliseconds. @return [Integer]

total_count[RW]

[Required] Total number of items returned. @return [Integer]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_catalog/models/suggest_results.rb, line 29
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'total_count': :'totalCount',
    'search_latency_in_ms': :'searchLatencyInMs',
    'input_text': :'inputText',
    'items': :'items'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Integer] :total_count The value to assign to the {#total_count} property @option attributes [Integer] :search_latency_in_ms The value to assign to the {#search_latency_in_ms} property @option attributes [String] :input_text The value to assign to the {#input_text} property @option attributes [Array<OCI::DataCatalog::Models::SuggestListItem>] :items The value to assign to the {#items} property

# File lib/oci/data_catalog/models/suggest_results.rb, line 62
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

  self.total_count = attributes[:'totalCount'] if attributes[:'totalCount']

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

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

  self.search_latency_in_ms = attributes[:'searchLatencyInMs'] if attributes[:'searchLatencyInMs']

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

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

  self.input_text = attributes[:'inputText'] if attributes[:'inputText']

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

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

  self.items = attributes[:'items'] if attributes[:'items']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_catalog/models/suggest_results.rb, line 41
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'total_count': :'Integer',
    'search_latency_in_ms': :'Integer',
    'input_text': :'String',
    'items': :'Array<OCI::DataCatalog::Models::SuggestListItem>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/data_catalog/models/suggest_results.rb, line 96
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    total_count == other.total_count &&
    search_latency_in_ms == other.search_latency_in_ms &&
    input_text == other.input_text &&
    items == other.items
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/data_catalog/models/suggest_results.rb, line 129
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/data_catalog/models/suggest_results.rb, line 109
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/data_catalog/models/suggest_results.rb, line 118
def hash
  [total_count, search_latency_in_ms, input_text, items].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/data_catalog/models/suggest_results.rb, line 162
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/data_catalog/models/suggest_results.rb, line 156
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/data_catalog/models/suggest_results.rb, line 179
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end