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
Analyzes the disk usage of each field of an index or data stream
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 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

    • masterTimeout

      @Nullable public final TimeUnit masterTimeout()
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • 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

    • timeout

      @Nullable public final TimeUnit timeout()
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • waitForActiveShards

      @Nullable public final String waitForActiveShards()
      The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). Default: 1, the primary shard.

      API name: wait_for_active_shards