Class SlicedScroll.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.SlicedScroll.Builder
- All Implemented Interfaces:
CopyableBuilder<SlicedScroll.Builder,,SlicedScroll> MutableBuilder<SlicedScroll.Builder,,SlicedScroll> ObjectBuilder<SlicedScroll>
- Enclosing class:
SlicedScroll
public static class SlicedScroll.Builder
extends ObjectBuilderBase
implements CopyableBuilder<SlicedScroll.Builder,SlicedScroll>
Builder for
SlicedScroll.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aSlicedScroll.copy()Create a new builderCopyableBuilderthat is a copy of this one.final SlicedScroll.BuilderThe field to slice on.final SlicedScroll.Builderid(int value) Required - The ID of the slice.final SlicedScroll.Buildermax(int value) Required - The maximum number of slices.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<SlicedScroll.Builder,SlicedScroll> - Returns:
- a new builder instance.
-
field
The field to slice on.API name:
field -
id
Required - The ID of the slice.API name:
id -
max
Required - The maximum number of slices.API name:
max -
build
Builds aSlicedScroll.- Specified by:
buildin interfaceObjectBuilder<SlicedScroll>- Throws:
NullPointerException- if some of the required fields are null.
-