Package co.elastic.clients.elasticsearch.cluster

Class StateRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.StateRequest
public class StateRequest extends RequestBase
Get the cluster state.

Get comprehensive information about the state of the cluster.

The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.

The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response.

By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. You can also retrieve the cluster state held on the node handling the API request by adding the ?local=true query parameter.

Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable.

WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

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

      API name: expand_wildcards

    • flatSettings

      @Nullable public final Boolean flatSettings()
      Return settings in flat format

      API name: flat_settings

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

      public final List<String> index()
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

    • local

      @Deprecated @Nullable public final Boolean local()
      Deprecated.
      9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
      Return local information, do not retrieve the state from master node

      API name: local

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Timeout for waiting for new cluster state in case it is blocked

      API name: master_timeout

    • metric

      public final List<ClusterStateMetric> metric()
      Limit the information returned to the specified metrics.

      API name: metric

    • waitForMetadataVersion

      @Nullable public final Long waitForMetadataVersion()
      Wait for the metadata version to be equal or greater than the specified metadata version

      API name: wait_for_metadata_version

    • waitForTimeout

      @Nullable public final Time waitForTimeout()
      The maximum time to wait for wait_for_metadata_version before timing out

      API name: wait_for_timeout

    • rebuild

      public StateRequest.Builder rebuild()
      Returns:
      New StateRequest.Builder initialized with field values of this instance