Class ScrollRequest.Builder
- java.lang.Object
-
- org.opensearch.client.util.ObjectBuilderBase
-
- org.opensearch.client.opensearch.core.ScrollRequest.Builder
-
- All Implemented Interfaces:
ObjectBuilder<ScrollRequest>
- Enclosing class:
- ScrollRequest
public static class ScrollRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<ScrollRequest>
Builder forScrollRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ScrollRequestbuild()Builds aScrollRequest.ScrollRequest.Builderscroll(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Period to retain the search context for scrolling.ScrollRequest.Builderscroll(Time value)Period to retain the search context for scrolling.ScrollRequest.BuilderscrollId(java.lang.String value)Required - Scroll ID of the search.-
Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
Method Detail
-
scroll
public final ScrollRequest.Builder scroll(@Nullable Time value)
Period to retain the search context for scrolling.API name:
scroll
-
scroll
public final ScrollRequest.Builder scroll(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to retain the search context for scrolling.API name:
scroll
-
scrollId
public final ScrollRequest.Builder scrollId(java.lang.String value)
Required - Scroll ID of the search.API name:
scroll_id
-
build
public ScrollRequest build()
Builds aScrollRequest.- Specified by:
buildin interfaceObjectBuilder<ScrollRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-