Package org.opensearch.client.opensearch.cluster

Class HealthRequest

  • public class HealthRequest
extends RequestBase
    Returns basic information about the health of the cluster.

    • Method Detail

      • expandWildcards

        public final java.util.List<ExpandWildcard> expandWildcards()
        Whether to expand wildcard expression to concrete indices that are open, closed or both.

        API name: expand_wildcards

      • index

        public final java.util.List<java.lang.String> index()
        Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

        API name: index

      • level

        @Nullable
public final Level level()
        Can be one of cluster, indices or shards. Controls the details level of the health information returned.

        API name: level

      • local

        @Nullable
public final java.lang.Boolean local()
        If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node.

        API name: local

      • masterTimeout

        @Deprecated
@Nullable
public final Time masterTimeout()
        Deprecated.
        Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

        API name: master_timeout

      • clusterManagerTimeout

        @Nullable
public final Time clusterManagerTimeout()
        Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

        API name: cluster_manager_timeout

      • timeout

        @Nullable
public final Time timeout()
        Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

        API name: timeout

      • waitForActiveShards

        @Nullable
public final WaitForActiveShards waitForActiveShards()
        A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.

        API name: wait_for_active_shards

      • waitForEvents

        @Nullable
public final WaitForEvents waitForEvents()
        Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.

        API name: wait_for_events

      • waitForNoInitializingShards

        @Nullable
public final java.lang.Boolean waitForNoInitializingShards()
        A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.

        API name: wait_for_no_initializing_shards

      • waitForNoRelocatingShards

        @Nullable
public final java.lang.Boolean waitForNoRelocatingShards()
        A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.

        API name: wait_for_no_relocating_shards

      • waitForNodes

        @Nullable
public final java.lang.String waitForNodes()
        The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.

        API name: wait_for_nodes

      • waitForStatus

        @Nullable
public final HealthStatus waitForStatus()
        One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.

        API name: wait_for_status