NestedQuery

zio.elasticsearch.query.NestedQuery
sealed trait NestedQuery[S] extends ElasticQuery[S]

Attributes

Graph
Supertypes
trait ElasticQuery[S]
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Inherited methods

def ignoreUnmapped(value: Boolean): Q

Sets the ignoreUnmapped parameter to control whether to ignore unmapped fields and return empty hits.

Sets the ignoreUnmapped parameter to control whether to ignore unmapped fields and return empty hits.

Attributes

value

the boolean value for ignoreUnmapped parameter

Returns:

a new instance of the ElasticQuery with the ignoreUnmapped value set.

Inherited from:
HasIgnoreUnmapped (hidden)
final def ignoreUnmappedFalse: Q

Sets the ignoreUnmapped parameter to false for this ElasticQuery. Same as ignoreUnmapped.

Sets the ignoreUnmapped parameter to false for this ElasticQuery. Same as ignoreUnmapped.

Attributes

Returns:

a new instance of the ElasticQuery with the ignoreUnmapped value set to false.

Inherited from:
HasIgnoreUnmapped (hidden)
final def ignoreUnmappedTrue: Q

Sets the ignoreUnmapped parameter to true for this ElasticQuery. Same as ignoreUnmapped.

Sets the ignoreUnmapped parameter to true for this ElasticQuery. Same as ignoreUnmapped.

Attributes

Returns:

a new instance of the ElasticQuery with the ignoreUnmapped value set to true.

Inherited from:
HasIgnoreUnmapped (hidden)
def innerHits(innerHits: InnerHits): Q

Sets the inner hits configuration for the NestedQuery.

Sets the inner hits configuration for the NestedQuery.

Attributes

innerHits

the configuration for inner hits

Returns:

a new instance of the ElasticQuery with the specified inner hits configuration.

Inherited from:
HasInnerHits (hidden)
final def innerHits: Q

Sets the inner hits for this ElasticQuery to the default InnerHits() value.

Sets the inner hits for this ElasticQuery to the default InnerHits() value.

Attributes

Returns:

a new instance of the ElasticQuery with the default inner hits.

Inherited from:
HasInnerHits (hidden)
def paramsToJson(fieldPath: Option[String]): Json

Attributes

Inherited from:
ElasticQuery
def scoreMode(scoreMode: ScoreMode): Q

Sets the ScoreMode for the NestedQuery. The ScoreMode specifies how scores of matching documents are combined for the NestedQuery.

Sets the ScoreMode for the NestedQuery. The ScoreMode specifies how scores of matching documents are combined for the NestedQuery.

Attributes

scoreMode

the ScoreMode to use for the NestedQuery

  • ScoreMode.Avg: uses the mean relevance score of all matching child objects
  • ScoreMode.Max: uses the highest relevance score of all matching child objects
  • ScoreMode.Min: uses the lowest relevance score of all matching child objects
  • ScoreMode.None: ignores relevance scores of matching child objects and uses 0 as a score
  • ScoreMode.Sum: adds together the relevance scores of all matching child objects
Returns:

a new instance of the ElasticQuery with the specified ScoreMode.

Inherited from:
HasScoreMode (hidden)
final def toJson: Obj

Attributes

Inherited from:
ElasticQuery