Package co.elastic.clients.elasticsearch.indices

Class IndicesStatsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • completionFields

      public final IndicesStatsRequest.Builder completionFields​(java.util.List<java.lang.String> list)
      Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

      API name: completion_fields

      Adds all elements of list to completionFields.

    • completionFields

      public final IndicesStatsRequest.Builder completionFields​(java.lang.String value, java.lang.String... values)
      Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

      API name: completion_fields

      Adds one or more values to completionFields.

    • expandWildcards

      public final IndicesStatsRequest.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 IndicesStatsRequest.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.

    • fielddataFields

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

      API name: fielddata_fields

      Adds all elements of list to fielddataFields.

    • fielddataFields

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

      API name: fielddata_fields

      Adds one or more values to fielddataFields.

    • fields

      public final IndicesStatsRequest.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 IndicesStatsRequest.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.

    • forbidClosedIndices

      public final IndicesStatsRequest.Builder forbidClosedIndices​(@Nullable java.lang.Boolean value)
      If true, statistics are not collected from closed indices.

      API name: forbid_closed_indices

    • groups

      public final IndicesStatsRequest.Builder groups​(java.util.List<java.lang.String> list)
      Comma-separated list of search groups to include in the search statistics.

      API name: groups

      Adds all elements of list to groups.

    • groups

      public final IndicesStatsRequest.Builder groups​(java.lang.String value, java.lang.String... values)
      Comma-separated list of search groups to include in the search statistics.

      API name: groups

      Adds one or more values to groups.

    • includeSegmentFileSizes

      public final IndicesStatsRequest.Builder includeSegmentFileSizes​(@Nullable java.lang.Boolean value)
      If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

      API name: include_segment_file_sizes

    • includeUnloadedSegments

      public final IndicesStatsRequest.Builder includeUnloadedSegments​(@Nullable java.lang.Boolean value)
      If true, the response includes information from segments that are not loaded into memory.

      API name: include_unloaded_segments

    • index

      public final IndicesStatsRequest.Builder index​(java.util.List<java.lang.String> list)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

      Adds all elements of list to index.

    • index

      public final IndicesStatsRequest.Builder index​(java.lang.String value, java.lang.String... values)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

      Adds one or more values to index.

    • level

      public final IndicesStatsRequest.Builder level​(@Nullable Level value)
      Indicates whether statistics are aggregated at the cluster, index, or shard level.

      API name: level

    • metric

      public final IndicesStatsRequest.Builder metric​(java.util.List<java.lang.String> list)
      Limit the information returned the specific metrics.

      API name: metric

      Adds all elements of list to metric.

    • metric

      public final IndicesStatsRequest.Builder metric​(java.lang.String value, java.lang.String... values)
      Limit the information returned the specific metrics.

      API name: metric

      Adds one or more values to metric.

    • self

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

    • build

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