Class RecoveryRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.indices.RecoveryRequest.Builder
All Implemented Interfaces:
ObjectBuilder<RecoveryRequest>
Enclosing class:
RecoveryRequest

public static class RecoveryRequest.Builder
extends java.lang.Object
implements ObjectBuilder<RecoveryRequest>
Builder for RecoveryRequest.
  • Constructor Summary

    Constructors
    Constructor Description
    Builder()  
  • Method Summary

    Modifier and Type Method Description
    RecoveryRequest.Builder activeOnly​(java.lang.Boolean value)
    Display only those recoveries that are currently on-going
    RecoveryRequest.Builder addIndex​(java.lang.String value)
    Add a value to index(List), creating the list if needed.
    RecoveryRequest build()
    Builds a RecoveryRequest.
    RecoveryRequest.Builder detailed​(java.lang.Boolean value)
    Whether to display detailed information about shard recovery
    RecoveryRequest.Builder index​(java.lang.String... value)
    A comma-separated list of index names; use _all or empty string to perform the operation on all indices
    RecoveryRequest.Builder index​(java.util.List<java.lang.String> value)
    A comma-separated list of index names; use _all or empty string to perform the operation on all indices

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • index

      public RecoveryRequest.Builder index​(@Nullable java.util.List<java.lang.String> value)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

    • index

      public RecoveryRequest.Builder index​(java.lang.String... value)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

    • addIndex

      public RecoveryRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed. 4
    • activeOnly

      public RecoveryRequest.Builder activeOnly​(@Nullable java.lang.Boolean value)
      Display only those recoveries that are currently on-going

      API name: active_only

    • detailed

      public RecoveryRequest.Builder detailed​(@Nullable java.lang.Boolean value)
      Whether to display detailed information about shard recovery

      API name: detailed

    • 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.