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 =

%i[
  _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) ⇒ Options constructor

  A new instance of Options.

• #source(*args) ⇒ Object
• #to_hash(_options = {}) ⇒ Hash

  Convert the definition to a Hash.

Constructor Details

#initialize(*_args) ⇒ Options

Returns a new instance of Options.

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

def initialize(*_args)
  @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 66

def empty?
  @hash.empty?
end

#source(*args) ⇒ Object

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

def source(*args)
  @hash[:_source] = args.pop
end

#to_hash(_options = {}) ⇒ Hash

Convert the definition to a Hash

Returns:

• (Hash)

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

def to_hash(_options = {})
  @hash
end