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

Class NestedQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.NestedQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

NestedQuery

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

Builder for NestedQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NestedQuery	build()	Builds a NestedQuery.
NestedQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NestedQuery.Builder	ignoreUnmapped(Boolean value)	Indicates whether to ignore an unmapped path and not return any documents instead of an error.
final NestedQuery.Builder	innerHits(Function<InnerHits.Builder,ObjectBuilder<InnerHits>> fn)	API name: inner_hits
final NestedQuery.Builder	innerHits(InnerHits value)	API name: inner_hits
final NestedQuery.Builder	path(String value)	Required - API name: path
final NestedQuery.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	Required - API name: query
final NestedQuery.Builder	query(Query value)	Required - API name: query
final NestedQuery.Builder	scoreMode(ChildScoreMode value)	API name: score_mode
protected NestedQuery.Builder	self()

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 NestedQuery.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<NestedQuery.Builder,NestedQuery>

Returns:

a new builder instance.

self

@Nonnull
protected NestedQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<NestedQuery.Builder>

ignoreUnmapped

@Nonnull
public final NestedQuery.Builder ignoreUnmapped(@Nullable
 Boolean value)

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

API name: ignore_unmapped

innerHits

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

API name: inner_hits

innerHits

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

API name: inner_hits

path

@Nonnull
public final NestedQuery.Builder path(String value)

Required - API name: path

query

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

Required - API name: query

query

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

Required - API name: query

scoreMode

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

API name: score_mode

build

@Nonnull
public NestedQuery build()

Builds a NestedQuery.

Specified by:

build in interface ObjectBuilder<NestedQuery>

Throws:

NullPointerException - if some of the required fields are null.