Package co.elastic.clients.elasticsearch.core

Class ScrollRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<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 RequestBase.AbstractBuilder<ScrollRequest.Builder>
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(Time value)	The period to retain the search context for scrolling.
final ScrollRequest.Builder	scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to retain the search context for scrolling.
final ScrollRequest.Builder	scrollId(String value)	Required - The 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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

scroll

public final ScrollRequest.Builder scroll(@Nullable
 Time value)

The period to retain the search context for scrolling.

API name: scroll

scroll

public final ScrollRequest.Builder scroll(Function<Time.Builder,ObjectBuilder<Time>> fn)

The period to retain the search context for scrolling.

API name: scroll

scrollId

public final ScrollRequest.Builder scrollId(String value)

Required - The scroll ID of the search.

API name: scroll_id

self

protected ScrollRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ScrollRequest.Builder>

build

public ScrollRequest build()

Builds a ScrollRequest.

Specified by:

build in interface ObjectBuilder<ScrollRequest>

Throws:

NullPointerException - if some of the required fields are null.