Package co.elastic.clients.elasticsearch.cluster

Class HealthResponse

java.lang.Object
co.elastic.clients.elasticsearch.cluster.HealthResponse
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class HealthResponse
extends java.lang.Object
implements JsonpSerializable
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static HealthResponse of​(java.util.function.Function<HealthResponse.Builder,​ObjectBuilder<HealthResponse>> fn)

    • activePrimaryShards

      public final int activePrimaryShards()
      Required - The number of active primary shards.

      API name: active_primary_shards

    • activeShards

      public final int activeShards()
      Required - The total number of active primary and replica shards.

      API name: active_shards

    • activeShardsPercentAsNumber

      public final 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 final java.lang.String clusterName()
      Required - The name of the cluster.

      API name: cluster_name

    • delayedUnassignedShards

      public final int delayedUnassignedShards()
      Required - The number of shards whose allocation has been delayed by the timeout settings.

      API name: delayed_unassigned_shards

    • indices

      public final java.util.Map<java.lang.String,​IndexHealthStats> indices()
      API name: indices

    • initializingShards

      public final int initializingShards()
      Required - The number of shards that are under initialization.

      API name: initializing_shards

    • numberOfDataNodes

      public final int numberOfDataNodes()
      Required - The number of nodes that are dedicated data nodes.

      API name: number_of_data_nodes

    • numberOfInFlightFetch

      public final int numberOfInFlightFetch()
      Required - API name: number_of_in_flight_fetch

    • numberOfNodes

      public final int numberOfNodes()
      Required - The number of nodes within the cluster.

      API name: number_of_nodes

    • numberOfPendingTasks

      public final int numberOfPendingTasks()
      Required - The number of cluster-level changes that have not yet been executed.

      API name: number_of_pending_tasks

    • relocatingShards

      public final int relocatingShards()
      Required - The number of shards that are under relocation.

      API name: relocating_shards

    • status

      public final HealthStatus status()
      Required - API name: status

    • taskMaxWaitingInQueueMillis

      public final 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 final 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 final int unassignedShards()
      Required - The number of shards that are not allocated.

      API name: unassigned_shards

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupHealthResponseDeserializer

      protected static void setupHealthResponseDeserializer​(ObjectDeserializer<HealthResponse.Builder> op)