ElasticQuery
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
ElasticQuery.type
Members list
Value members
Concrete methods
Constructs an instance of zio.elasticsearch.query.BoostingQuery with queries that must satisfy the criteria using the specified parameters. zio.elasticsearch.query.BoostingQuery returns documents that match the query marked as positive while reducing the relevance score of documents that also match a query which is marked as negative query.
Constructs an instance of zio.elasticsearch.query.BoostingQuery with queries that must satisfy the criteria using the specified parameters. zio.elasticsearch.query.BoostingQuery returns documents that match the query marked as positive while reducing the relevance score of documents that also match a query which is marked as negative query.
Type parameters
- S
-
document for which field query is executed. An implicit
Schemainstance must be in scope
Value parameters
- negativeBoost
-
the number between 0 and 1.0 used to decrease the relevance score of documents matching the negative query
- negativeQuery
-
the query that decreases the relevance score of matching documents
- positiveQuery
-
the query that must be satisfied
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoostingQuery that represents the boost query to be performed.
Constructs an instance of zio.elasticsearch.query.BoostingQuery with queries that must satisfy the criteria using the specified parameters. zio.elasticsearch.query.BoostingQuery returns documents that match the query marked as positive while reducing the relevance score of documents that also match a query which is marked as negative query.
Constructs an instance of zio.elasticsearch.query.BoostingQuery with queries that must satisfy the criteria using the specified parameters. zio.elasticsearch.query.BoostingQuery returns documents that match the query marked as positive while reducing the relevance score of documents that also match a query which is marked as negative query.
Value parameters
- negativeBoost
-
the number between 0 and 1.0 used to decrease the relevance score of documents matching the negative query
- negativeQuery
-
the query that decreases the relevance score of matching documents
- positiveQuery
-
the query that must be satisfied
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoostingQuery that represents the boost query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.ConstantScoreQuery with a specified query. zio.elasticsearch.query.ConstantScoreQuery wraps a filter query and returns every matching document with a relevance score equal to the boost parameter value.
Constructs a type-safe instance of zio.elasticsearch.query.ConstantScoreQuery with a specified query. zio.elasticsearch.query.ConstantScoreQuery wraps a filter query and returns every matching document with a relevance score equal to the boost parameter value.
Type parameters
- S
-
document for which field query is specified for. An implicit
Schemainstance must be provided in the scope
Value parameters
- query
-
query to be wrapped inside of constant score query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.ConstantScoreQuery that represents the constant score query with query that must satisfy the criteria to be performed.
Constructs an instance of zio.elasticsearch.query.ConstantScoreQuery with a specified query. zio.elasticsearch.query.ConstantScoreQuery wraps a filter query and returns every matching document with a relevance score equal to the boost parameter value.
Constructs an instance of zio.elasticsearch.query.ConstantScoreQuery with a specified query. zio.elasticsearch.query.ConstantScoreQuery wraps a filter query and returns every matching document with a relevance score equal to the boost parameter value.
Value parameters
- query
-
query to be wrapped inside of constant score query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.ConstantScoreQuery that represents the constant score query with query that must satisfy the criteria to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that contains the specified value in the specified field.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that contains the specified value in the specified field.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query in the pattern that represents
contains
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that contains the specified value in the specified field.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that contains the specified value in the specified field.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query in the pattern that represents
contains
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.DisjunctionMax using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.DisjunctionMax using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schemainstance must be in scope
Value parameters
- queries
-
the rest of the queries to be wrapped inside of disjunction max query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.DisjunctionMax that represents the
disjunction maxquery to be performed.
Constructs an instance of zio.elasticsearch.query.DisjunctionMax using the specified parameters.
Constructs an instance of zio.elasticsearch.query.DisjunctionMax using the specified parameters.
Value parameters
- queries
-
the rest of the queries to be wrapped inside of disjunction max query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.DisjunctionMax that represents the
disjunction maxquery to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.ExistsQuery, that checks existence of the field, using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.ExistsQuery, that checks existence of the field, using the specified parameters.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.ExistsQuery that represents the exists query to be performed.
Constructs an instance of zio.elasticsearch.query.ExistsQuery, that checks existence of the field, using the specified parameters.
Constructs an instance of zio.elasticsearch.query.ExistsQuery, that checks existence of the field, using the specified parameters.
Value parameters
- field
-
the field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.ExistsQuery that represents the exists query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schemainstance must be in scope
Value parameters
- queries
-
a list of queries to add to
filterinside of theBoolquery
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Value parameters
- queries
-
a list of queries to add to
filterinside of theBoolquery
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
Constructs a type-safe instance of zio.elasticsearch.query.FunctionScore query with one or multiple zio.elasticsearch.query.FunctionScoreFunction.
Constructs a type-safe instance of zio.elasticsearch.query.FunctionScore query with one or multiple zio.elasticsearch.query.FunctionScoreFunction.
Value parameters
- functions
-
zio.elasticsearch.query.FunctionScoreFunction functions that will be part of zio.elasticsearch.query.FunctionScore query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScore that represents the Function Score Query with functions that are used to calculate score for result.
Constructs an instance of zio.elasticsearch.query.FunctionScore query with one or multiple zio.elasticsearch.query.FunctionScoreFunction.
Constructs an instance of zio.elasticsearch.query.FunctionScore query with one or multiple zio.elasticsearch.query.FunctionScoreFunction.
Value parameters
- functions
-
zio.elasticsearch.query.FunctionScoreFunction functions that will be part of zio.elasticsearch.query.FunctionScore query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScore that represents the Function Score Query with functions that are used to calculate score for result.
Constructs a type-safe instance of zio.elasticsearch.query.FuzzyQuery using the specified parameters. zio.elasticsearch.query.FuzzyQuery returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
Constructs a type-safe instance of zio.elasticsearch.query.FuzzyQuery using the specified parameters. zio.elasticsearch.query.FuzzyQuery returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FuzzyQuery that represents the
fuzzyquery to be performed.
Constructs an instance of zio.elasticsearch.query.FuzzyQuery using the specified parameters. zio.elasticsearch.query.FuzzyQuery returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
Constructs an instance of zio.elasticsearch.query.FuzzyQuery using the specified parameters. zio.elasticsearch.query.FuzzyQuery returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FuzzyQuery that represents the
fuzzyquery to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Type parameters
- S
-
the type of document on which the query is defined
Value parameters
- distance
-
the distance within which values should be matched
- field
-
the type-safe GeoPoint field for which the query is specified
- point
-
the geo-point from which the distance should be measured
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distancequery to be performed.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Value parameters
- distance
-
the distance within which values should be matched
- field
-
the field for which the query is specified
- point
-
the geo-point from which the distance should be measured
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distancequery to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Type parameters
- S
-
the type of document on which the query is defined
Value parameters
- distance
-
the distance within which values should be matched
- field
-
the type-safe field for which the query is specified
- point
-
the geo-point from which the distance should be measured, defined as geo-hash
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distancequery to be performed.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Value parameters
- distance
-
the distance within which values should be matched
- field
-
the field for which the query is specified
- point
-
the geo-point from which the distance should be measured, defined as geo-hash
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distancequery to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.GeoPolygonQuery using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.GeoPolygonQuery using the specified parameters.
Type parameters
- S
-
document for which field query is executed
Value parameters
- coordinates
-
list of longitudes and latitudes of the desired points written as string (e.g. ["40, 31", "25, 31"]) or geo hash (e.g. ["drm3btev3e86", "drm3btev3e87"])
- field
-
the type-safe field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoPolygonQuery that represents
geo_polygonquery to be performed.
Constructs an instance of zio.elasticsearch.query.GeoPolygonQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.GeoPolygonQuery using the specified parameters.
Value parameters
- coordinates
-
list of longitudes and latitudes of the desired points written as string (e.g. ["40, 31", "25, 31"]) or geo hash (e.g. ["drm3btev3e86", "drm3btev3e87"])
- field
-
the field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoPolygonQuery that represents
geo_polygonquery to be performed.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Type parameters
- S
-
document for which field query is executed
Value parameters
- childType
-
a name of the child relationship mapped for the join field
- query
-
the type-safe zio.elasticsearch.ElasticQuery object representing query you wish to run on child documents of the child
typefield
Attributes
- Returns
-
an instance of zio.elasticsearch.query.HasChildQuery that represents the
has child queryto be performed.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Value parameters
- childType
-
a name of the child relationship mapped for the join field
- query
-
the zio.elasticsearch.ElasticQuery object representing query you wish to run on child documents of the child
typefield
Attributes
- Returns
-
an instance of zio.elasticsearch.query.HasChildQuery that represents the
has child queryto be performed.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Type parameters
- S
-
document for which field query is executed
Value parameters
- parentType
-
a name of the parent relationship mapped for the join field
- query
-
the type-safe zio.elasticsearch.ElasticQuery object representing query you wish to run on parent documents of the
parent_typefield
Attributes
- Returns
-
an instance of zio.elasticsearch.query.HasParentQuery that represents the has parent query to be performed.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Value parameters
- parentType
-
a name of the parent relationship mapped for the join field
- query
-
the zio.elasticsearch.ElasticQuery object representing query you wish to run on parent documents of the
parent_typefield
Attributes
- Returns
-
an instance of zio.elasticsearch.query.HasParentQuery that represents the has parent query to be performed.
Constructs an instance of zio.elasticsearch.query.IdsQuery using the specified parameters. zio.elasticsearch.query.IdsQuery is used for matching documents containing a value that matches a provided pattern value.
Constructs an instance of zio.elasticsearch.query.IdsQuery using the specified parameters. zio.elasticsearch.query.IdsQuery is used for matching documents containing a value that matches a provided pattern value.
Value parameters
- value
-
value that will be used for the query
- values
-
array of optional values that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.IdsQuery that represents the ids query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.KNNQuery using the specified parameters. zio.elasticsearch.query.KNNQuery is used to perform a k-nearest neighbor (kNN) search and returns the matching documents.
Constructs a type-safe instance of zio.elasticsearch.query.KNNQuery using the specified parameters. zio.elasticsearch.query.KNNQuery is used to perform a k-nearest neighbor (kNN) search and returns the matching documents.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- k
-
number of nearest neighbors to return as top hits (must be less than
numCandidates) - numCandidates
-
number of nearest neighbor candidates to consider per shard
- queryVector
-
query vector
Attributes
- Returns
-
an instance of zio.elasticsearch.query.KNNQuery that represents the kNN query to be performed.
Constructs an instance of zio.elasticsearch.query.KNNQuery using the specified parameters. zio.elasticsearch.query.KNNQuery is used to perform a k-nearest neighbor (kNN) search and returns the matching documents.
Constructs an instance of zio.elasticsearch.query.KNNQuery using the specified parameters. zio.elasticsearch.query.KNNQuery is used to perform a k-nearest neighbor (kNN) search and returns the matching documents.
Value parameters
- field
-
the field for which query is specified for
- k
-
number of nearest neighbors to return as top hits (must be less than
numCandidates) - numCandidates
-
number of nearest neighbor candidates to consider per shard
- queryVector
-
query vector
Attributes
- Returns
-
an instance of zio.elasticsearch.query.KNNQuery that represents the kNN query to be performed.
Constructs an instance of zio.elasticsearch.query.MatchAllQuery used for matching all documents.
Constructs an instance of zio.elasticsearch.query.MatchAllQuery used for matching all documents.
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchAllQuery that represents the match all query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.MatchBooleanPrefixQuery using the specified parameters. zio.elasticsearch.query.MatchBooleanPrefixQuery analyzes its input and constructs a zio.elasticsearch.query.BoolQuery from the terms. Each term except the last is used in a zio.elasticsearch.query.TermQuery. The last term is used in a zio.elasticsearch.query.PrefixQuery query.
Constructs a type-safe instance of zio.elasticsearch.query.MatchBooleanPrefixQuery using the specified parameters. zio.elasticsearch.query.MatchBooleanPrefixQuery analyzes its input and constructs a zio.elasticsearch.query.BoolQuery from the terms. Each term except the last is used in a zio.elasticsearch.query.TermQuery. The last term is used in a zio.elasticsearch.query.PrefixQuery query.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchBooleanPrefixQuery that represents the match boolean prefix query to be performed.
Constructs an instance of zio.elasticsearch.query.MatchBooleanPrefixQuery using the specified parameters. zio.elasticsearch.query.MatchBooleanPrefixQuery analyzes its input and constructs a zio.elasticsearch.query.BoolQuery from the terms. Each term except the last is used in a zio.elasticsearch.query.TermQuery. The last term is used in a zio.elasticsearch.query.PrefixQuery.
Constructs an instance of zio.elasticsearch.query.MatchBooleanPrefixQuery using the specified parameters. zio.elasticsearch.query.MatchBooleanPrefixQuery analyzes its input and constructs a zio.elasticsearch.query.BoolQuery from the terms. Each term except the last is used in a zio.elasticsearch.query.TermQuery. The last term is used in a zio.elasticsearch.query.PrefixQuery.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
Value parameters
- field
-
the field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchBooleanPrefixQuery that represents the match boolean prefix query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters. zio.elasticsearch.query.MatchPhraseQuery analyzes the text and creates a phrase query out of the analyzed text.
Constructs a type-safe instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters. zio.elasticsearch.query.MatchPhraseQuery analyzes the text and creates a phrase query out of the analyzed text.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchPhraseQuery that represents the match phrase query to be performed.
Constructs an instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters. zio.elasticsearch.query.MatchPhraseQuery analyzes the text and creates a phrase query out of the analyzed text.
Constructs an instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters. zio.elasticsearch.query.MatchPhraseQuery analyzes the text and creates a phrase query out of the analyzed text.
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchPhraseQuery that represents the match phrase query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.MatchPhrasePrefixQuery using the specified parameters. zio.elasticsearch.query.MatchPhrasePrefixQuery returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
Constructs a type-safe instance of zio.elasticsearch.query.MatchPhrasePrefixQuery using the specified parameters. zio.elasticsearch.query.MatchPhrasePrefixQuery returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
the text value to be matched
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchPhrasePrefixQuery that represents the match phrase prefix query to be performed.
Constructs an instance of zio.elasticsearch.query.MatchPhrasePrefixQuery using the specified parameters. zio.elasticsearch.query.MatchPhrasePrefixQuery returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
Constructs an instance of zio.elasticsearch.query.MatchPhrasePrefixQuery using the specified parameters. zio.elasticsearch.query.MatchPhrasePrefixQuery returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
Value parameters
- field
-
the field for which query is specified for
- value
-
the text value to be matched
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchPhrasePrefixQuery that represents the match phrase prefix query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.MatchQuery using the specified parameters. zio.elasticsearch.query.MatchQuery is used for matching a provided text, number, date or boolean value.
Constructs a type-safe instance of zio.elasticsearch.query.MatchQuery using the specified parameters. zio.elasticsearch.query.MatchQuery is used for matching a provided text, number, date or boolean value.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchQuery that represents the match query to be performed.
Constructs an instance of zio.elasticsearch.query.MatchQuery using the specified parameters. zio.elasticsearch.query.MatchQuery is used for matching a provided text, number, date or boolean value.
Constructs an instance of zio.elasticsearch.query.MatchQuery using the specified parameters. zio.elasticsearch.query.MatchQuery is used for matching a provided text, number, date or boolean value.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
Value parameters
- field
-
the field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchQuery that represents the match query to be performed.
Constructs an instance of zio.elasticsearch.query.MultiMatchQuery using the specified parameter. zio.elasticsearch.query.MultiMatchQuery query builds on the match query to allow multi-field queries.
Constructs an instance of zio.elasticsearch.query.MultiMatchQuery using the specified parameter. zio.elasticsearch.query.MultiMatchQuery query builds on the match query to allow multi-field queries.
Value parameters
- value
-
the text value to be matched
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MultiMatchQuery that represents the multi match query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schemainstance must be in scope
Value parameters
- queries
-
a list of queries to add to
mustinside of theBoolquery
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Value parameters
- queries
-
a list of queries to add to
mustinside of theBoolquery
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must not satisfy the criteria using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must not satisfy the criteria using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schemainstance must be in scope
Value parameters
- queries
-
a list of queries to add to
mustNotinside of theBoolquery
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must not satisfy the criteria.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must not satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must not satisfy the criteria using the specified parameters.
Value parameters
- queries
-
a list of queries to add to
mustNotinside of theBoolquery
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must not satisfy the criteria.
Constructs a type-safe instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
Constructs a type-safe instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
Type parameters
- A
-
the type of the value that will be used for the query
- S
-
document for which field query is executed
Value parameters
- path
-
the type-safe path to the field for which query is specified for
- query
-
the zio.elasticsearch.ElasticQuery object representing the query to execute on nested objects.
Attributes
- Returns
-
an instance of zio.elasticsearch.query.NestedQuery that represents the nested query to be performed.
Constructs an instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
Constructs an instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
Value parameters
- path
-
the path to the field for which query is specified for
- query
-
the zio.elasticsearch.ElasticQuery object representing the query to execute on nested objects.
Attributes
- Returns
-
an instance of zio.elasticsearch.query.NestedQuery that represents the nested query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.PrefixQuery using the specified parameters. zio.elasticsearch.query.PrefixQuery is used for matching documents that contain a specific prefix in a provided field.
Constructs a type-safe instance of zio.elasticsearch.query.PrefixQuery using the specified parameters. zio.elasticsearch.query.PrefixQuery is used for matching documents that contain a specific prefix in a provided field.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.PrefixQuery that represents the prefix query to be performed.
Constructs an instance of zio.elasticsearch.query.PrefixQuery using the specified parameters. zio.elasticsearch.query.PrefixQuery is used for matching documents that contain a specific prefix in a provided field.
Constructs an instance of zio.elasticsearch.query.PrefixQuery using the specified parameters. zio.elasticsearch.query.PrefixQuery is used for matching documents that contain a specific prefix in a provided field.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.PrefixQuery that represents the prefix query to be performed.
Constructs a type-safe unbounded instance of zio.elasticsearch.query.RangeQuery using the specified parameters.
Constructs a type-safe unbounded instance of zio.elasticsearch.query.RangeQuery using the specified parameters.
Type parameters
- A
-
the type of the value that will be used for the query
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.RangeQuery that represents the range query to be performed.
Constructs an unbounded instance of zio.elasticsearch.query.RangeQuery using the specified parameters.
Constructs an unbounded instance of zio.elasticsearch.query.RangeQuery using the specified parameters.
Value parameters
- field
-
the field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.RangeQuery that represents the range query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.RegexpQuery using the specified parameters. zio.elasticsearch.query.RegexpQuery returns documents that contain terms matching a regular expression.
Constructs a type-safe instance of zio.elasticsearch.query.RegexpQuery using the specified parameters. zio.elasticsearch.query.RegexpQuery returns documents that contain terms matching a regular expression.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
regular expression that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.RegexpQuery that represents the regexp query to be performed.
Constructs an instance of zio.elasticsearch.query.RegexpQuery using the specified parameters. zio.elasticsearch.query.RegexpQuery returns documents that contain terms matching a regular expression.
Constructs an instance of zio.elasticsearch.query.RegexpQuery using the specified parameters. zio.elasticsearch.query.RegexpQuery returns documents that contain terms matching a regular expression.
Value parameters
- field
-
the field for which query is specified for
- value
-
regular expression that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.RegexpQuery that represents the regexp query to be performed.
Constructs an instance of zio.elasticsearch.query.ScriptQuery with the provided script.
Constructs an instance of zio.elasticsearch.query.ScriptQuery with the provided script.
Value parameters
- script
-
the script that is used by the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.ScriptQuery that represents the script query to be performed.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that should satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that should satisfy the criteria using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schemainstance must be in scope
Value parameters
- queries
-
a list of queries to add to
shouldinside of theBoolquery
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that should satisfy the criteria.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that should satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that should satisfy the criteria using the specified parameters.
Value parameters
- queries
-
a list of queries to add to
shouldinside of theBoolquery
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that should satisfy the criteria.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that starts with the specified value in the specified field.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that starts with the specified value in the specified field.
Type parameters
- S
-
document for which field query is executed in the pattern that represents
startsWith
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that starts with the specified value in the specified field.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that starts with the specified value in the specified field.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query in the pattern that represents
startsWith
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.TermQuery using the specified parameters. zio.elasticsearch.query.TermQuery is used for matching documents that contain an exact term in a provided field.
Constructs a type-safe instance of zio.elasticsearch.query.TermQuery using the specified parameters. zio.elasticsearch.query.TermQuery is used for matching documents that contain an exact term in a provided field.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermQuery that represents the term query to be performed.
Constructs an instance of zio.elasticsearch.query.TermQuery using the specified parameters. zio.elasticsearch.query.TermQuery is used for matching documents that contain an exact term in a provided field.
Constructs an instance of zio.elasticsearch.query.TermQuery using the specified parameters. zio.elasticsearch.query.TermQuery is used for matching documents that contain an exact term in a provided field.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermQuery that represents the term query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.TermsQuery using the specified parameters. zio.elasticsearch.query.TermsQuery is used for matching documents that contain one or more term in a provided field. The terms query is the same as zio.elasticsearch.query.TermQuery, except you can search for multiple values.
Constructs a type-safe instance of zio.elasticsearch.query.TermsQuery using the specified parameters. zio.elasticsearch.query.TermsQuery is used for matching documents that contain one or more term in a provided field. The terms query is the same as zio.elasticsearch.query.TermQuery, except you can search for multiple values.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- values
-
a list of terms that should be find in the provided field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermsQuery that represents the terms query to be performed.
Constructs an instance of zio.elasticsearch.query.TermsQuery using the specified parameters. zio.elasticsearch.query.TermsQuery is used for matching documents that contain one or more term in a provided field. The terms query is the same as zio.elasticsearch.query.TermQuery, except you can search for multiple values.
Constructs an instance of zio.elasticsearch.query.TermsQuery using the specified parameters. zio.elasticsearch.query.TermsQuery is used for matching documents that contain one or more term in a provided field. The terms query is the same as zio.elasticsearch.query.TermQuery, except you can search for multiple values.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
Value parameters
- field
-
the field for which query is specified for
- values
-
a list of terms that should be find in the provided field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermsQuery that represents the terms query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters. zio.elasticsearch.query.TermsSetQuery is used for matching documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as zio.elasticsearch.query.TermsQuery, except you can define the number of matching terms required to return a document.
Constructs a type-safe instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters. zio.elasticsearch.query.TermsSetQuery is used for matching documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as zio.elasticsearch.query.TermsQuery, except you can define the number of matching terms required to return a document.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- minimumShouldMatchField
-
the type-safe field representing the number of matching terms required to return a document
- terms
-
a list of terms that should be find in the provided field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermsSetQuery that represents the terms set query to be performed.
Constructs an instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters. zio.elasticsearch.query.TermsSetQuery is used for matching documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as zio.elasticsearch.query.TermsQuery, except you can define the number of matching terms required to return a document.
Constructs an instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters. zio.elasticsearch.query.TermsSetQuery is used for matching documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as zio.elasticsearch.query.TermsQuery, except you can define the number of matching terms required to return a document.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
Value parameters
- field
-
the field for which query is specified for
- minimumShouldMatchField
-
the number of matching terms required to return a document
- terms
-
a list of terms that should be find in the provided field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermsSetQuery that represents the terms set query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters. zio.elasticsearch.query.TermsSetQuery is used for matching documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as zio.elasticsearch.query.TermsQuery, except you can define the number of matching terms required to return a document.
Constructs a type-safe instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters. zio.elasticsearch.query.TermsSetQuery is used for matching documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as zio.elasticsearch.query.TermsQuery, except you can define the number of matching terms required to return a document.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- minimumShouldMatchScript
-
custom script containing the number of matching terms required to return a document
- terms
-
a list of terms that should be find in the provided field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermsSetQuery that represents the terms set query to be performed.
Constructs an instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters. zio.elasticsearch.query.TermsSetQuery is used for matching documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as zio.elasticsearch.query.TermsQuery, except you can define the number of matching terms required to return a document.
Constructs an instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters. zio.elasticsearch.query.TermsSetQuery is used for matching documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as zio.elasticsearch.query.TermsQuery, except you can define the number of matching terms required to return a document.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be provided in the scope for this type
Value parameters
- field
-
the field for which query is specified for
- minimumShouldMatchScript
-
custom script containing the number of matching terms required to return a document
- terms
-
a list of terms that should be find in the provided field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermsSetQuery that represents the terms set query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that matches a provided pattern value.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that matches a provided pattern value.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that matches a provided pattern value.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that matches a provided pattern value.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.