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(List<String> list)
      A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)

      API name: completion_fields

      Adds all elements of list to completionFields.

    • completionFields

      public final IndicesStatsRequest.Builder completionFields(String value, String... values)
      A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)

      API name: completion_fields

      Adds one or more values to completionFields.

    • expandWildcards

      public final IndicesStatsRequest.Builder expandWildcards(List<ExpandWildcard> list)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final IndicesStatsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • fielddataFields

      public final IndicesStatsRequest.Builder fielddataFields(List<String> list)
      A comma-separated list of fields for fielddata index metric (supports wildcards)

      API name: fielddata_fields

      Adds all elements of list to fielddataFields.

    • fielddataFields

      public final IndicesStatsRequest.Builder fielddataFields(String value, String... values)
      A comma-separated list of fields for fielddata index metric (supports wildcards)

      API name: fielddata_fields

      Adds one or more values to fielddataFields.

    • fields

      public final IndicesStatsRequest.Builder fields(List<String> list)
      A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

      API name: fields

      Adds all elements of list to fields.

    • fields

      public final IndicesStatsRequest.Builder fields(String value, String... values)
      A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

      API name: fields

      Adds one or more values to fields.

    • forbidClosedIndices

      public final IndicesStatsRequest.Builder forbidClosedIndices(@Nullable Boolean value)
      If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices

      API name: forbid_closed_indices

    • groups

      public final IndicesStatsRequest.Builder groups(List<String> list)
      A comma-separated list of search groups for search index metric

      API name: groups

      Adds all elements of list to groups.

    • groups

      public final IndicesStatsRequest.Builder groups(String value, String... values)
      A comma-separated list of search groups for search index metric

      API name: groups

      Adds one or more values to groups.

    • includeSegmentFileSizes

      public final IndicesStatsRequest.Builder includeSegmentFileSizes(@Nullable Boolean value)
      Whether to report 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 Boolean value)
      If set to true segment stats will include stats for segments that are not currently loaded into memory

      API name: include_unloaded_segments

    • index

      public final IndicesStatsRequest.Builder index(List<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(String value, 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)
      Return stats aggregated at cluster, index or shard level

      API name: level

    • metric

      public final IndicesStatsRequest.Builder metric(List<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(String value, String... values)
      Limit the information returned the specific metrics.

      API name: metric

      Adds one or more values to metric.

    • types

      public final IndicesStatsRequest.Builder types(List<String> list)
      A comma-separated list of document types for the indexing index metric

      API name: types

      Adds all elements of list to types.

    • types

      public final IndicesStatsRequest.Builder types(String value, String... values)
      A comma-separated list of document types for the indexing index metric

      API name: types

      Adds one or more values to types.

    • 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:
      NullPointerException - if some of the required fields are null.