Package org.opensearch.client.opensearch.cluster

Class HealthResponse

java.lang.Object
org.opensearch.client.opensearch.cluster.HealthResponse
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<HealthResponse.Builder,HealthResponse>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class HealthResponse extends Object implements PlainJsonSerializable, ToCopyableBuilder<HealthResponse.Builder,HealthResponse>

  • Field Details

  • Method Details

    • of

      public static HealthResponse of(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

    • activeShardsPercent

      @Nullable public final String activeShardsPercent()
      API name: active_shards_percent

    • activeShardsPercentAsNumber

      public final double activeShardsPercentAsNumber()
      Required - API name: active_shards_percent_as_number

    • awarenessAttributes

      @Nonnull public final Map<String,AwarenessAttributeStats> awarenessAttributes()
      Cluster health information for each awareness attribute.

      API name: awareness_attributes

    • clusterName

      @Nonnull public final String clusterName()
      Required - 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

    • discoveredClusterManager

      @Nullable public final Boolean discoveredClusterManager()
      True if the cluster-manager node has been discovered.

      API name: discovered_cluster_manager

    • discoveredMaster

      @Nullable public final Boolean discoveredMaster()
      True if the cluster-manager node has been discovered.

      API name: discovered_master

    • indices

      @Nonnull public final Map<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 - The number of unfinished fetches.

      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

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

    • taskMaxWaitingInQueue

      @Nullable public final Time taskMaxWaitingInQueue()
      API name: task_max_waiting_in_queue

    • taskMaxWaitingInQueueMillis

      public final long taskMaxWaitingInQueueMillis()
      Required - 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)

    • toBuilder

      @Nonnull public HealthResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HealthResponse.Builder,HealthResponse>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static HealthResponse.Builder builder()

    • setupHealthResponseDeserializer

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object