Package co.elastic.clients.elasticsearch.cat

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowClosed

      public final SegmentsRequest.Builder allowClosed(@Nullable Boolean value)
      If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices

      API name: allow_closed

    • allowNoIndices

      public final SegmentsRequest.Builder allowNoIndices(@Nullable Boolean value)
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • bytes

      public final SegmentsRequest.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 SegmentsRequest.Builder expandWildcards(List<ExpandWildcard> list)
      Type of index that wildcard expressions 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

      public final SegmentsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      Type of index that wildcard expressions 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.

    • h

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

    • ignoreThrottled

      public final SegmentsRequest.Builder ignoreThrottled(@Nullable Boolean value)
      If true, concrete, expanded or aliased indices are ignored when frozen.

      API name: ignore_throttled

    • ignoreUnavailable

      public final SegmentsRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • index

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

    • local

      public final SegmentsRequest.Builder local(@Nullable Boolean value)
      If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

      API name: local

    • masterTimeout

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

      API name: master_timeout

    • masterTimeout

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

      API name: master_timeout

    • s

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

    • build

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