Package org.opensearch.client.opensearch.cat

Class IndicesRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.cat.CatRequestBase
org.opensearch.client.opensearch.cat.IndicesRequest
All Implemented Interfaces:
ToCopyableBuilder<IndicesRequest.Builder,IndicesRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class IndicesRequest extends CatRequestBase implements ToCopyableBuilder<IndicesRequest.Builder,IndicesRequest>
Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.

  • Field Details

  • Method Details

    • of

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

    • bytes

      @Nullable public final Bytes bytes()
      The units used to display byte values.

      API name: bytes

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      The amount of time allowed to establish a connection to the cluster manager node.

      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

    • health

      @Nullable public final HealthStatus health()
      Limits indexes based on their health status. Supported values are green, yellow, and red.

      API name: health

    • includeUnloadedSegments

      @Nullable public final Boolean includeUnloadedSegments()
      Whether to include information from segments not loaded into memory.

      API name: include_unloaded_segments

    • 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

    • masterTimeout

      @Deprecated @Nullable public final Time masterTimeout()
      Deprecated.
      The amount of time allowed to establish a connection to the cluster manager node.

      API name: master_timeout

    • pri

      @Nullable public final Boolean pri()
      When true, returns information only from the primary shards.

      API name: pri

    • time

      @Nullable public final TimeUnit time()
      Specifies the time units.

      API name: time

    • toBuilder

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

    • builder

      @Nonnull public static IndicesRequest.Builder builder()

    • applyQueryParameters

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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