Class IndicesRequest


public class IndicesRequest
extends CatRequestBase
Returns information about indices: number of primaries and replicas, document counts, disk size, ...
See Also:
API specification
  • Field Details

  • Method Details

    • of

      public static IndicesRequest of​(java.util.function.Function<IndicesRequest.Builder,​ObjectBuilder<IndicesRequest>> fn)
    • bytes

      @Nullable public final Bytes bytes()
      The unit in which to display byte values

      API name: bytes

    • 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

    • health

      @Nullable public final HealthStatus health()
      A health status ("green", "yellow", or "red" to filter only indices matching the specified health status

      API name: health

    • includeUnloadedSegments

      @Nullable public final java.lang.Boolean includeUnloadedSegments()
      If set to true segment stats will include stats for segments that are not currently loaded into memory

      API name: include_unloaded_segments

    • index

      public final java.util.List<java.lang.String> index()
      A comma-separated list of index names to limit the returned information

      API name: index

    • pri

      @Nullable public final java.lang.Boolean pri()
      Set to true to return stats only for primary shards

      API name: pri