Class: Elasticsearch::Model::Response::Results

Inherits:

Object

• Object
• Elasticsearch::Model::Response::Results

Includes:

Base, Enumerable

Defined in:

lib/elasticsearch/model/response/results.rb

Overview

Encapsulates the collection of documents returned from Elasticsearch

Implements Enumerable and forwards its methods to the #results object.

Instance Attribute Summary

Attributes included from Base

#klass, #raw_response, #response

Instance Method Summary

• #initialize(klass, response, options = {}) ⇒ Results constructor

  A new instance of Results.

• #results ⇒ Object (also: #records)

  Returns the Results collection.

Methods included from Base

#max_score, #total

Constructor Details

#initialize(klass, response, options = {}) ⇒ Results

Returns a new instance of Results.

See Also:

• Base#initialize

# File 'lib/elasticsearch/model/response/results.rb', line 34

def initialize(klass, response, options={})
  super
end

Instance Method Details

#results ⇒ Object Also known as: records

Returns the Elasticsearch::Model::Response::Results collection

# File 'lib/elasticsearch/model/response/results.rb', line 40

def results
  # TODO: Configurable custom wrapper
  response.response['hits']['hits'].map { |hit| Result.new(hit) }
end