Package org.opensearch.client.opensearch.indices

Class CloseIndexRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<CloseIndexRequest.Builder>
org.opensearch.client.opensearch.indices.CloseIndexRequest.Builder
All Implemented Interfaces:
CopyableBuilder<CloseIndexRequest.Builder,CloseIndexRequest>, MutableBuilder<CloseIndexRequest.Builder,CloseIndexRequest>, ObjectBuilder<CloseIndexRequest>
Enclosing class:
CloseIndexRequest
public static class CloseIndexRequest.Builder extends RequestBase.AbstractBuilder<CloseIndexRequest.Builder> implements CopyableBuilder<CloseIndexRequest.Builder,CloseIndexRequest>
Builder for CloseIndexRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public CloseIndexRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<CloseIndexRequest.Builder,CloseIndexRequest>
      Returns:
      a new builder instance.

    • self

      @Nonnull protected CloseIndexRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<CloseIndexRequest.Builder>

    • allowNoIndices

      @Nonnull public final CloseIndexRequest.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 indexes. This behavior applies even if the request targets other open indexes.

      API name: allow_no_indices

    • clusterManagerTimeout

      @Nonnull public final CloseIndexRequest.Builder clusterManagerTimeout(@Nullable Time value)
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • clusterManagerTimeout

      @Nonnull public final CloseIndexRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • expandWildcards

      @Nonnull 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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      @Nonnull 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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

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

      @Nonnull 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

      @Nonnull 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

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

      API name: master_timeout

    • masterTimeout

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

      API name: master_timeout

    • timeout

      @Nonnull 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

      @Nonnull 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

      @Nonnull 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

      @Nonnull 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

    • build

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