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 java.lang.Boolean value)
      If true, the response only includes ongoing shard recoveries

      API name: active_only

    • bytes

      public final RecoveryRequest.Builder bytes​(@Nullable Bytes value)
      The unit in which to display byte values

      API name: bytes

    • detailed

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

      API name: detailed

    • index

      public final RecoveryRequest.Builder index​(java.util.List<java.lang.String> list)
      Comma-separated list or wildcard expression of index names to limit the returned information

      API name: index

      Adds all elements of list to index.

    • index

      public final RecoveryRequest.Builder index​(java.lang.String value, java.lang.String... values)
      Comma-separated list or wildcard expression of index names to limit the returned information

      API name: index

      Adds one or more values to index.

    • 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:
      java.lang.NullPointerException - if some of the required fields are null.