HasChildQuery

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

Attributes

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

Members list

Value members

Abstract methods

def maxChildren(value: Int): HasChildQuery[S]

Sets the maxChildren parameter for the HasChildQuery. Indicates maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.

Sets the maxChildren parameter for the HasChildQuery. Indicates maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.

Value parameters

value

the scala.Int value for maxChildren parameter

Attributes

Returns

an instance of HasChildQuery enriched with the maxChildren parameter.

def minChildren(value: Int): HasChildQuery[S]

Sets the minChildren parameter for the HasChildQuery. Indicates minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.

Sets the minChildren parameter for the HasChildQuery. Indicates minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.

Value parameters

value

the whole number value for minChildren parameter

Attributes

Returns

an instance of HasChildQuery enriched with the minChildren parameter.

Inherited methods

Sets the ignoreUnmapped parameter to false for this zio.elasticsearch.query.ElasticQuery. Same as ignoreUnmapped(false).

Sets the ignoreUnmapped parameter to false for this zio.elasticsearch.query.ElasticQuery. Same as ignoreUnmapped(false).

Attributes

Returns

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

See also

#ignoreUnmapped

Inherited from:
HasIgnoreUnmapped (hidden)

Sets the ignoreUnmapped parameter to true for this zio.elasticsearch.query.ElasticQuery. Same as ignoreUnmapped(true).

Sets the ignoreUnmapped parameter to true for this zio.elasticsearch.query.ElasticQuery. Same as ignoreUnmapped(true).

Attributes

Returns

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

See also

#ignoreUnmapped

Inherited from:
HasIgnoreUnmapped (hidden)
final def innerHits: HasChildQuery[S]

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

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

Attributes

Returns

a new instance of the zio.elasticsearch.query.ElasticQuery with the default inner hits.

Inherited from:
HasInnerHits (hidden)

Inherited and Abstract methods

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.

Value parameters

value

the boolean value for ignoreUnmapped parameter

Attributes

Returns

a new instance of the zio.elasticsearch.query.ElasticQuery with the ignoreUnmapped value set.

Inherited from:
HasIgnoreUnmapped (hidden)
def innerHits(innerHits: InnerHits): HasChildQuery[S]

Sets the inner hits configuration for the zio.elasticsearch.query.NestedQuery.

Sets the inner hits configuration for the zio.elasticsearch.query.NestedQuery.

Value parameters

innerHits

the configuration for inner hits

Attributes

Returns

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

Inherited from:
HasInnerHits (hidden)
def scoreMode(scoreMode: ScoreMode): HasChildQuery[S]

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

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

Value parameters

scoreMode

the ScoreMode to use for the zio.elasticsearch.query.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

Attributes

Returns

a new instance of the zio.elasticsearch.query.ElasticQuery with the specified zio.elasticsearch.query.ScoreMode.

Inherited from:
HasScoreMode (hidden)