Package co.elastic.clients.elasticsearch.indices

Class UpgradeRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<UpgradeRequest.Builder>
co.elastic.clients.elasticsearch.indices.UpgradeRequest.Builder
All Implemented Interfaces:
WithJson<UpgradeRequest.Builder>, ObjectBuilder<UpgradeRequest>
Enclosing class:
UpgradeRequest
public static class UpgradeRequest.Builder extends RequestBase.AbstractBuilder<UpgradeRequest.Builder> implements ObjectBuilder<UpgradeRequest>
Builder for UpgradeRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final UpgradeRequest.Builder allowNoIndices(@Nullable Boolean value)
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      API name: allow_no_indices

    • expandWildcards

      public final UpgradeRequest.Builder expandWildcards(List<ExpandWildcard> list)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final UpgradeRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      public final UpgradeRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • index

      public final UpgradeRequest.Builder index(@Nullable String value)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

    • onlyAncientSegments

      public final UpgradeRequest.Builder onlyAncientSegments(@Nullable Boolean value)
      If true, only ancient (an older Lucene major release) segments will be upgraded

      API name: only_ancient_segments

    • waitForCompletion

      public final UpgradeRequest.Builder waitForCompletion(@Nullable Boolean value)
      Specify whether the request should block until the all segments are upgraded (default: false)

      API name: wait_for_completion

    • self

      protected UpgradeRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<UpgradeRequest.Builder>

    • build

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