Package co.elastic.clients.elasticsearch.indices

Class FieldUsageStatsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final FieldUsageStatsRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      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 FieldUsageStatsRequest.Builder expandWildcards​(java.util.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 FieldUsageStatsRequest.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.

    • fields

      public final FieldUsageStatsRequest.Builder fields​(java.util.List<java.lang.String> list)
      Comma-separated list or wildcard expressions of fields to include in the statistics.

      API name: fields

      Adds all elements of list to fields.

    • fields

      public final FieldUsageStatsRequest.Builder fields​(java.lang.String value, java.lang.String... values)
      Comma-separated list or wildcard expressions of fields to include in the statistics.

      API name: fields

      Adds one or more values to fields.

    • ignoreUnavailable

      public final FieldUsageStatsRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • index

      public final FieldUsageStatsRequest.Builder index​(java.util.List<java.lang.String> list)
      Required - Comma-separated list or wildcard expression of index names used to limit the request.

      API name: index

      Adds all elements of list to index.

    • index

      public final FieldUsageStatsRequest.Builder index​(java.lang.String value, java.lang.String... values)
      Required - Comma-separated list or wildcard expression of index names used to limit the request.

      API name: index

      Adds one or more values to index.

    • masterTimeout

      public final FieldUsageStatsRequest.Builder masterTimeout​(@Nullable Time value)
      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

    • masterTimeout

      public final FieldUsageStatsRequest.Builder masterTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      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

    • timeout

      public final FieldUsageStatsRequest.Builder timeout​(@Nullable Time value)
      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

    • timeout

      public final FieldUsageStatsRequest.Builder timeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      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

      public final FieldUsageStatsRequest.Builder waitForActiveShards​(@Nullable WaitForActiveShards value)
      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).

      API name: wait_for_active_shards

    • waitForActiveShards

      public final FieldUsageStatsRequest.Builder waitForActiveShards​(java.util.function.Function<WaitForActiveShards.Builder,​ObjectBuilder<WaitForActiveShards>> fn)
      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).

      API name: wait_for_active_shards

    • self

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

    • build

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