object ElasticQuery
- Alphabetic
- By Inheritance
- ElasticQuery
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def boosting(negativeBoost: Float, negativeQuery: ElasticQuery[Any], positiveQuery: ElasticQuery[Any]): BoostingQuery[Any]
Constructs an instance of zio.elasticsearch.query.BoostingQuery with queries that must satisfy the criteria using the specified parameters.
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.
- 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
- returns
an instance of zio.elasticsearch.query.BoostingQuery that represents the boost query to be performed.
- final def boosting[S](negativeBoost: Float, negativeQuery: ElasticQuery[S], positiveQuery: ElasticQuery[S])(implicit arg0: Schema[S]): BoostingQuery[S]
Constructs an instance of zio.elasticsearch.query.BoostingQuery with queries that must satisfy the criteria using the specified parameters.
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.
- S
document for which field query is executed. An implicit
Schemainstance must be in scope- 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
- returns
an instance of zio.elasticsearch.query.BoostingQuery that represents the boost query to be performed.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def constantScore(query: ElasticQuery[Any]): ConstantScoreQuery[Any]
Constructs an instance of zio.elasticsearch.query.ConstantScoreQuery with a specified query.
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.
- query
query to be wrapped inside of constant score query
- returns
an instance of zio.elasticsearch.query.ConstantScoreQuery that represents the constant score query with query that must satisfy the criteria to be performed.
- final def constantScore[S](query: ElasticQuery[S])(implicit arg0: Schema[S]): ConstantScoreQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.ConstantScoreQuery with a specified query.
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.
- S
document for which field query is specified for. An implicit
Schemainstance must be provided in the scope- query
query to be wrapped inside of constant score query
- returns
an instance of zio.elasticsearch.query.ConstantScoreQuery that represents the constant score query with query that must satisfy the criteria to be performed.
- final def contains(field: String, value: String): WildcardQuery[Any]
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters.
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.
- 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- returns
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
- final def contains[S](field: Field[S, String], value: String): WildcardQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters.
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.
- S
document for which field query is executed
- 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- returns
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
- final def disjunctionMax(query: ElasticQuery[Any], queries: ElasticQuery[Any]*): DisjunctionMaxQuery[Any]
Constructs an instance of zio.elasticsearch.query.DisjunctionMax using the specified parameters.
Constructs an instance of zio.elasticsearch.query.DisjunctionMax using the specified parameters.
- queries
the rest of the queries to be wrapped inside of disjunction max query
- returns
an instance of zio.elasticsearch.query.DisjunctionMax that represents the
disjunction maxquery to be performed.
- final def disjunctionMax[S](query: ElasticQuery[S], queries: ElasticQuery[S]*)(implicit arg0: Schema[S]): DisjunctionMaxQuery[S]
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.
- S
document for which field query is executed. An implicit
Schemainstance must be in scope- queries
the rest of the queries to be wrapped inside of disjunction max query
- returns
an instance of zio.elasticsearch.query.DisjunctionMax that represents the
disjunction maxquery to be performed.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def exists(field: String): ExistsQuery[Any]
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.
- field
the field for which query is specified for
- returns
an instance of zio.elasticsearch.query.ExistsQuery that represents the exists query to be performed.
- final def exists[S](field: Field[S, _]): ExistsQuery[S]
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.
- S
document for which field query is executed
- field
the type-safe field for which query is specified for
- returns
an instance of zio.elasticsearch.query.ExistsQuery that represents the exists query to be performed.
- final def filter(queries: ElasticQuery[Any]*): BoolQuery[Any]
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.
- queries
a list of queries to add to
filterinside of theBoolquery- returns
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
- final def filter[S](queries: ElasticQuery[S]*)(implicit arg0: Schema[S]): BoolQuery[S]
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.
- S
document for which field query is executed. An implicit
Schemainstance must be in scope- queries
a list of queries to add to
filterinside of theBoolquery- returns
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
- final def functionScore(functions: FunctionScoreFunction[Any]*): FunctionScoreQuery[Any]
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.
- functions
zio.elasticsearch.query.FunctionScoreFunction functions that will be part of zio.elasticsearch.query.FunctionScore query
- returns
an instance of zio.elasticsearch.query.FunctionScore that represents the Function Score Query with functions that are used to calculate score for result.
- final def functionScore[S](functions: FunctionScoreFunction[S]*)(implicit arg0: Schema[S]): FunctionScoreQuery[S]
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.
- functions
zio.elasticsearch.query.FunctionScoreFunction functions that will be part of zio.elasticsearch.query.FunctionScore query
- returns
an instance of zio.elasticsearch.query.FunctionScore that represents the Function Score Query with functions that are used to calculate score for result.
- final def fuzzy(field: String, value: String): FuzzyQuery[Any]
Constructs an instance of zio.elasticsearch.query.FuzzyQuery using the specified parameters.
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.
- field
the field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.FuzzyQuery that represents the
fuzzyquery to be performed.
- final def fuzzy[S](field: Field[S, String], value: String): FuzzyQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.FuzzyQuery using the specified parameters.
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.
- S
document for which field query is executed
- field
the type-safe field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.FuzzyQuery that represents the
fuzzyquery to be performed.
- final def geoDistance(field: String, point: GeoHash, distance: Distance): GeoDistanceQuery[Any]
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
- field
the field for which the query is specified
- point
the geo-point from which the distance should be measured, defined as geo-hash
- distance
the distance within which values should be matched
- returns
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distancequery to be performed.
- final def geoDistance[S](field: Field[S, GeoPoint], point: GeoHash, distance: Distance): GeoDistanceQuery[S]
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.
- S
the type of document on which the query is defined
- 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
- distance
the distance within which values should be matched
- returns
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distancequery to be performed.
- final def geoDistance(field: String, point: GeoPoint, distance: Distance): GeoDistanceQuery[Any]
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
- field
the field for which the query is specified
- point
the geo-point from which the distance should be measured
- distance
the distance within which values should be matched
- returns
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distancequery to be performed.
- final def geoDistance[S](field: Field[S, GeoPoint], point: GeoPoint, distance: Distance): GeoDistanceQuery[S]
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.
- S
the type of document on which the query is defined
- field
the type-safe GeoPoint field for which the query is specified
- point
the geo-point from which the distance should be measured
- distance
the distance within which values should be matched
- returns
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distancequery to be performed.
- final def geoPolygon(field: String, coordinates: Chunk[String]): GeoPolygonQuery[Any]
Constructs an instance of zio.elasticsearch.query.GeoPolygonQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.GeoPolygonQuery using the specified parameters.
- field
the field for which query is specified for
- 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"])
- returns
an instance of zio.elasticsearch.query.GeoPolygonQuery that represents
geo_polygonquery to be performed.
- final def geoPolygon[S](field: Field[S, _], coordinates: Chunk[String]): GeoPolygonQuery[S]
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.
- S
document for which field query is executed
- field
the type-safe field for which query is specified for
- 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"])
- returns
an instance of zio.elasticsearch.query.GeoPolygonQuery that represents
geo_polygonquery to be performed.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def hasChild(childType: String, query: ElasticQuery[Any]): HasChildQuery[Any]
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified 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- returns
an instance of zio.elasticsearch.query.HasChildQuery that represents the
has child queryto be performed.
- final def hasChild[S](childType: String, query: ElasticQuery[S])(implicit arg0: Schema[S]): HasChildQuery[S]
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
- S
document for which field query is executed
- 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- returns
an instance of zio.elasticsearch.query.HasChildQuery that represents the
has child queryto be performed.
- final def hasParent(parentType: String, query: ElasticQuery[Any]): HasParentQuery[Any]
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified 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- returns
an instance of zio.elasticsearch.query.HasParentQuery that represents the has parent query to be performed.
- final def hasParent[S](parentType: String, query: ElasticQuery[S])(implicit arg0: Schema[S]): HasParentQuery[S]
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
- S
document for which field query is executed
- 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- returns
an instance of zio.elasticsearch.query.HasParentQuery that represents the has parent query to be performed.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def ids(value: String, values: String*): IdsQuery[Any]
Constructs an instance of zio.elasticsearch.query.IdsQuery using the specified parameters.
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
value that will be used for the query
- values
array of optional values that will be used for the query
- returns
an instance of zio.elasticsearch.query.IdsQuery that represents the ids query to be performed.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def kNN(field: String, k: Int, numCandidates: Int, queryVector: Chunk[Double]): KNNQuery[Any]
Constructs an instance of zio.elasticsearch.query.KNNQuery using the specified parameters.
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.
- 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
- returns
an instance of zio.elasticsearch.query.KNNQuery that represents the kNN query to be performed.
- final def kNN[S](field: Field[S, _], k: Int, numCandidates: Int, queryVector: Chunk[Double]): KNNQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.KNNQuery using the specified parameters.
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.
- S
document for which field query is executed
- 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
- returns
an instance of zio.elasticsearch.query.KNNQuery that represents the kNN query to be performed.
- final def matchAll: MatchAllQuery
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.
- returns
an instance of zio.elasticsearch.query.MatchAllQuery that represents the match all query to be performed.
- final def matchBooleanPrefix[A](field: String, value: A)(implicit arg0: ElasticPrimitive[A]): MatchBooleanPrefixQuery[Any]
Constructs an instance of zio.elasticsearch.query.MatchBooleanPrefixQuery using the specified parameters.
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.
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- field
the field for which query is specified for
- value
the value to be matched, represented by an instance of type
A- returns
an instance of zio.elasticsearch.query.MatchBooleanPrefixQuery that represents the match boolean prefix query to be performed.
- final def matchBooleanPrefix[S, A](field: Field[S, A], value: A)(implicit arg0: ElasticPrimitive[A]): MatchBooleanPrefixQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.MatchBooleanPrefixQuery using the specified parameters.
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.
- S
document for which field query is executed
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- field
the type-safe field for which query is specified for
- value
the value to be matched, represented by an instance of type
A- returns
an instance of zio.elasticsearch.query.MatchBooleanPrefixQuery that represents the match boolean prefix query to be performed.
- final def matchPhrase(field: String, value: String): MatchPhraseQuery[Any]
Constructs an instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters.
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.
- field
the type-safe field for which query is specified for
- value
the value to be matched, represented by an instance of type
A- returns
an instance of zio.elasticsearch.query.MatchPhraseQuery that represents the match phrase query to be performed.
- final def matchPhrase[S](field: Field[S, String], value: String): MatchPhraseQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters.
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.
- S
document for which field query is executed
- field
the field for which query is specified for
- value
the value to be matched, represented by an instance of type
A- returns
an instance of zio.elasticsearch.query.MatchPhraseQuery that represents the match phrase query to be performed.
- final def matchPhrasePrefix(field: String, value: String): MatchPhrasePrefixQuery[Any]
Constructs an instance of zio.elasticsearch.query.MatchPhrasePrefixQuery using the specified parameters.
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.
- field
the field for which query is specified for
- value
the text value to be matched
- returns
an instance of zio.elasticsearch.query.MatchPhrasePrefixQuery that represents the match phrase prefix query to be performed.
- final def matchPhrasePrefix[S](field: Field[S, String], value: String): MatchPhrasePrefixQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.MatchPhrasePrefixQuery using the specified parameters.
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.
- S
document for which field query is executed
- field
the type-safe field for which query is specified for
- value
the text value to be matched
- returns
an instance of zio.elasticsearch.query.MatchPhrasePrefixQuery that represents the match phrase prefix query to be performed.
- final def matches[A](field: String, value: A)(implicit arg0: ElasticPrimitive[A]): MatchQuery[Any]
Constructs an instance of zio.elasticsearch.query.MatchQuery using the specified parameters.
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.
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- field
the field for which query is specified for
- value
the value to be matched, represented by an instance of type
A- returns
an instance of zio.elasticsearch.query.MatchQuery that represents the match query to be performed.
- final def matches[S, A](field: Field[S, A], value: A)(implicit arg0: ElasticPrimitive[A]): MatchQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.MatchQuery using the specified parameters.
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.
- S
document for which field query is executed
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- field
the type-safe field for which query is specified for
- value
the value to be matched, represented by an instance of type
A- returns
an instance of zio.elasticsearch.query.MatchQuery that represents the match query to be performed.
- final def multiMatch(value: String): MultiMatchQuery[Any]
Constructs an instance of zio.elasticsearch.query.MultiMatchQuery using the specified parameter.
Constructs an instance of zio.elasticsearch.query.MultiMatchQuery using the specified parameter. zio.elasticsearch.query.MultiMatchQuery query builds on the
matchquery to allow multi-field queries.- value
the text value to be matched
- returns
an instance of zio.elasticsearch.query.MultiMatchQuery that represents the multi match query to be performed.
- final def must(queries: ElasticQuery[Any]*): BoolQuery[Any]
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.
- queries
a list of queries to add to
mustinside of theBoolquery- returns
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
- final def must[S](queries: ElasticQuery[S]*)(implicit arg0: Schema[S]): BoolQuery[S]
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.
- S
document for which field query is executed. An implicit
Schemainstance must be in scope- queries
a list of queries to add to
mustinside of theBoolquery- returns
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
- final def mustNot(queries: ElasticQuery[Any]*): BoolQuery[Any]
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.
- queries
a list of queries to add to
mustNotinside of theBoolquery- returns
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must not satisfy the criteria.
- final def mustNot[S](queries: ElasticQuery[S]*)(implicit arg0: Schema[S]): BoolQuery[S]
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.
- S
document for which field query is executed. An implicit
Schemainstance must be in scope- queries
a list of queries to add to
mustNotinside of theBoolquery- returns
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must not satisfy the criteria.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def nested(path: String, query: ElasticQuery[_]): NestedQuery[Any]
Constructs an instance of zio.elasticsearch.query.NestedQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
- 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.
- returns
an instance of zio.elasticsearch.query.NestedQuery that represents the nested query to be performed.
- final def nested[S, A](path: Field[S, Seq[A]], query: ElasticQuery[A]): NestedQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.NestedQuery using the specified parameters.
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.
- S
document for which field query is executed
- A
the type of the value that will be used for the query
- 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.
- returns
an instance of zio.elasticsearch.query.NestedQuery that represents the nested query to be performed.
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def prefix(field: String, value: String): Prefix[Any]
Constructs an instance of zio.elasticsearch.query.PrefixQuery using the specified parameters.
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.
- field
the field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.PrefixQuery that represents the prefix query to be performed.
- final def prefix[S](field: Field[S, String], value: String): PrefixQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.PrefixQuery using the specified parameters.
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.
- S
document for which field query is executed
- field
the type-safe field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.PrefixQuery that represents the prefix query to be performed.
- final def range(field: String): RangeQuery[Any, Any, Unbounded.type, Unbounded.type]
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.
- field
the field for which query is specified for
- returns
an instance of zio.elasticsearch.query.RangeQuery that represents the range query to be performed.
- final def range[S, A](field: Field[S, A]): RangeQuery[S, A, Unbounded.type, Unbounded.type]
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.
- S
document for which field query is executed
- A
the type of the value that will be used for the query
- field
the type-safe field for which query is specified for
- returns
an instance of zio.elasticsearch.query.RangeQuery that represents the range query to be performed.
- final def regexp(field: String, value: String): RegexpQuery[Any]
Constructs an instance of zio.elasticsearch.query.RegexpQuery using the specified parameters.
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.
- field
the field for which query is specified for
- value
regular expression that will be used for the query
- returns
an instance of zio.elasticsearch.query.RegexpQuery that represents the regexp query to be performed.
- final def regexp[S](field: Field[S, String], value: String): RegexpQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.RegexpQuery using the specified parameters.
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.
- S
document for which field query is executed
- field
the type-safe field for which query is specified for
- value
regular expression that will be used for the query
- returns
an instance of zio.elasticsearch.query.RegexpQuery that represents the regexp query to be performed.
- final def script(script: Script): ScriptQuery
Constructs an instance of zio.elasticsearch.query.ScriptQuery with the provided script.
Constructs an instance of zio.elasticsearch.query.ScriptQuery with the provided script.
- script
the script that is used by the query
- returns
an instance of zio.elasticsearch.query.ScriptQuery that represents the script query to be performed.
- final def should(queries: ElasticQuery[Any]*): BoolQuery[Any]
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.
- queries
a list of queries to add to
shouldinside of theBoolquery- returns
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that should satisfy the criteria.
- final def should[S](queries: ElasticQuery[S]*)(implicit arg0: Schema[S]): BoolQuery[S]
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.
- S
document for which field query is executed. An implicit
Schemainstance must be in scope- queries
a list of queries to add to
shouldinside of theBoolquery- returns
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that should satisfy the criteria.
- final def startsWith(field: String, value: String): WildcardQuery[Any]
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters.
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.
- 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- returns
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
- final def startsWith[S](field: Field[S, String], value: String): WildcardQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters.
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.
- S
document for which field query is executed in the pattern that represents
startsWith- field
the type-safe field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def term[A](field: String, value: A)(implicit arg0: ElasticPrimitive[A]): TermQuery[Any]
Constructs an instance of zio.elasticsearch.query.TermQuery using the specified parameters.
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.
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- field
the field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.TermQuery that represents the term query to be performed.
- final def term[S, A](field: Field[S, A], value: A)(implicit arg0: ElasticPrimitive[A]): TermQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.TermQuery using the specified parameters.
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.
- S
document for which field query is executed
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- field
the type-safe field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.TermQuery that represents the term query to be performed.
- final def terms[A](field: String, values: A*)(implicit arg0: ElasticPrimitive[A]): TermsQuery[Any]
Constructs an instance of zio.elasticsearch.query.TermsQuery using the specified parameters.
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.
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- field
the field for which query is specified for
- values
a list of terms that should be find in the provided field
- returns
an instance of zio.elasticsearch.query.TermsQuery that represents the terms query to be performed.
- final def terms[S, A](field: Field[S, A], values: A*)(implicit arg0: ElasticPrimitive[A]): TermsQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.TermsQuery using the specified parameters.
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.
- S
document for which field query is executed
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- field
the type-safe field for which query is specified for
- values
a list of terms that should be find in the provided field
- returns
an instance of zio.elasticsearch.query.TermsQuery that represents the terms query to be performed.
- final def termsSet[A](field: String, minimumShouldMatchField: String, terms: A*)(implicit arg0: ElasticPrimitive[A]): TermsSetQuery[Any]
Constructs an instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters.
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.
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- 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
- returns
an instance of zio.elasticsearch.query.TermsSetQuery that represents the terms set query to be performed.
- final def termsSet[S, A](field: Field[S, A], minimumShouldMatchField: Field[S, _], terms: A*)(implicit arg0: ElasticPrimitive[A]): TermsSetQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters.
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.
- S
document for which field query is executed
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- 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
- returns
an instance of zio.elasticsearch.query.TermsSetQuery that represents the terms set query to be performed.
- final def termsSetScript[A](field: String, minimumShouldMatchScript: Script, terms: A*)(implicit arg0: ElasticPrimitive[A]): TermsSetQuery[Any]
Constructs an instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters.
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.
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- 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
- returns
an instance of zio.elasticsearch.query.TermsSetQuery that represents the terms set query to be performed.
- final def termsSetScript[S, A](field: Field[S, A], minimumShouldMatchScript: Script, terms: A*)(implicit arg0: ElasticPrimitive[A]): TermsSetQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.TermsSetQuery using the specified parameters.
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.
- S
document for which field query is executed
- A
the type of value to be matched. A JSON decoder must be provided in the scope for this type
- 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
- returns
an instance of zio.elasticsearch.query.TermsSetQuery that represents the terms set query to be performed.
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wildcard(field: String, value: String): WildcardQuery[Any]
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters.
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.
- field
the field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
- final def wildcard[S](field: Field[S, String], value: String): WildcardQuery[S]
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters.
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.
- S
document for which field query is executed
- field
the type-safe field for which query is specified for
- value
text value that will be used for the query
- returns
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.