Package org.opensearch.client.opensearch.cluster

Class HealthResponse

java.lang.Object
org.opensearch.client.opensearch.cluster.HealthResponse
All Implemented Interfaces:
ToJsonp
public final class HealthResponse
extends java.lang.Object
implements ToJsonp

  • Field Details

  • Constructor Details

  • Method Details

    • activePrimaryShards

      public java.lang.Number activePrimaryShards()
      The number of active primary shards. API name: active_primary_shards

    • activeShards

      public java.lang.Number activeShards()
      The total number of active primary and replica shards. API name: active_shards

    • activeShardsPercentAsNumber

      public jakarta.json.JsonValue 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 java.lang.Number delayedUnassignedShards()
      The number of shards whose allocation has been delayed by the timeout settings. API name: delayed_unassigned_shards

    • indices

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

    • initializingShards

      public java.lang.Number initializingShards()
      The number of shards that are under initialization. API name: initializing_shards

    • numberOfDataNodes

      public java.lang.Number numberOfDataNodes()
      The number of nodes that are dedicated data nodes. API name: number_of_data_nodes

    • numberOfInFlightFetch

      public java.lang.Number numberOfInFlightFetch()
      API name: number_of_in_flight_fetch

    • numberOfNodes

      public java.lang.Number numberOfNodes()
      The number of nodes within the cluster. API name: number_of_nodes

    • numberOfPendingTasks

      public java.lang.Number numberOfPendingTasks()
      The number of cluster-level changes that have not yet been executed. API name: number_of_pending_tasks

    • relocatingShards

      public java.lang.Number relocatingShards()
      The number of shards that are under relocation. API name: relocating_shards

    • status

      public jakarta.json.JsonValue status()
      API name: status

    • taskMaxWaitingInQueueMillis

      public jakarta.json.JsonValue 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 java.lang.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 java.lang.Number unassignedShards()
      The number of shards that are not allocated. API name: unassigned_shards

    • toJsonp

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

    • toJsonpInternal

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

    • setupHealthResponseDeserializer

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