Package org.opensearch.client.opensearch.cluster

Class HealthResponse.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<HealthResponse>

Enclosing class:

HealthResponse

public static class HealthResponse.Builder
extends java.lang.Object
implements ObjectBuilder<HealthResponse>

Builder for HealthResponse.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HealthResponse.Builder	activePrimaryShards(java.lang.Number value)	The number of active primary shards.
HealthResponse.Builder	activeShards(java.lang.Number value)	The total number of active primary and replica shards.
HealthResponse.Builder	activeShardsPercentAsNumber(jakarta.json.JsonValue value)	The ratio of active shards in the cluster expressed as a percentage.
HealthResponse	build()	Builds a HealthResponse.
HealthResponse.Builder	clusterName(java.lang.String value)	The name of the cluster.
HealthResponse.Builder	delayedUnassignedShards(java.lang.Number value)	The number of shards whose allocation has been delayed by the timeout settings.
HealthResponse.Builder	indices(java.lang.String key, java.util.function.Function<IndexHealthStats.Builder,ObjectBuilder<IndexHealthStats>> fn)	Set indices(Map) to a singleton map.
HealthResponse.Builder	indices(java.util.Map<java.lang.String,IndexHealthStats> value)	API name: indices
HealthResponse.Builder	initializingShards(java.lang.Number value)	The number of shards that are under initialization.
HealthResponse.Builder	numberOfDataNodes(java.lang.Number value)	The number of nodes that are dedicated data nodes.
HealthResponse.Builder	numberOfInFlightFetch(java.lang.Number value)	API name: number_of_in_flight_fetch
HealthResponse.Builder	numberOfNodes(java.lang.Number value)	The number of nodes within the cluster.
HealthResponse.Builder	numberOfPendingTasks(java.lang.Number value)	The number of cluster-level changes that have not yet been executed.
HealthResponse.Builder	putIndices(java.lang.String key, java.util.function.Function<IndexHealthStats.Builder,ObjectBuilder<IndexHealthStats>> fn)	Add a key/value to indices(Map), creating the map if needed.
HealthResponse.Builder	putIndices(java.lang.String key, IndexHealthStats value)	Add a key/value to indices(Map), creating the map if needed.
HealthResponse.Builder	relocatingShards(java.lang.Number value)	The number of shards that are under relocation.
HealthResponse.Builder	status(jakarta.json.JsonValue value)	API name: status
HealthResponse.Builder	taskMaxWaitingInQueueMillis(jakarta.json.JsonValue value)	The time expressed in milliseconds since the earliest initiated task is waiting for being performed.
HealthResponse.Builder	timedOut(java.lang.Boolean value)	If false the response returned within the period of time that is specified by the timeout parameter (30s by default) API name: timed_out
HealthResponse.Builder	unassignedShards(java.lang.Number value)	The number of shards that are not allocated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

activePrimaryShards

public HealthResponse.Builder activePrimaryShards(java.lang.Number value)

The number of active primary shards. API name: active_primary_shards

activeShards

public HealthResponse.Builder activeShards(java.lang.Number value)

The total number of active primary and replica shards. API name: active_shards

activeShardsPercentAsNumber

public HealthResponse.Builder activeShardsPercentAsNumber(jakarta.json.JsonValue value)

The ratio of active shards in the cluster expressed as a percentage. API name: active_shards_percent_as_number

clusterName

public HealthResponse.Builder clusterName(java.lang.String value)

The name of the cluster. API name: cluster_name

delayedUnassignedShards

public HealthResponse.Builder delayedUnassignedShards(java.lang.Number value)

The number of shards whose allocation has been delayed by the timeout settings. API name: delayed_unassigned_shards

indices

public HealthResponse.Builder indices(@Nullable java.util.Map<java.lang.String,IndexHealthStats> value)

API name: indices

putIndices

public HealthResponse.Builder putIndices(java.lang.String key, IndexHealthStats value)

Add a key/value to indices(Map), creating the map if needed.

indices

public HealthResponse.Builder indices(java.lang.String key, java.util.function.Function<IndexHealthStats.Builder,ObjectBuilder<IndexHealthStats>> fn)

Set indices(Map) to a singleton map.

putIndices

public HealthResponse.Builder putIndices(java.lang.String key, java.util.function.Function<IndexHealthStats.Builder,ObjectBuilder<IndexHealthStats>> fn)

Add a key/value to indices(Map), creating the map if needed.

initializingShards

public HealthResponse.Builder initializingShards(java.lang.Number value)

The number of shards that are under initialization. API name: initializing_shards

numberOfDataNodes

public HealthResponse.Builder numberOfDataNodes(java.lang.Number value)

The number of nodes that are dedicated data nodes. API name: number_of_data_nodes

numberOfInFlightFetch

public HealthResponse.Builder numberOfInFlightFetch(java.lang.Number value)

API name: number_of_in_flight_fetch

numberOfNodes

public HealthResponse.Builder numberOfNodes(java.lang.Number value)

The number of nodes within the cluster. API name: number_of_nodes

numberOfPendingTasks

public HealthResponse.Builder numberOfPendingTasks(java.lang.Number value)

The number of cluster-level changes that have not yet been executed. API name: number_of_pending_tasks

relocatingShards

public HealthResponse.Builder relocatingShards(java.lang.Number value)

The number of shards that are under relocation. API name: relocating_shards

status

public HealthResponse.Builder status(jakarta.json.JsonValue value)

API name: status

taskMaxWaitingInQueueMillis

public HealthResponse.Builder taskMaxWaitingInQueueMillis(jakarta.json.JsonValue value)

The time expressed in milliseconds since the earliest initiated task is waiting for being performed. API name: task_max_waiting_in_queue_millis

timedOut

public HealthResponse.Builder timedOut(java.lang.Boolean value)

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

public HealthResponse.Builder unassignedShards(java.lang.Number value)

The number of shards that are not allocated. API name: unassigned_shards

build

public HealthResponse build()

Builds a HealthResponse.

Specified by:

build in interface ObjectBuilder<HealthResponse>

Throws:

java.lang.NullPointerException - if some of the required fields are null.