Package co.elastic.clients.elasticsearch.cat

Class IndicesRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bytes

      public final IndicesRequest.Builder bytes(@Nullable Bytes value)
      Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: bytes

    • expandWildcards

      public final IndicesRequest.Builder expandWildcards(List<ExpandWildcard> list)
      The type of index that wildcard patterns can match.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final IndicesRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      The type of index that wildcard patterns can match.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • h

      public final IndicesRequest.Builder h(List<String> list)
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

      Adds all elements of list to h.

    • h

      public final IndicesRequest.Builder h(String value, String... values)
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

      Adds one or more values to h.

    • h

      public final IndicesRequest.Builder h(CatIndicesColumn value, CatIndicesColumn... values)
      A comma-separated list of columns names to display. It supports simple wildcards.

      API name: h

      Adds one or more enum values to h.

    • health

      public final IndicesRequest.Builder health(@Nullable HealthStatus value)
      The health status used to limit returned indices. By default, the response includes indices of any health status.

      API name: health

    • includeUnloadedSegments

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

      public final IndicesRequest.Builder index(List<String> list)
      Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      API name: index

      Adds all elements of list to index.

    • index

      public final IndicesRequest.Builder index(String value, String... values)
      Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      API name: index

      Adds one or more values to index.

    • masterTimeout

      public final IndicesRequest.Builder masterTimeout(@Nullable Time value)
      Period to wait for a connection to the master node.

      API name: master_timeout

    • masterTimeout

      public final IndicesRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Period to wait for a connection to the master node.

      API name: master_timeout

    • pri

      public final IndicesRequest.Builder pri(@Nullable Boolean value)
      If true, the response only includes information from primary shards.

      API name: pri

    • s

      public final IndicesRequest.Builder s(List<String> list)
      List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      API name: s

      Adds all elements of list to s.

    • s

      public final IndicesRequest.Builder s(String value, String... values)
      List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

      API name: s

      Adds one or more values to s.

    • time

      public final IndicesRequest.Builder time(@Nullable TimeUnit value)
      Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: time

    • self

      protected IndicesRequest.Builder self()
      Specified by:
      self in class CatRequestBase.AbstractBuilder<IndicesRequest.Builder>

    • build

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