Package co.elastic.clients.elasticsearch.core

Class ClearScrollResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<ClearScrollResponse.Builder>

co.elastic.clients.elasticsearch.core.ClearScrollResponse.Builder

All Implemented Interfaces:

WithJson<ClearScrollResponse.Builder>, ObjectBuilder<ClearScrollResponse>

Enclosing class:

ClearScrollResponse

public static class ClearScrollResponse.Builder
extends WithJsonObjectBuilderBase<ClearScrollResponse.Builder>
implements ObjectBuilder<ClearScrollResponse>

Builder for ClearScrollResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClearScrollResponse	build()	Builds a ClearScrollResponse.
final ClearScrollResponse.Builder	numFreed(int value)	Required - The number of scrolling search requests cleared.
protected ClearScrollResponse.Builder	self()
final ClearScrollResponse.Builder	succeeded(boolean value)	Required - If true, the request succeeded.

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

succeeded

public final ClearScrollResponse.Builder succeeded(boolean value)

Required - If true, the request succeeded. This does not indicate whether any scrolling search requests were cleared.

API name: succeeded

numFreed

public final ClearScrollResponse.Builder numFreed(int value)

Required - The number of scrolling search requests cleared.

API name: num_freed

self

protected ClearScrollResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ClearScrollResponse.Builder>

build

public ClearScrollResponse build()

Builds a ClearScrollResponse.

Specified by:

build in interface ObjectBuilder<ClearScrollResponse>

Throws:

NullPointerException - if some of the required fields are null.