Package org.opensearch.client.opensearch._types

Class NestedSortValue.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.NestedSortValue.Builder

All Implemented Interfaces:

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

Enclosing class:

NestedSortValue

public static class NestedSortValue.Builder
extends ObjectBuilderBase
implements CopyableBuilder<NestedSortValue.Builder,NestedSortValue>

Builder for NestedSortValue.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NestedSortValue	build()	Builds a NestedSortValue.
NestedSortValue.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NestedSortValue.Builder	filter(Function<Query.Builder,ObjectBuilder<Query>> fn)	The filter to apply to nested objects.
final NestedSortValue.Builder	filter(Query value)	The filter to apply to nested objects.
final NestedSortValue.Builder	maxChildren(Integer value)	The maximum number of children to consider for sorting.
final NestedSortValue.Builder	nested(Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)	How to sort hierarchical nested objects.
final NestedSortValue.Builder	nested(NestedSortValue value)	How to sort hierarchical nested objects.
final NestedSortValue.Builder	path(String value)	Required - The path to the nested objects.

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

Returns:

a new builder instance.

filter

@Nonnull
public final NestedSortValue.Builder filter(@Nullable
 Query value)

The filter to apply to nested objects.

API name: filter

filter

@Nonnull
public final NestedSortValue.Builder filter(Function<Query.Builder,ObjectBuilder<Query>> fn)

The filter to apply to nested objects.

API name: filter

maxChildren

@Nonnull
public final NestedSortValue.Builder maxChildren(@Nullable
 Integer value)

The maximum number of children to consider for sorting.

API name: max_children

nested

@Nonnull
public final NestedSortValue.Builder nested(@Nullable
 NestedSortValue value)

How to sort hierarchical nested objects.

API name: nested

nested

@Nonnull
public final NestedSortValue.Builder nested(Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)

How to sort hierarchical nested objects.

API name: nested

path

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

Required - The path to the nested objects.

API name: path

build

@Nonnull
public NestedSortValue build()

Builds a NestedSortValue.

Specified by:

build in interface ObjectBuilder<NestedSortValue>

Throws:

NullPointerException - if some of the required fields are null.