Package co.elastic.clients.elasticsearch.cat

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bytes

      public final AliasesRequest.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 AliasesRequest.Builder expandWildcards(List<ExpandWildcard> list)
      The 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. It supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final AliasesRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      The 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. It supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • h

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

    • masterTimeout

      public final AliasesRequest.Builder masterTimeout(@Nullable Time value)
      The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

      API name: master_timeout

    • masterTimeout

      public final AliasesRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

      API name: master_timeout

    • name

      public final AliasesRequest.Builder name(List<String> list)
      A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

      API name: name

      Adds all elements of list to name.

    • name

      public final AliasesRequest.Builder name(String value, String... values)
      A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

      API name: name

      Adds one or more values to name.

    • s

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

    • build

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