Package org.opensearch.client.opensearch._types.query_dsl

Class HasChildQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<HasChildQuery.Builder>

org.opensearch.client.opensearch._types.query_dsl.HasChildQuery.Builder

All Implemented Interfaces:

CopyableBuilder<HasChildQuery.Builder,HasChildQuery>, MutableBuilder<HasChildQuery.Builder,HasChildQuery>, ObjectBuilder<HasChildQuery>

Enclosing class:

HasChildQuery

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

Builder for HasChildQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HasChildQuery	build()	Builds a HasChildQuery.
HasChildQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
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(Function<InnerHits.Builder,ObjectBuilder<InnerHits>> fn)	API name: inner_hits
final HasChildQuery.Builder	innerHits(InnerHits value)	API name: 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(Function<Query.Builder,ObjectBuilder<Query>> fn)	Required - API name: query
final HasChildQuery.Builder	query(Query value)	Required - API name: query
final HasChildQuery.Builder	scoreMode(ChildScoreMode value)	API name: score_mode
protected HasChildQuery.Builder	self()
final HasChildQuery.Builder	type(String value)	Required - API name: type

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public HasChildQuery.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<HasChildQuery.Builder,HasChildQuery>

Returns:

a new builder instance.

self

@Nonnull
protected HasChildQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<HasChildQuery.Builder>

ignoreUnmapped

@Nonnull
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

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

API name: inner_hits

innerHits

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

API name: inner_hits

maxChildren

@Nonnull
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

@Nonnull
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

@Nonnull
public final HasChildQuery.Builder query(Query value)

Required - API name: query

query

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

Required - API name: query

scoreMode

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

API name: score_mode

type

@Nonnull
public final HasChildQuery.Builder type(String value)

Required - API name: type

build

@Nonnull
public HasChildQuery build()

Builds a HasChildQuery.

Specified by:

build in interface ObjectBuilder<HasChildQuery>

Throws:

NullPointerException - if some of the required fields are null.