Package co.elastic.clients.elasticsearch.indices

Class DiskUsageRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.DiskUsageRequest
public class DiskUsageRequest extends RequestBase
Analyze the index disk usage.

Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.

NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index store_size value because some small metadata files are ignored and some parts of data files might not be scanned by the API. Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. The stored size of the _id field is likely underestimated while the _source field is overestimated.

For usage examples see the External documentation or refer to Analyze the index disk usage example for an example.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

    • flush

      @Nullable public final Boolean flush()
      If true, the API performs a flush before analysis. If false, the response may not include uncommitted data.

      API name: flush

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • index

      public final List<String> index()
      Required - Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly.

      API name: index

    • runExpensiveTasks

      @Nullable public final Boolean runExpensiveTasks()
      Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to true.

      API name: run_expensive_tasks

    • rebuild

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