Package co.elastic.clients.elasticsearch.indices

Class CloseIndexRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final CloseIndexRequest.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

    • expandWildcards

      public final CloseIndexRequest.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 CloseIndexRequest.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 CloseIndexRequest.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 CloseIndexRequest.Builder index(List<String> list)
      Required - Comma-separated list or wildcard expression of index names used to limit the request.

      API name: index

      Adds all elements of list to index.

    • index

      public final CloseIndexRequest.Builder index(String value, String... values)
      Required - Comma-separated list or wildcard expression of index names used to limit the request.

      API name: index

      Adds one or more values to index.

    • masterTimeout

      public final CloseIndexRequest.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 CloseIndexRequest.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 CloseIndexRequest.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 CloseIndexRequest.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 CloseIndexRequest.Builder waitForActiveShards(@Nullable WaitForActiveShards 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

    • waitForActiveShards

      public final CloseIndexRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)
      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 CloseIndexRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<CloseIndexRequest.Builder>

    • build

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