Package org.opensearch.client.opensearch.core

Class ClearScrollResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.ClearScrollResponse.Builder

All Implemented Interfaces:

CopyableBuilder<ClearScrollResponse.Builder,ClearScrollResponse>, MutableBuilder<ClearScrollResponse.Builder,ClearScrollResponse>, ObjectBuilder<ClearScrollResponse>

Enclosing class:

ClearScrollResponse

public static class ClearScrollResponse.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ClearScrollResponse.Builder,ClearScrollResponse>

Builder for ClearScrollResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClearScrollResponse	build()	Builds a ClearScrollResponse.
ClearScrollResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClearScrollResponse.Builder	numFreed(int value)	Required - API name: num_freed
final ClearScrollResponse.Builder	succeeded(boolean value)	Required - API name: succeeded

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ClearScrollResponse.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ClearScrollResponse.Builder,ClearScrollResponse>

Returns:

a new builder instance.

numFreed

@Nonnull
public final ClearScrollResponse.Builder numFreed(int value)

Required - API name: num_freed

succeeded

@Nonnull
public final ClearScrollResponse.Builder succeeded(boolean value)

Required - API name: succeeded

build

@Nonnull
public ClearScrollResponse build()

Builds a ClearScrollResponse.

Specified by:

build in interface ObjectBuilder<ClearScrollResponse>

Throws:

NullPointerException - if some of the required fields are null.