Class: OpenSearch::DSL::Search::Options

Inherits:

Object

• Object
• OpenSearch::DSL::Search::Options

Defined in:

lib/opensearch/dsl/search/options.rb

Overview

Wraps the “extra” options of a search definition

Constant Summary

DSL_METHODS =

[
  :_source,
  :fields,
  :script_fields,
  :fielddata_fields,
  :rescore,
  :explain,
  :version,
  :indices_boost,
  :track_scores,
  :min_score,
  :track_total_hits
]

Instance Method Summary

• #empty? ⇒ Boolean

  Returns true when there are no search options defined.

• #initialize(*args, &block) ⇒ Options constructor

  A new instance of Options.

• #to_hash(options = {}) ⇒ Hash

  Convert the definition to a Hash.

Constructor Details

#initialize(*args, &block) ⇒ Options

Returns a new instance of Options.

# File 'lib/opensearch/dsl/search/options.rb', line 49

def initialize(*args, &block)
  @hash = {}
end

Instance Method Details

#empty? ⇒ Boolean

Returns true when there are no search options defined

Returns:

• (Boolean)

# File 'lib/opensearch/dsl/search/options.rb', line 67

def empty?
  @hash.empty?
end

#to_hash(options = {}) ⇒ Hash

Convert the definition to a Hash

Returns:

• (Hash)

# File 'lib/opensearch/dsl/search/options.rb', line 75

def to_hash(options={})
  @hash
end