Package org.opensearch.client.opensearch.cluster

Class HealthRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.cluster.HealthRequest
All Implemented Interfaces:
ToCopyableBuilder<HealthRequest.Builder,HealthRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class HealthRequest extends RequestBase implements ToCopyableBuilder<HealthRequest.Builder,HealthRequest>
Returns basic information about the health of the cluster.

  • Field Details

  • Method Details

    • of

      public static HealthRequest of(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)

    • awarenessAttribute

      @Nullable public final String awarenessAttribute()
      The name of the awareness attribute for which to return the cluster health status (for example, zone). Applicable only if level is set to awareness_attributes.

      API name: awareness_attribute

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

      API name: cluster_manager_timeout

    • expandWildcards

      @Nonnull public final List<ExpandWildcard> expandWildcards()
      Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

      API name: expand_wildcards

    • index

      @Nonnull public final List<String> index()
      A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

      API name: index

    • level

      @Nullable public final ClusterHealthLevel level()
      Controls the amount of detail included in the cluster health response.

      API name: level

    • local

      @Nullable public final Boolean local()
      Whether to return information from the local node only instead of from the cluster manager node.

      API name: local

    • masterTimeout

      @Deprecated @Nullable public final Time masterTimeout()
      Deprecated.
      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

      API name: master_timeout

    • timeout

      @Nullable public final Time timeout()
      The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

      API name: timeout

    • waitForActiveShards

      @Nullable public final WaitForActiveShards waitForActiveShards()
      Waits until the specified number of shards is active before returning a response. Use all for all shards.

      API name: wait_for_active_shards

    • waitForEvents

      @Nullable public final WaitForEvents waitForEvents()
      Waits until all currently queued events with the given priority are processed.

      API name: wait_for_events

    • waitForNoInitializingShards

      @Nullable public final Boolean waitForNoInitializingShards()
      Whether to wait until there are no initializing shards in the cluster.

      API name: wait_for_no_initializing_shards

    • waitForNoRelocatingShards

      @Nullable public final Boolean waitForNoRelocatingShards()
      Whether to wait until there are no relocating shards in the cluster.

      API name: wait_for_no_relocating_shards

    • waitForNodes

      @Nullable public final WaitForNodes waitForNodes()
      Waits until the specified number of nodes (N) is available. Accepts >=N, <=N, >N, and <N. You can also use ge(N), le(N), gt(N), and lt(N) notation.

      API name: wait_for_nodes

    • waitForStatus

      @Nullable public final HealthStatus waitForStatus()
      Waits until the cluster health reaches the specified status or better.

      API name: wait_for_status

    • toBuilder

      @Nonnull public HealthRequest.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<HealthRequest.Builder,HealthRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static HealthRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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