Package co.elastic.clients.elasticsearch.indices

Class IndicesStatsRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.indices.IndicesStatsRequest.Builder
All Implemented Interfaces:
ObjectBuilder<IndicesStatsRequest>
Enclosing class:
IndicesStatsRequest
public static class IndicesStatsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<IndicesStatsRequest>
Builder for IndicesStatsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • metric

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

      API name: metric

    • metric

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

      API name: metric

    • addMetric

      public IndicesStatsRequest.Builder addMetric​(java.lang.String value)
      Add a value to metric(List), creating the list if needed.

    • index

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

      API name: index

    • index

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

      API name: index

    • addIndex

      public IndicesStatsRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.

    • completionFields

      public IndicesStatsRequest.Builder completionFields​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)

      API name: completion_fields

    • completionFields

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

      API name: completion_fields

    • addCompletionFields

      public IndicesStatsRequest.Builder addCompletionFields​(java.lang.String value)
      Add a value to completionFields(List), creating the list if needed.

    • expandWildcards

      public IndicesStatsRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • expandWildcards

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

      API name: expand_wildcards

    • addExpandWildcards

      public IndicesStatsRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed.

    • fielddataFields

      public IndicesStatsRequest.Builder fielddataFields​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of fields for fielddata index metric (supports wildcards)

      API name: fielddata_fields

    • fielddataFields

      public IndicesStatsRequest.Builder fielddataFields​(java.lang.String... value)
      A comma-separated list of fields for fielddata index metric (supports wildcards)

      API name: fielddata_fields

    • addFielddataFields

      public IndicesStatsRequest.Builder addFielddataFields​(java.lang.String value)
      Add a value to fielddataFields(List), creating the list if needed.

    • fields

      public IndicesStatsRequest.Builder fields​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

      API name: fields

    • fields

      public IndicesStatsRequest.Builder fields​(java.lang.String... value)
      A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

      API name: fields

    • addFields

      public IndicesStatsRequest.Builder addFields​(java.lang.String value)
      Add a value to fields(List), creating the list if needed.

    • forbidClosedIndices

      public IndicesStatsRequest.Builder forbidClosedIndices​(@Nullable java.lang.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 IndicesStatsRequest.Builder groups​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of search groups for search index metric

      API name: groups

    • groups

      public IndicesStatsRequest.Builder groups​(java.lang.String... value)
      A comma-separated list of search groups for search index metric

      API name: groups

    • addGroups

      public IndicesStatsRequest.Builder addGroups​(java.lang.String value)
      Add a value to groups(List), creating the list if needed.

    • includeSegmentFileSizes

      public IndicesStatsRequest.Builder includeSegmentFileSizes​(@Nullable java.lang.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 IndicesStatsRequest.Builder includeUnloadedSegments​(@Nullable java.lang.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

    • level

      public IndicesStatsRequest.Builder level​(@Nullable Level value)
      Return stats aggregated at cluster, index or shard level

      API name: level

    • types

      public IndicesStatsRequest.Builder types​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of document types for the indexing index metric

      API name: types

    • types

      public IndicesStatsRequest.Builder types​(java.lang.String... value)
      A comma-separated list of document types for the indexing index metric

      API name: types

    • addTypes

      public IndicesStatsRequest.Builder addTypes​(java.lang.String value)
      Add a value to types(List), creating the list if needed.

    • 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.