Package org.opensearch.client.opensearch.ingestion

Class GetStateResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingestion.GetStateResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

GetStateResponse

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

Builder for GetStateResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetStateResponse	build()	Builds a GetStateResponse.
GetStateResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetStateResponse.Builder	ingestionState(String key, List<ShardIngestionState> value)	Ingestion state for a given index and its shards.
final GetStateResponse.Builder	ingestionState(Map<String,List<ShardIngestionState>> map)	Ingestion state for a given index and its shards.
final GetStateResponse.Builder	nextPageToken(String value)	Specifies the next page token.
final GetStateResponse.Builder	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	API name: _shards
final GetStateResponse.Builder	shards(ShardStatistics value)	API name: _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 GetStateResponse.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<GetStateResponse.Builder,GetStateResponse>

Returns:

a new builder instance.

ingestionState

@Nonnull
public final GetStateResponse.Builder ingestionState(Map<String,List<ShardIngestionState>> map)

Ingestion state for a given index and its shards.

API name: ingestion_state

Adds all elements of map to ingestionState.

ingestionState

@Nonnull
public final GetStateResponse.Builder ingestionState(String key,
 List<ShardIngestionState> value)

Ingestion state for a given index and its shards.

API name: ingestion_state

Adds an entry to ingestionState.

nextPageToken

@Nonnull
public final GetStateResponse.Builder nextPageToken(@Nullable
 String value)

Specifies the next page token. Pass this token in the request to retrieve contents of the next page.

API name: next_page_token

shards

@Nonnull
public final GetStateResponse.Builder shards(@Nullable
 ShardStatistics value)

API name: _shards

shards

@Nonnull
public final GetStateResponse.Builder shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)

API name: _shards

build

@Nonnull
public GetStateResponse build()

Builds a GetStateResponse.

Specified by:

build in interface ObjectBuilder<GetStateResponse>

Throws:

NullPointerException - if some of the required fields are null.