Class: Elasticsearch::DSL::Search::Suggest

Inherits:

Object

• Object
• Elasticsearch::DSL::Search::Suggest

Includes:

BaseComponent

Defined in:

lib/elasticsearch/dsl/search/suggest.rb

Overview

Wraps the ‘suggest` part of a search definition

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html

Instance Method Summary

• #initialize(key, options = {}, &block) ⇒ Suggest constructor

  A new instance of Suggest.

• #to_hash ⇒ Hash

  Convert the definition to a Hash.

Methods included from BaseComponent

included

Constructor Details

#initialize(key, options = {}, &block) ⇒ Suggest

Returns a new instance of Suggest.

# File 'lib/elasticsearch/dsl/search/suggest.rb', line 16

def initialize(key, options={}, &block)
  @key     = key
  @options = options
  @block   = block
end

Instance Method Details

#to_hash ⇒ Hash

Convert the definition to a Hash

Returns:

• (Hash)

# File 'lib/elasticsearch/dsl/search/suggest.rb', line 26

def to_hash
  { @key => @options }
end