Package co.elastic.clients.elasticsearch.cat

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bytes

      public final CountRequest.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 CountRequest.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 CountRequest.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 CountRequest.Builder h(CatCountColumn value, CatCountColumn... 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.

    • index

      public final CountRequest.Builder index(List<String> list)
      A comma-separated list of data streams, indices, and aliases used to limit the request. It 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 CountRequest.Builder index(String value, String... values)
      A comma-separated list of data streams, indices, and aliases used to limit the request. It 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.

    • projectRouting

      public final CountRequest.Builder projectRouting(@Nullable String value)
      Specifies a subset of projects to target for the search using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples: _alias:my-project _alias:_origin _alias:pr Supported in serverless only.

      API name: project_routing

    • s

      public final CountRequest.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 CountRequest.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 CountRequest.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 CountRequest.Builder self()
      Specified by:
      self in class CatRequestBase.AbstractBuilder<CountRequest.Builder>

    • build

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