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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aScriptSort.copy()Create a new builderCopyableBuilderthat is a copy of this one.final ScriptSort.BuilderThe mode for sorting on array or multi-valued fields.final ScriptSort.BuilderThe nested path and filter for nested sorting.final ScriptSort.Buildernested(NestedSortValue value) The nested path and filter for nested sorting.final ScriptSort.BuilderAPI name:orderfinal ScriptSort.BuilderRequired - The script to use for sorting.final ScriptSort.BuilderRequired - The script to use for sorting.final ScriptSort.Buildertype(ScriptSortType value) The type of the script sort value.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<ScriptSort.Builder,ScriptSort> - Returns:
- a new builder instance.
-
mode
The mode for sorting on array or multi-valued fields.API name:
mode -
nested
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
API name:order -
script
Required - The script to use for sorting.API name:
script -
script
Required - The script to use for sorting.API name:
script -
type
The type of the script sort value.API name:
type -
build
Builds aScriptSort.- Specified by:
buildin interfaceObjectBuilder<ScriptSort>- Throws:
NullPointerException- if some of the required fields are null.
-