Package co.elastic.clients.elasticsearch.indices

Class UnfreezeRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final UnfreezeRequest.Builder allowNoIndices(@Nullable Boolean value)
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

      API name: allow_no_indices

    • expandWildcards

      public final UnfreezeRequest.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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final UnfreezeRequest.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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

      public final UnfreezeRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • index

      public final UnfreezeRequest.Builder index(String value)
      Required - Identifier for the index.

      API name: index

    • masterTimeout

      public final UnfreezeRequest.Builder masterTimeout(@Nullable Time value)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • masterTimeout

      public final UnfreezeRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • timeout

      public final UnfreezeRequest.Builder timeout(@Nullable Time value)
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • timeout

      public final UnfreezeRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • waitForActiveShards

      public final UnfreezeRequest.Builder waitForActiveShards(@Nullable String value)
      The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      API name: wait_for_active_shards

    • self

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

    • build

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