Package org.opensearch.client.opensearch.ingestion

Class PauseResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingestion.PauseResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

PauseResponse

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

Builder for PauseResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PauseResponse.Builder	acknowledged(boolean value)	Required - Indicates if the pause request has been acknowledged.
PauseResponse	build()	Builds a PauseResponse.
PauseResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PauseResponse.Builder	error(String value)	API name: error
final PauseResponse.Builder	failures(Function<IngestionStateShardFailure.Builder,ObjectBuilder<IngestionStateShardFailure>> fn)	API name: failures
final PauseResponse.Builder	failures(List<IngestionStateShardFailure> list)	API name: failures
final PauseResponse.Builder	failures(IngestionStateShardFailure value, IngestionStateShardFailure... values)	API name: failures
final PauseResponse.Builder	shardsAcknowledged(boolean value)	Required - Indicates if the pause request has been acknowledged by individual shards.

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

Returns:

a new builder instance.

acknowledged

@Nonnull
public final PauseResponse.Builder acknowledged(boolean value)

Required - Indicates if the pause request has been acknowledged.

API name: acknowledged

error

@Nonnull
public final PauseResponse.Builder error(@Nullable
 String value)

API name: error

failures

@Nonnull
public final PauseResponse.Builder failures(List<IngestionStateShardFailure> list)

API name: failures

Adds all elements of list to failures.

failures

@Nonnull
public final PauseResponse.Builder failures(IngestionStateShardFailure value,
 IngestionStateShardFailure... values)

API name: failures

Adds one or more values to failures.

failures

@Nonnull
public final PauseResponse.Builder failures(Function<IngestionStateShardFailure.Builder,ObjectBuilder<IngestionStateShardFailure>> fn)

API name: failures

Adds a value to failures using a builder lambda.

shardsAcknowledged

@Nonnull
public final PauseResponse.Builder shardsAcknowledged(boolean value)

Required - Indicates if the pause request has been acknowledged by individual shards.

API name: shards_acknowledged

build

@Nonnull
public PauseResponse build()

Builds a PauseResponse.

Specified by:

build in interface ObjectBuilder<PauseResponse>

Throws:

NullPointerException - if some of the required fields are null.