Package org.opensearch.client.opensearch.ingestion

Class ResetSettings.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingestion.ResetSettings.Builder

All Implemented Interfaces:

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

Enclosing class:

ResetSettings

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

Builder for ResetSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ResetSettings	build()	Builds a ResetSettings.
ResetSettings.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ResetSettings.Builder	mode(ResetMode value)	Required - Reset mode to be used.
final ResetSettings.Builder	shard(int value)	Required - The shard ID to reset.
final ResetSettings.Builder	value(String value)	Required - The offset or timestamp value to be used to reset the consumer.

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

Returns:

a new builder instance.

mode

@Nonnull
public final ResetSettings.Builder mode(ResetMode value)

Required - Reset mode to be used.

API name: mode

shard

@Nonnull
public final ResetSettings.Builder shard(int value)

Required - The shard ID to reset.

API name: shard

value

@Nonnull
public final ResetSettings.Builder value(String value)

Required - The offset or timestamp value to be used to reset the consumer.

API name: value

build

@Nonnull
public ResetSettings build()

Builds a ResetSettings.

Specified by:

build in interface ObjectBuilder<ResetSettings>

Throws:

NullPointerException - if some of the required fields are null.