Package org.opensearch.client.opensearch.core

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ScrollRequest	build()	Builds a ScrollRequest.
final ScrollRequest.Builder	scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to retain the search context for scrolling.
final ScrollRequest.Builder	scroll(Time value)	Period to retain the search context for scrolling.
final ScrollRequest.Builder	scrollId(String value)	Required - Scroll ID of the search.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _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

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(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to retain the search context for scrolling.

API name: scroll

scrollId

public final ScrollRequest.Builder scrollId(String value)

Required - Scroll ID of the search.

API name: scroll_id

build

public ScrollRequest build()

Builds a ScrollRequest.

Specified by:

build in interface ObjectBuilder<ScrollRequest>

Throws:

NullPointerException - if some of the required fields are null.