Package co.elastic.clients.elasticsearch.core

Class ClearScrollRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ClearScrollRequest.Builder>

co.elastic.clients.elasticsearch.core.ClearScrollRequest.Builder

All Implemented Interfaces:

WithJson<ClearScrollRequest.Builder>, ObjectBuilder<ClearScrollRequest>

Enclosing class:

ClearScrollRequest

public static class ClearScrollRequest.Builder
extends RequestBase.AbstractBuilder<ClearScrollRequest.Builder>
implements ObjectBuilder<ClearScrollRequest>

Builder for ClearScrollRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClearScrollRequest	build()	Builds a ClearScrollRequest.
final ClearScrollRequest.Builder	scrollId(String value, String... values)	The scroll IDs to clear.
final ClearScrollRequest.Builder	scrollId(List<String> list)	The scroll IDs to clear.
protected ClearScrollRequest.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

scrollId

public final ClearScrollRequest.Builder scrollId(List<String> list)

The scroll IDs to clear. To clear all scroll IDs, use _all.

API name: scroll_id

Adds all elements of list to scrollId.

scrollId

public final ClearScrollRequest.Builder scrollId(String value,
 String... values)

The scroll IDs to clear. To clear all scroll IDs, use _all.

API name: scroll_id

Adds one or more values to scrollId.

self

protected ClearScrollRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ClearScrollRequest.Builder>

build

public ClearScrollRequest build()

Builds a ClearScrollRequest.

Specified by:

build in interface ObjectBuilder<ClearScrollRequest>

Throws:

NullPointerException - if some of the required fields are null.