Package org.opensearch.client.opensearch.cluster

Class HealthResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.HealthResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

HealthResponse

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

Builder for HealthResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final HealthResponse.Builder	activePrimaryShards(int value)	Required - The number of active primary shards.
final HealthResponse.Builder	activeShards(int value)	Required - The total number of active primary and replica shards.
final HealthResponse.Builder	activeShardsPercent(String value)	API name: active_shards_percent
final HealthResponse.Builder	activeShardsPercentAsNumber(double value)	Required - API name: active_shards_percent_as_number
final HealthResponse.Builder	awarenessAttributes(String key, Function<AwarenessAttributeStats.Builder,ObjectBuilder<AwarenessAttributeStats>> fn)	Cluster health information for each awareness attribute.
final HealthResponse.Builder	awarenessAttributes(String key, AwarenessAttributeStats value)	Cluster health information for each awareness attribute.
final HealthResponse.Builder	awarenessAttributes(Map<String,AwarenessAttributeStats> map)	Cluster health information for each awareness attribute.
HealthResponse	build()	Builds a HealthResponse.
final HealthResponse.Builder	clusterName(String value)	Required - API name: cluster_name
HealthResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final HealthResponse.Builder	delayedUnassignedShards(int value)	Required - The number of shards whose allocation has been delayed by the timeout settings.
final HealthResponse.Builder	discoveredClusterManager(Boolean value)	True if the cluster-manager node has been discovered.
final HealthResponse.Builder	discoveredMaster(Boolean value)	True if the cluster-manager node has been discovered.
final HealthResponse.Builder	indices(String key, Function<IndexHealthStats.Builder,ObjectBuilder<IndexHealthStats>> fn)	API name: indices
final HealthResponse.Builder	indices(String key, IndexHealthStats value)	API name: indices
final HealthResponse.Builder	indices(Map<String,IndexHealthStats> map)	API name: indices
final HealthResponse.Builder	initializingShards(int value)	Required - The number of shards that are under initialization.
final HealthResponse.Builder	numberOfDataNodes(int value)	Required - The number of nodes that are dedicated data nodes.
final HealthResponse.Builder	numberOfInFlightFetch(int value)	Required - The number of unfinished fetches.
final HealthResponse.Builder	numberOfNodes(int value)	Required - The number of nodes within the cluster.
final HealthResponse.Builder	numberOfPendingTasks(int value)	Required - The number of cluster-level changes that have not yet been executed.
final HealthResponse.Builder	relocatingShards(int value)	Required - The number of shards that are under relocation.
final HealthResponse.Builder	status(HealthStatus value)	Required - API name: status
final HealthResponse.Builder	taskMaxWaitingInQueue(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: task_max_waiting_in_queue
final HealthResponse.Builder	taskMaxWaitingInQueue(Time value)	API name: task_max_waiting_in_queue
final HealthResponse.Builder	taskMaxWaitingInQueueMillis(long value)	Required - API name: task_max_waiting_in_queue_millis
final HealthResponse.Builder	timedOut(boolean value)	Required - If false the response returned within the period of time that is specified by the timeout parameter (30s by default).
final HealthResponse.Builder	unassignedShards(int value)	Required - The number of shards that are not allocated.

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

Returns:

a new builder instance.

activePrimaryShards

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

Required - The number of active primary shards.

API name: active_primary_shards

activeShards

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

Required - The total number of active primary and replica shards.

API name: active_shards

activeShardsPercent

@Nonnull
public final HealthResponse.Builder activeShardsPercent(@Nullable
 String value)

API name: active_shards_percent

activeShardsPercentAsNumber

@Nonnull
public final HealthResponse.Builder activeShardsPercentAsNumber(double value)

Required - API name: active_shards_percent_as_number

awarenessAttributes

@Nonnull
public final HealthResponse.Builder awarenessAttributes(Map<String,AwarenessAttributeStats> map)

Cluster health information for each awareness attribute.

API name: awareness_attributes

Adds all elements of map to awarenessAttributes.

awarenessAttributes

@Nonnull
public final HealthResponse.Builder awarenessAttributes(String key,
 AwarenessAttributeStats value)

Cluster health information for each awareness attribute.

API name: awareness_attributes

Adds an entry to awarenessAttributes.

awarenessAttributes

@Nonnull
public final HealthResponse.Builder awarenessAttributes(String key,
 Function<AwarenessAttributeStats.Builder,ObjectBuilder<AwarenessAttributeStats>> fn)

Cluster health information for each awareness attribute.

API name: awareness_attributes

Adds a value to awarenessAttributes using a builder lambda.

clusterName

@Nonnull
public final HealthResponse.Builder clusterName(String value)

Required - API name: cluster_name

delayedUnassignedShards

@Nonnull
public final HealthResponse.Builder delayedUnassignedShards(int value)

Required - The number of shards whose allocation has been delayed by the timeout settings.

API name: delayed_unassigned_shards

discoveredClusterManager

@Nonnull
public final HealthResponse.Builder discoveredClusterManager(@Nullable
 Boolean value)

True if the cluster-manager node has been discovered.

API name: discovered_cluster_manager

discoveredMaster

@Nonnull
public final HealthResponse.Builder discoveredMaster(@Nullable
 Boolean value)

True if the cluster-manager node has been discovered.

API name: discovered_master

indices

@Nonnull
public final HealthResponse.Builder indices(Map<String,IndexHealthStats> map)

API name: indices

Adds all elements of map to indices.

indices

@Nonnull
public final HealthResponse.Builder indices(String key,
 IndexHealthStats value)

API name: indices

Adds an entry to indices.

indices

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

API name: indices

Adds a value to indices using a builder lambda.

initializingShards

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

Required - The number of shards that are under initialization.

API name: initializing_shards

numberOfDataNodes

@Nonnull
public final HealthResponse.Builder numberOfDataNodes(int value)

Required - The number of nodes that are dedicated data nodes.

API name: number_of_data_nodes

numberOfInFlightFetch

@Nonnull
public final HealthResponse.Builder numberOfInFlightFetch(int value)

Required - The number of unfinished fetches.

API name: number_of_in_flight_fetch

numberOfNodes

@Nonnull
public final HealthResponse.Builder numberOfNodes(int value)

Required - The number of nodes within the cluster.

API name: number_of_nodes

numberOfPendingTasks

@Nonnull
public final HealthResponse.Builder numberOfPendingTasks(int value)

Required - The number of cluster-level changes that have not yet been executed.

API name: number_of_pending_tasks

relocatingShards

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

Required - The number of shards that are under relocation.

API name: relocating_shards

status

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

Required - API name: status

taskMaxWaitingInQueue

@Nonnull
public final HealthResponse.Builder taskMaxWaitingInQueue(@Nullable
 Time value)

API name: task_max_waiting_in_queue

taskMaxWaitingInQueue

@Nonnull
public final HealthResponse.Builder taskMaxWaitingInQueue(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: task_max_waiting_in_queue

taskMaxWaitingInQueueMillis

@Nonnull
public final HealthResponse.Builder taskMaxWaitingInQueueMillis(long value)

Required - API name: task_max_waiting_in_queue_millis

timedOut

@Nonnull
public final HealthResponse.Builder timedOut(boolean value)

Required - If false the response returned within the period of time that is specified by the timeout parameter (30s by default).

API name: timed_out

unassignedShards

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

Required - The number of shards that are not allocated.

API name: unassigned_shards

build

@Nonnull
public HealthResponse build()

Builds a HealthResponse.

Specified by:

build in interface ObjectBuilder<HealthResponse>

Throws:

NullPointerException - if some of the required fields are null.