Package co.elastic.clients.elasticsearch.indices

Class RecoveryRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<RecoveryRequest.Builder>
co.elastic.clients.elasticsearch.indices.RecoveryRequest.Builder
All Implemented Interfaces:
WithJson<RecoveryRequest.Builder>, ObjectBuilder<RecoveryRequest>
Enclosing class:
RecoveryRequest
public static class RecoveryRequest.Builder extends RequestBase.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

    • allowNoIndices

      public final RecoveryRequest.Builder allowNoIndices(@Nullable Boolean value)
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • detailed

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

      API name: detailed

    • expandWildcards

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

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

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

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      public final RecoveryRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

      public final RecoveryRequest.Builder index(List<String> list)
      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)
      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.

    • self

      protected RecoveryRequest.Builder self()
      Specified by:
      self in class RequestBase.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.