Class HealthResponse
java.lang.Object
co.elastic.clients.elasticsearch.cluster.HealthResponse
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public final class HealthResponse extends java.lang.Object implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HealthResponse.Builder
Builder forHealthResponse
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<HealthResponse>
_DESERIALIZER
Json deserializer forHealthResponse
-
Constructor Summary
Constructors Constructor Description HealthResponse(HealthResponse.Builder builder)
HealthResponse(java.util.function.Function<HealthResponse.Builder,HealthResponse.Builder> fn)
-
Method Summary
Modifier and Type Method Description int
activePrimaryShards()
The number of active primary shards.int
activeShards()
The total number of active primary and replica shards.java.lang.String
activeShardsPercentAsNumber()
The ratio of active shards in the cluster expressed as a percentage.java.lang.String
clusterName()
The name of the cluster.int
delayedUnassignedShards()
The number of shards whose allocation has been delayed by the timeout settings.java.util.Map<java.lang.String,IndexHealthStats>
indices()
API name:indices
int
initializingShards()
The number of shards that are under initialization.int
numberOfDataNodes()
The number of nodes that are dedicated data nodes.int
numberOfInFlightFetch()
API name:number_of_in_flight_fetch
int
numberOfNodes()
The number of nodes within the cluster.int
numberOfPendingTasks()
The number of cluster-level changes that have not yet been executed.int
relocatingShards()
The number of shards that are under relocation.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupHealthResponseDeserializer(DelegatingDeserializer<HealthResponse.Builder> op)
Health
status()
API name:status
java.lang.String
taskMaxWaitingInQueueMillis()
The time expressed in milliseconds since the earliest initiated task is waiting for being performed.boolean
timedOut()
If false the response returned within the period of time that is specified by the timeout parameter (30s by default)int
unassignedShards()
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
-
Field Details
-
_DESERIALIZER
Json deserializer forHealthResponse
-
-
Constructor Details
-
HealthResponse
-
HealthResponse
public HealthResponse(java.util.function.Function<HealthResponse.Builder,HealthResponse.Builder> fn)
-
-
Method Details
-
activePrimaryShards
public int activePrimaryShards()The number of active primary shards.API name:
active_primary_shards
-
activeShards
public int activeShards()The total number of active primary and replica shards.API name:
active_shards
-
activeShardsPercentAsNumber
public java.lang.String activeShardsPercentAsNumber()The ratio of active shards in the cluster expressed as a percentage.API name:
active_shards_percent_as_number
-
clusterName
public java.lang.String clusterName()The name of the cluster.API name:
cluster_name
-
delayedUnassignedShards
public int delayedUnassignedShards()The number of shards whose allocation has been delayed by the timeout settings.API name:
delayed_unassigned_shards
-
indices
API name:indices
-
initializingShards
public int initializingShards()The number of shards that are under initialization.API name:
initializing_shards
-
numberOfDataNodes
public int numberOfDataNodes()The number of nodes that are dedicated data nodes.API name:
number_of_data_nodes
-
numberOfInFlightFetch
public int numberOfInFlightFetch()API name:number_of_in_flight_fetch
-
numberOfNodes
public int numberOfNodes()The number of nodes within the cluster.API name:
number_of_nodes
-
numberOfPendingTasks
public int numberOfPendingTasks()The number of cluster-level changes that have not yet been executed.API name:
number_of_pending_tasks
-
relocatingShards
public int relocatingShards()The number of shards that are under relocation.API name:
relocating_shards
-
status
API name:status
-
taskMaxWaitingInQueueMillis
public java.lang.String taskMaxWaitingInQueueMillis()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 boolean timedOut()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 int unassignedShards()The number of shards that are not allocated.API name:
unassigned_shards
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupHealthResponseDeserializer
protected static void setupHealthResponseDeserializer(DelegatingDeserializer<HealthResponse.Builder> op)
-