Package co.elastic.clients.elasticsearch._types.query_dsl

Class HasChildQuery.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder<HasChildQuery.Builder>

co.elastic.clients.elasticsearch._types.query_dsl.HasChildQuery.Builder

All Implemented Interfaces:

WithJson<HasChildQuery.Builder>, ObjectBuilder<HasChildQuery>

Enclosing class:

HasChildQuery

public static class HasChildQuery.Builder
extends QueryBase.AbstractBuilder<HasChildQuery.Builder>
implements ObjectBuilder<HasChildQuery>

Builder for HasChildQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HasChildQuery	build()	Builds a HasChildQuery.
final HasChildQuery.Builder	ignoreUnmapped(Boolean value)	Indicates whether to ignore an unmapped type and not return any documents instead of an error.
final HasChildQuery.Builder	innerHits(InnerHits value)	If defined, each search hit will contain inner hits.
final HasChildQuery.Builder	innerHits(Function<InnerHits.Builder,ObjectBuilder<InnerHits>> fn)	If defined, each search hit will contain inner hits.
final HasChildQuery.Builder	maxChildren(Integer value)	Maximum number of child documents that match the query allowed for a returned parent document.
final HasChildQuery.Builder	minChildren(Integer value)	Minimum number of child documents that match the query required to match the query for a returned parent document.
final HasChildQuery.Builder	query(Query value)	Required - Query you wish to run on child documents of the type field.
final HasChildQuery.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	Required - Query you wish to run on child documents of the type field.
final HasChildQuery.Builder	scoreMode(ChildScoreMode value)	Indicates how scores for matching child documents affect the root parent document’s relevance score.
protected HasChildQuery.Builder	self()
final HasChildQuery.Builder	type(String value)	Required - Name of the child relationship mapped for the join field.

Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

ignoreUnmapped

public final HasChildQuery.Builder ignoreUnmapped(@Nullable
 Boolean value)

Indicates whether to ignore an unmapped type and not return any documents instead of an error.

API name: ignore_unmapped

innerHits

public final HasChildQuery.Builder innerHits(@Nullable
 InnerHits value)

If defined, each search hit will contain inner hits.

API name: inner_hits

innerHits

public final HasChildQuery.Builder innerHits(Function<InnerHits.Builder,ObjectBuilder<InnerHits>> fn)

If defined, each search hit will contain inner hits.

API name: inner_hits

maxChildren

public final HasChildQuery.Builder maxChildren(@Nullable
 Integer value)

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.

API name: max_children

minChildren

public final HasChildQuery.Builder minChildren(@Nullable
 Integer value)

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.

API name: min_children

query

public final HasChildQuery.Builder query(Query value)

Required - Query you wish to run on child documents of the type field. If a child document matches the search, the query returns the parent document.

API name: query

query

public final HasChildQuery.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

Required - Query you wish to run on child documents of the type field. If a child document matches the search, the query returns the parent document.

API name: query

scoreMode

public final HasChildQuery.Builder scoreMode(@Nullable
 ChildScoreMode value)

Indicates how scores for matching child documents affect the root parent document’s relevance score.

API name: score_mode

type

public final HasChildQuery.Builder type(String value)

Required - Name of the child relationship mapped for the join field.

API name: type

self

protected HasChildQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<HasChildQuery.Builder>

build

public HasChildQuery build()

Builds a HasChildQuery.

Specified by:

build in interface ObjectBuilder<HasChildQuery>

Throws:

NullPointerException - if some of the required fields are null.