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 for
ScrollRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aScrollRequest.final ScrollRequest.BuilderPeriod to retain the search context for scrolling.final ScrollRequest.BuilderPeriod to retain the search context for scrolling.final ScrollRequest.BuilderRequired - Scroll ID of the search.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
scroll
Period to retain the search context for scrolling.API name:
scroll -
scroll
Period to retain the search context for scrolling.API name:
scroll -
scrollId
Required - Scroll ID of the search.API name:
scroll_id -
build
Builds aScrollRequest.- Specified by:
buildin interfaceObjectBuilder<ScrollRequest>- Throws:
NullPointerException- if some of the required fields are null.
-