Package org.opensearch.client.opensearch.core

Class ClearScrollRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ClearScrollRequest.Builder>

org.opensearch.client.opensearch.core.ClearScrollRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ClearScrollRequest

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

Builder for ClearScrollRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClearScrollRequest	build()	Builds a ClearScrollRequest.
ClearScrollRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ClearScrollRequest.Builder	scrollId(String value, String... values)	API name: scroll_id
final ClearScrollRequest.Builder	scrollId(List<String> list)	API name: scroll_id
protected ClearScrollRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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 ClearScrollRequest.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<ClearScrollRequest.Builder,ClearScrollRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ClearScrollRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ClearScrollRequest.Builder>

scrollId

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

API name: scroll_id

Adds all elements of list to scrollId.

scrollId

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

API name: scroll_id

Adds one or more values to scrollId.

build

@Nonnull
public ClearScrollRequest build()

Builds a ClearScrollRequest.

Specified by:

build in interface ObjectBuilder<ClearScrollRequest>

Throws:

NullPointerException - if some of the required fields are null.