Module: JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchClauses

Included in:
JayAPI::Elasticsearch::QueryBuilder::QueryClauses, Bool
Defined in:
lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb

Overview

Provides an easy interface to add query clauses to objects that behave like query clauses sets.

See Also:

Instance Method Summary collapse

Instance Method Details

#exists(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Exists clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the Exists class' constructor.

Returns:

  • (self) —

    Returns itself so that other methods can be chained.

Raises:

See Also:



77
78
79
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 77

def exists(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Exists.new(**params)
end

#ids(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::IDs clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the IDs class' constructor.

Returns:

  • (self) —

    Returns itself, so that other methods can be chained.

Raises:

See Also:



139
140
141
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 139

def ids(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::IDs.new(**params)
end

#match_all ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchAll clause to the Query Clauses set.

Returns:

  • (self) —

    Returns itself, so that other methods can be chained.

Raises:



148
149
150
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 148

def match_all
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchAll.new
end

#match_none ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchNone clause to the Query Clauses set.

Returns:

  • (self) —

    Returns itself, so that other methods can be chained.

Raises:



157
158
159
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 157

def match_none
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchNone.new
end

#match_phrase(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchPhrase clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the MatchPhrase class.

Returns:

  • (self) —

    Returns itself so that other methods can be chained.

Raises:



31
32
33
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 31

def match_phrase(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchPhrase.new(**params)
end

#prefix(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Prefix clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the Prefix class.

Returns:

  • (self) —

    Returns itself so that other methods can be chained.

Raises:



41
42
43
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 41

def prefix(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Prefix.new(**params)
end

#query_string(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryString clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the QueryString class constructor.

Returns:

  • (self) —

    Returns itself so that other methods can be chained.

Raises:

See Also:



53
54
55
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 53

def query_string(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryString.new(**params)
end

#range(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Range clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the Range class' constructor.

Returns:

  • (self) —

    Returns itself so that other methods can be chained.

Raises:

See Also:

  • Rang#initialize


103
104
105
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 103

def range(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Range.new(**params)
end

#regexp(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Regexp clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the Regexp class' constructor.

Returns:

  • (self) —

    Returns itself, so that other methods can be chained.

Raises:

See Also:



127
128
129
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 127

def regexp(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Regexp.new(**params)
end

#term(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Term clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the Term class' constructor.

Returns:

  • (self) —

    Returns itself so that other methods can be chained.

Raises:

See Also:



89
90
91
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 89

def term(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Term.new(**params)
end

#terms(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Terms clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the Terms class' constructor.

Returns:

  • (self) —

    Returns itself, so that other methods can be chained.

Raises:

See Also:



115
116
117
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 115

def terms(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Terms.new(**params)
end

#wildcard(**params) ⇒ self

Adds a JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Wildcard clause to the Query Clauses set.

Parameters:

  • params (Hash) —

    The parameters for the Wildcard class constructor.

Returns:

  • (self) —

    Returns itself so that other methods can be chained.

Raises:

See Also:



65
66
67
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 65

def wildcard(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Wildcard.new(**params)
end