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
Returns a comprehensive information about the state of the cluster.
See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      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 (default: false)

      API name: flat_settings

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      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

      @Nullable public final Boolean local()
      Return local information, do not retrieve the state from master node (default: false)

      API name: local

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Specify timeout for connection to master

      API name: master_timeout

    • metric

      public final List<String> 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