class OCI::ResourceSearch::Models::SearchContext
Contains search context, such as highlighting, for found resources.
Attributes
Describes what in each field matched the search criteria by showing highlighted values, but only for free text searches or for structured queries that use a MATCHING clause. The list of strings represents fragments of values that matched the query conditions. Highlighted values are wrapped with <h1>..</h1> tags. All values are HTML-encoded (except <h1> tags).
@return [Hash<String, Array<String>>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/resource_search/models/search_context.rb, line 18 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'highlights': :'highlights' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Hash<String, Array<String>>] :highlights The value to assign to the {#highlights} property
# File lib/oci/resource_search/models/search_context.rb, line 42 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.highlights = attributes[:'highlights'] if attributes[:'highlights'] end
Attribute type mapping.
# File lib/oci/resource_search/models/search_context.rb, line 27 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'highlights': :'Hash<String, Array<String>>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/resource_search/models/search_context.rb, line 58 def ==(other) return true if equal?(other) self.class == other.class && highlights == other.highlights end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/resource_search/models/search_context.rb, line 88 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/resource_search/models/search_context.rb, line 68 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/resource_search/models/search_context.rb, line 77 def hash [highlights].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/resource_search/models/search_context.rb, line 121 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/resource_search/models/search_context.rb, line 115 def to_s to_hash.to_s end
Private Instance Methods
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/resource_search/models/search_context.rb, line 138 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