Package co.elastic.clients.elasticsearch.indices

Class DiskUsageRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<DiskUsageRequest.Builder>
co.elastic.clients.elasticsearch.indices.DiskUsageRequest.Builder
All Implemented Interfaces:
WithJson<DiskUsageRequest.Builder>, ObjectBuilder<DiskUsageRequest>
Enclosing class:
DiskUsageRequest
public static class DiskUsageRequest.Builder extends RequestBase.AbstractBuilder<DiskUsageRequest.Builder> implements ObjectBuilder<DiskUsageRequest>
Builder for DiskUsageRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final DiskUsageRequest.Builder allowNoIndices(@Nullable Boolean value)
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

      public final DiskUsageRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final DiskUsageRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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

      Adds one or more values to expandWildcards.

    • flush

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

      API name: flush

    • ignoreUnavailable

      public final DiskUsageRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

      public final DiskUsageRequest.Builder index(List<String> list)
      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

      Adds all elements of list to index.

    • index

      public final DiskUsageRequest.Builder index(String value, String... values)
      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

      Adds one or more values to index.

    • runExpensiveTasks

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

      API name: run_expensive_tasks

    • self

      protected DiskUsageRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<DiskUsageRequest.Builder>

    • build

      public DiskUsageRequest build()
      Builds a DiskUsageRequest.
      Specified by:
      build in interface ObjectBuilder<DiskUsageRequest>
      Throws:
      NullPointerException - if some of the required fields are null.