Package org.opensearch.client.opensearch.cluster.health

Class IndexHealthStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.health.IndexHealthStats.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexHealthStats

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

Builder for IndexHealthStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexHealthStats.Builder	activePrimaryShards(int value)	Required - API name: active_primary_shards
final IndexHealthStats.Builder	activeShards(int value)	Required - API name: active_shards
IndexHealthStats	build()	Builds a IndexHealthStats.
IndexHealthStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexHealthStats.Builder	initializingShards(int value)	Required - API name: initializing_shards
final IndexHealthStats.Builder	numberOfReplicas(int value)	Required - API name: number_of_replicas
final IndexHealthStats.Builder	numberOfShards(int value)	Required - API name: number_of_shards
final IndexHealthStats.Builder	relocatingShards(int value)	Required - API name: relocating_shards
final IndexHealthStats.Builder	shards(String key, Function<ShardHealthStats.Builder,ObjectBuilder<ShardHealthStats>> fn)	API name: shards
final IndexHealthStats.Builder	shards(String key, ShardHealthStats value)	API name: shards
final IndexHealthStats.Builder	shards(Map<String,ShardHealthStats> map)	API name: shards
final IndexHealthStats.Builder	status(HealthStatus value)	Required - API name: status
final IndexHealthStats.Builder	unassignedShards(int value)	Required - API name: unassigned_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 IndexHealthStats.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<IndexHealthStats.Builder,IndexHealthStats>

Returns:

a new builder instance.

activePrimaryShards

@Nonnull
public final IndexHealthStats.Builder activePrimaryShards(int value)

Required - API name: active_primary_shards

activeShards

@Nonnull
public final IndexHealthStats.Builder activeShards(int value)

Required - API name: active_shards

initializingShards

@Nonnull
public final IndexHealthStats.Builder initializingShards(int value)

Required - API name: initializing_shards

numberOfReplicas

@Nonnull
public final IndexHealthStats.Builder numberOfReplicas(int value)

Required - API name: number_of_replicas

numberOfShards

@Nonnull
public final IndexHealthStats.Builder numberOfShards(int value)

Required - API name: number_of_shards

relocatingShards

@Nonnull
public final IndexHealthStats.Builder relocatingShards(int value)

Required - API name: relocating_shards

shards

@Nonnull
public final IndexHealthStats.Builder shards(Map<String,ShardHealthStats> map)

API name: shards

Adds all elements of map to shards.

shards

@Nonnull
public final IndexHealthStats.Builder shards(String key,
 ShardHealthStats value)

API name: shards

Adds an entry to shards.

shards

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

API name: shards

Adds a value to shards using a builder lambda.

status

@Nonnull
public final IndexHealthStats.Builder status(HealthStatus value)

Required - API name: status

unassignedShards

@Nonnull
public final IndexHealthStats.Builder unassignedShards(int value)

Required - API name: unassigned_shards

build

@Nonnull
public IndexHealthStats build()

Builds a IndexHealthStats.

Specified by:

build in interface ObjectBuilder<IndexHealthStats>

Throws:

NullPointerException - if some of the required fields are null.