Package co.elastic.clients.elasticsearch.cat

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • activeOnly

      public final RecoveryRequest.Builder activeOnly(@Nullable Boolean value)
      If true, the response only includes ongoing shard recoveries.

      API name: active_only

    • bytes

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

    • detailed

      public final RecoveryRequest.Builder detailed(@Nullable Boolean value)
      If true, the response includes detailed information about shard recoveries.

      API name: detailed

    • h

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

    • s

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

    • build

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