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

Class ShardHealthStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.health.ShardHealthStats.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardHealthStats

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

Builder for ShardHealthStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ShardHealthStats.Builder	activeShards(int value)	Required - API name: active_shards
ShardHealthStats	build()	Builds a ShardHealthStats.
ShardHealthStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardHealthStats.Builder	initializingShards(int value)	Required - API name: initializing_shards
final ShardHealthStats.Builder	primaryActive(boolean value)	Required - API name: primary_active
final ShardHealthStats.Builder	relocatingShards(int value)	Required - API name: relocating_shards
final ShardHealthStats.Builder	status(HealthStatus value)	Required - API name: status
final ShardHealthStats.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 ShardHealthStats.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<ShardHealthStats.Builder,ShardHealthStats>

Returns:

a new builder instance.

activeShards

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

Required - API name: active_shards

initializingShards

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

Required - API name: initializing_shards

primaryActive

@Nonnull
public final ShardHealthStats.Builder primaryActive(boolean value)

Required - API name: primary_active

relocatingShards

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

Required - API name: relocating_shards

status

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

Required - API name: status

unassignedShards

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

Required - API name: unassigned_shards

build

@Nonnull
public ShardHealthStats build()

Builds a ShardHealthStats.

Specified by:

build in interface ObjectBuilder<ShardHealthStats>

Throws:

NullPointerException - if some of the required fields are null.