Package org.opensearch.client.opensearch._types

Class SlicedScroll.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.SlicedScroll.Builder

All Implemented Interfaces:

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

Enclosing class:

SlicedScroll

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

Builder for SlicedScroll.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SlicedScroll	build()	Builds a SlicedScroll.
SlicedScroll.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SlicedScroll.Builder	field(String value)	The field to slice on.
final SlicedScroll.Builder	id(int value)	Required - The ID of the slice.
final SlicedScroll.Builder	max(int value)	Required - The maximum number of slices.

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

Returns:

a new builder instance.

field

@Nonnull
public final SlicedScroll.Builder field(@Nullable
 String value)

The field to slice on.

API name: field

id

@Nonnull
public final SlicedScroll.Builder id(int value)

Required - The ID of the slice.

API name: id

max

@Nonnull
public final SlicedScroll.Builder max(int value)

Required - The maximum number of slices.

API name: max

build

@Nonnull
public SlicedScroll build()

Builds a SlicedScroll.

Specified by:

build in interface ObjectBuilder<SlicedScroll>

Throws:

NullPointerException - if some of the required fields are null.