Package org.opensearch.client.opensearch.indices

Class CloseIndexRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.CloseIndexRequest.Builder

All Implemented Interfaces:

ObjectBuilder<CloseIndexRequest>

Enclosing class:

CloseIndexRequest

public static class CloseIndexRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<CloseIndexRequest>

Builder for CloseIndexRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloseIndexRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
CloseIndexRequest	build()	Builds a CloseIndexRequest.
CloseIndexRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
CloseIndexRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
CloseIndexRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
CloseIndexRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
CloseIndexRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
CloseIndexRequest.Builder	index(java.lang.String value, java.lang.String... values)	Required - A comma separated list of indices to close
CloseIndexRequest.Builder	index(java.util.List<java.lang.String> list)	Required - A comma separated list of indices to close
CloseIndexRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
CloseIndexRequest.Builder	masterTimeout(Time value)	Deprecated.
CloseIndexRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
CloseIndexRequest.Builder	timeout(Time value)	Explicit operation timeout
CloseIndexRequest.Builder	waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Sets the number of active shards to wait for before the operation returns.
CloseIndexRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Sets the number of active shards to wait for before the operation returns.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

allowNoIndices

public final CloseIndexRequest.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 final CloseIndexRequest.Builder expandWildcards(java.util.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 CloseIndexRequest.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 CloseIndexRequest.Builder ignoreUnavailable(@Nullable
                                                         java.lang.Boolean value)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final CloseIndexRequest.Builder index(java.util.List<java.lang.String> list)

Required - A comma separated list of indices to close

API name: index

Adds all elements of list to index.

index

public final CloseIndexRequest.Builder index(java.lang.String value,
                                             java.lang.String... values)

Required - A comma separated list of indices to close

API name: index

Adds one or more values to index.

masterTimeout

@Deprecated
public final CloseIndexRequest.Builder masterTimeout(@Nullable
                                                     Time value)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final CloseIndexRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

public final CloseIndexRequest.Builder clusterManagerTimeout(@Nullable
                                                             Time value)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final CloseIndexRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

timeout

public final CloseIndexRequest.Builder timeout(@Nullable
                                               Time value)

Explicit operation timeout

API name: timeout

timeout

public final CloseIndexRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

waitForActiveShards

public final CloseIndexRequest.Builder waitForActiveShards(@Nullable
                                                           WaitForActiveShards value)

Sets the number of active shards to wait for before the operation returns. Set to index-setting to wait according to the index setting index.write.wait_for_active_shards, or all to wait for all shards, or an integer. Defaults to 0.

API name: wait_for_active_shards

waitForActiveShards

public final CloseIndexRequest.Builder waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)

Sets the number of active shards to wait for before the operation returns. Set to index-setting to wait according to the index setting index.write.wait_for_active_shards, or all to wait for all shards, or an integer. Defaults to 0.

API name: wait_for_active_shards

build

public CloseIndexRequest build()

Builds a CloseIndexRequest.

Specified by:

build in interface ObjectBuilder<CloseIndexRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.