Class ScrollRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<ScrollRequest.Builder>
co.elastic.clients.elasticsearch.core.ScrollRequest.Builder
- All Implemented Interfaces:
WithJson<ScrollRequest.Builder>
,ObjectBuilder<ScrollRequest>
- Enclosing class:
- ScrollRequest
public static class ScrollRequest.Builder extends WithJsonObjectBuilderBase<ScrollRequest.Builder> implements ObjectBuilder<ScrollRequest>
Builder for
ScrollRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ScrollRequest
build()
Builds aScrollRequest
.ScrollRequest.Builder
scroll(Time value)
Period to retain the search context for scrolling.ScrollRequest.Builder
scroll(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to retain the search context for scrolling.ScrollRequest.Builder
scrollId(java.lang.String value)
Required - Scroll ID of the search.protected ScrollRequest.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
scroll
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
Required - Scroll ID of the search.API name:
scroll_id
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<ScrollRequest.Builder>
-
build
Builds aScrollRequest
.- Specified by:
build
in interfaceObjectBuilder<ScrollRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-