Package org.opensearch.client.opensearch.indices.close

Class CloseIndexResult.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.close.CloseIndexResult.Builder

All Implemented Interfaces:

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

Enclosing class:

CloseIndexResult

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

Builder for CloseIndexResult.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloseIndexResult	build()	Builds a CloseIndexResult.
final CloseIndexResult.Builder	closed(boolean value)	Required - Whether the index was successfully closed.
CloseIndexResult.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CloseIndexResult.Builder	shards(String key, Function<CloseShardResult.Builder,ObjectBuilder<CloseShardResult>> fn)	The status of individual shards during the close operation.
final CloseIndexResult.Builder	shards(String key, CloseShardResult value)	The status of individual shards during the close operation.
final CloseIndexResult.Builder	shards(Map<String,CloseShardResult> map)	The status of individual shards during the close operation.

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

Returns:

a new builder instance.

closed

@Nonnull
public final CloseIndexResult.Builder closed(boolean value)

Required - Whether the index was successfully closed.

API name: closed

shards

@Nonnull
public final CloseIndexResult.Builder shards(Map<String,CloseShardResult> map)

The status of individual shards during the close operation.

API name: shards

Adds all elements of map to shards.

shards

@Nonnull
public final CloseIndexResult.Builder shards(String key,
 CloseShardResult value)

The status of individual shards during the close operation.

API name: shards

Adds an entry to shards.

shards

@Nonnull
public final CloseIndexResult.Builder shards(String key,
 Function<CloseShardResult.Builder,ObjectBuilder<CloseShardResult>> fn)

The status of individual shards during the close operation.

API name: shards

Adds a value to shards using a builder lambda.

build

@Nonnull
public CloseIndexResult build()

Builds a CloseIndexResult.

Specified by:

build in interface ObjectBuilder<CloseIndexResult>

Throws:

NullPointerException - if some of the required fields are null.