Package co.elastic.clients.elasticsearch.cat

Class ShardsRequest.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<ShardsRequest.Builder>
co.elastic.clients.elasticsearch.cat.ShardsRequest.Builder
All Implemented Interfaces:
WithJson<ShardsRequest.Builder>, ObjectBuilder<ShardsRequest>
Enclosing class:
ShardsRequest
public static class ShardsRequest.Builder extends CatRequestBase.AbstractBuilder<ShardsRequest.Builder> implements ObjectBuilder<ShardsRequest>
Builder for ShardsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bytes

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

    • h

      public final ShardsRequest.Builder h(List<String> list)
      List of columns to appear in the response. Supports simple wildcards.

      API name: h

      Adds all elements of list to h.

    • h

      public final ShardsRequest.Builder h(String value, String... values)
      List of columns to appear in the response. Supports simple wildcards.

      API name: h

      Adds one or more values to h.

    • h

      public final ShardsRequest.Builder h(CatShardColumn value, CatShardColumn... values)
      List of columns to appear in the response. Supports simple wildcards.

      API name: h

      Adds one or more enum values to h.

    • index

      public final ShardsRequest.Builder index(List<String> list)
      A 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 ShardsRequest.Builder index(String value, String... values)
      A 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 ShardsRequest.Builder masterTimeout(@Nullable Time value)
      The period to wait for a connection to the master node.

      API name: master_timeout

    • masterTimeout

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

      API name: master_timeout

    • s

      public final ShardsRequest.Builder s(List<String> list)
      A comma-separated list of column names or aliases that determines the sort order. 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 ShardsRequest.Builder s(String value, String... values)
      A comma-separated list of column names or aliases that determines the sort order. 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 ShardsRequest.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 ShardsRequest.Builder self()
      Specified by:
      self in class CatRequestBase.AbstractBuilder<ShardsRequest.Builder>

    • build

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