Package co.elastic.clients.elasticsearch.indices

Class FreezeRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.indices.FreezeRequest.Builder
All Implemented Interfaces:
ObjectBuilder<FreezeRequest>
Enclosing class:
FreezeRequest
public static class FreezeRequest.Builder
extends java.lang.Object
implements ObjectBuilder<FreezeRequest>
Builder for FreezeRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

      public FreezeRequest.Builder index​(java.lang.String value)
      Required - The name of the index to freeze

      API name: index

    • allowNoIndices

      public FreezeRequest.Builder allowNoIndices​(@Nullable java.lang.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 FreezeRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • expandWildcards

      public FreezeRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • addExpandWildcards

      public FreezeRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed.

    • ignoreUnavailable

      public FreezeRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • masterTimeout

      public FreezeRequest.Builder masterTimeout​(@Nullable java.lang.String value)
      Specify timeout for connection to master

      API name: master_timeout

    • timeout

      public FreezeRequest.Builder timeout​(@Nullable java.lang.String value)
      Explicit operation timeout

      API name: timeout

    • waitForActiveShards

      public FreezeRequest.Builder waitForActiveShards​(@Nullable jakarta.json.JsonValue value)
      Sets the number of active shards to wait for before the operation returns.

      API name: wait_for_active_shards

    • build

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