Package org.opensearch.client.opensearch.cluster

Class StateRequest

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

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

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

      API name: allow_no_indices

    • 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

    • flatSettings

      @Nullable public final Boolean flatSettings()
      Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500".

      API name: flat_settings

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • 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

    • 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

    • metric

      @Nonnull public final List<ClusterStateMetric> metric()
      Limits the information returned to only the specified metric groups.

      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

    • toBuilder

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

    • builder

      @Nonnull public static StateRequest.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