Package org.opensearch.client.opensearch.indices

Class IndicesStatsRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<IndicesStatsRequest.Builder>
org.opensearch.client.opensearch.indices.IndicesStatsRequest.Builder
All Implemented Interfaces:
CopyableBuilder<IndicesStatsRequest.Builder,IndicesStatsRequest>, MutableBuilder<IndicesStatsRequest.Builder,IndicesStatsRequest>, ObjectBuilder<IndicesStatsRequest>
Enclosing class:
IndicesStatsRequest
public static class IndicesStatsRequest.Builder extends RequestBase.AbstractBuilder<IndicesStatsRequest.Builder> implements CopyableBuilder<IndicesStatsRequest.Builder,IndicesStatsRequest>
Builder for IndicesStatsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public IndicesStatsRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<IndicesStatsRequest.Builder,IndicesStatsRequest>
      Returns:
      a new builder instance.

    • self

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

    • completionFields

      @Nonnull public final IndicesStatsRequest.Builder completionFields(List<String> list)
      A comma-separated list or wildcard expressions of fields to include in field data and suggest statistics.

      API name: completion_fields

      Adds all elements of list to completionFields.

    • completionFields

      @Nonnull public final IndicesStatsRequest.Builder completionFields(String value, String... values)
      A comma-separated list or wildcard expressions of fields to include in field data and suggest statistics.

      API name: completion_fields

      Adds one or more values to completionFields.

    • expandWildcards

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

      @Nonnull 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

      @Nonnull public final IndicesStatsRequest.Builder fielddataFields(List<String> list)
      A comma-separated list or wildcard expressions of fields to include in field data statistics.

      API name: fielddata_fields

      Adds all elements of list to fielddataFields.

    • fielddataFields

      @Nonnull public final IndicesStatsRequest.Builder fielddataFields(String value, String... values)
      A comma-separated list or wildcard expressions of fields to include in field data statistics.

      API name: fielddata_fields

      Adds one or more values to fielddataFields.

    • fields

      @Nonnull public final IndicesStatsRequest.Builder fields(List<String> list)
      A comma-separated list or wildcard expressions of fields to include in the statistics.

      API name: fields

      Adds all elements of list to fields.

    • fields

      @Nonnull public final IndicesStatsRequest.Builder fields(String value, String... values)
      A comma-separated list or wildcard expressions of fields to include in the statistics.

      API name: fields

      Adds one or more values to fields.

    • forbidClosedIndices

      @Nonnull public final IndicesStatsRequest.Builder forbidClosedIndices(@Nullable Boolean value)
      If true, statistics are not collected from closed indexes.

      API name: forbid_closed_indices

    • groups

      @Nonnull public final IndicesStatsRequest.Builder groups(List<String> list)
      A comma-separated list of search groups to include in the search statistics.

      API name: groups

      Adds all elements of list to groups.

    • groups

      @Nonnull public final IndicesStatsRequest.Builder groups(String value, String... values)
      A comma-separated list of search groups to include in the search statistics.

      API name: groups

      Adds one or more values to groups.

    • includeSegmentFileSizes

      @Nonnull public final IndicesStatsRequest.Builder includeSegmentFileSizes(@Nullable 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

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

      API name: include_unloaded_segments

    • index

      @Nonnull 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 indexes

      API name: index

      Adds all elements of list to index.

    • index

      @Nonnull 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 indexes

      API name: index

      Adds one or more values to index.

    • level

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

      API name: level

    • metric

      @Nonnull public final IndicesStatsRequest.Builder metric(List<IndicesStatsMetric> list)
      Limit the information returned the specific metrics.

      API name: metric

      Adds all elements of list to metric.

    • metric

      @Nonnull public final IndicesStatsRequest.Builder metric(IndicesStatsMetric value, IndicesStatsMetric... values)
      Limit the information returned the specific metrics.

      API name: metric

      Adds one or more values to metric.

    • build

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