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:



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

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:



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

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:



137
138
139
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 137

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:



146
147
148
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 146

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:



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

def match_phrase(**params)
  self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchPhrase.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:



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

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


92
93
94
 
# File 'lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb', line 92

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:



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

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:



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

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:



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

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:



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

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