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 classHealthResponse.BuilderBuilder forHealthResponse. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<HealthResponse>_DESERIALIZERJson 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 intactivePrimaryShards()Required - The number of active primary shards.intactiveShards()Required - The total number of active primary and replica shards.java.lang.StringactiveShardsPercentAsNumber()Required - The ratio of active shards in the cluster expressed as a percentage.java.lang.StringclusterName()Required - The name of the cluster.intdelayedUnassignedShards()Required - The number of shards whose allocation has been delayed by the timeout settings.java.util.Map<java.lang.String,IndexHealthStats>indices()API name:indicesintinitializingShards()Required - The number of shards that are under initialization.intnumberOfDataNodes()Required - The number of nodes that are dedicated data nodes.intnumberOfInFlightFetch()Required - API name:number_of_in_flight_fetchintnumberOfNodes()Required - The number of nodes within the cluster.intnumberOfPendingTasks()Required - The number of cluster-level changes that have not yet been executed.intrelocatingShards()Required - The number of shards that are under relocation.voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupHealthResponseDeserializer(DelegatingDeserializer<HealthResponse.Builder> op)Healthstatus()Required - API name:statusjava.lang.StringtaskMaxWaitingInQueueMillis()Required - The time expressed in milliseconds since the earliest initiated task is waiting for being performed.booleantimedOut()Required - If false the response returned within the period of time that is specified by the timeout parameter (30s by default)intunassignedShards()Required - 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()Required - The number of active primary shards.API name:
active_primary_shards -
activeShards
public int activeShards()Required - The total number of active primary and replica shards.API name:
active_shards -
activeShardsPercentAsNumber
public java.lang.String activeShardsPercentAsNumber()Required - 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()Required - The name of the cluster.API name:
cluster_name -
delayedUnassignedShards
public int delayedUnassignedShards()Required - 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()Required - The number of shards that are under initialization.API name:
initializing_shards -
numberOfDataNodes
public int numberOfDataNodes()Required - The number of nodes that are dedicated data nodes.API name:
number_of_data_nodes -
numberOfInFlightFetch
public int numberOfInFlightFetch()Required - API name:number_of_in_flight_fetch -
numberOfNodes
public int numberOfNodes()Required - The number of nodes within the cluster.API name:
number_of_nodes -
numberOfPendingTasks
public int numberOfPendingTasks()Required - The number of cluster-level changes that have not yet been executed.API name:
number_of_pending_tasks -
relocatingShards
public int relocatingShards()Required - The number of shards that are under relocation.API name:
relocating_shards -
status
Required - API name:status -
taskMaxWaitingInQueueMillis
public java.lang.String taskMaxWaitingInQueueMillis()Required - 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()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
public int unassignedShards()Required - The number of shards that are not allocated.API name:
unassigned_shards -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
setupHealthResponseDeserializer
protected static void setupHealthResponseDeserializer(DelegatingDeserializer<HealthResponse.Builder> op)
-