Package org.opensearch.client.opensearch._types

Class ScriptSort.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.ScriptSort.Builder

All Implemented Interfaces:

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

Enclosing class:

ScriptSort

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

Builder for ScriptSort.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ScriptSort	build()	Builds a ScriptSort.
ScriptSort.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ScriptSort.Builder	mode(SortMode value)	The mode for sorting on array or multi-valued fields.
final ScriptSort.Builder	nested(Function<NestedSortValue.Builder,ObjectBuilder<NestedSortValue>> fn)	The nested path and filter for nested sorting.
final ScriptSort.Builder	nested(NestedSortValue value)	The nested path and filter for nested sorting.
final ScriptSort.Builder	order(SortOrder value)	API name: order
final ScriptSort.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	Required - The script to use for sorting.
final ScriptSort.Builder	script(Script value)	Required - The script to use for sorting.
final ScriptSort.Builder	type(ScriptSortType value)	The type of the script sort value.

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

Returns:

a new builder instance.

mode

@Nonnull
public final ScriptSort.Builder mode(@Nullable
 SortMode value)

The mode for sorting on array or multi-valued fields.

API name: mode

nested

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

The nested path and filter for nested sorting.

API name: nested

nested

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

The nested path and filter for nested sorting.

API name: nested

order

@Nonnull
public final ScriptSort.Builder order(@Nullable
 SortOrder value)

API name: order

script

@Nonnull
public final ScriptSort.Builder script(Script value)

Required - The script to use for sorting.

API name: script

script

@Nonnull
public final ScriptSort.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

Required - The script to use for sorting.

API name: script

type

@Nonnull
public final ScriptSort.Builder type(@Nullable
 ScriptSortType value)

The type of the script sort value.

API name: type

build

@Nonnull
public ScriptSort build()

Builds a ScriptSort.

Specified by:

build in interface ObjectBuilder<ScriptSort>

Throws:

NullPointerException - if some of the required fields are null.