Package org.opensearch.action.admin.indices.close

Class CloseIndexRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<CloseIndexRequest,CloseIndexResponse>

org.opensearch.action.support.clustermanager.ClusterManagerNodeOperationRequestBuilder<CloseIndexRequest,CloseIndexResponse,CloseIndexRequestBuilder>

org.opensearch.action.support.master.MasterNodeOperationRequestBuilder<CloseIndexRequest,CloseIndexResponse,CloseIndexRequestBuilder>

org.opensearch.action.support.master.AcknowledgedRequestBuilder<CloseIndexRequest,CloseIndexResponse,CloseIndexRequestBuilder>

org.opensearch.action.admin.indices.close.CloseIndexRequestBuilder

@PublicApi(since="1.0.0")
public class CloseIndexRequestBuilder
extends AcknowledgedRequestBuilder<CloseIndexRequest,CloseIndexResponse,CloseIndexRequestBuilder>

Builder for close index request

Opensearch.api:

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
CloseIndexRequestBuilder(OpenSearchClient client, CloseIndexAction action)
CloseIndexRequestBuilder(OpenSearchClient client, CloseIndexAction action, String... indices)

Method Summary

Modifier and Type	Method	Description
CloseIndexRequestBuilder	setIndices(String... indices)	Sets the indices to be closed
CloseIndexRequestBuilder	setIndicesOptions(IndicesOptions indicesOptions)	Specifies what type of requested indices to ignore and wildcard indices expressions For example indices that don't exist.
CloseIndexRequestBuilder	setWaitForActiveShards(int waitForActiveShards)	A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
CloseIndexRequestBuilder	setWaitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that should be active for indices closing to return.

Methods inherited from class org.opensearch.action.support.master.AcknowledgedRequestBuilder

setTimeout, setTimeout

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeOperationRequestBuilder

setClusterManagerNodeTimeout, setClusterManagerNodeTimeout, setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.opensearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

CloseIndexRequestBuilder

public CloseIndexRequestBuilder(OpenSearchClient client,
 CloseIndexAction action)

CloseIndexRequestBuilder

public CloseIndexRequestBuilder(OpenSearchClient client,
 CloseIndexAction action,
 String... indices)

Method Details

setIndices

public CloseIndexRequestBuilder setIndices(String... indices)

Sets the indices to be closed

Parameters:

indices - the indices to be closed

Returns:

the request itself

setIndicesOptions

public CloseIndexRequestBuilder setIndicesOptions(IndicesOptions indicesOptions)

Specifies what type of requested indices to ignore and wildcard indices expressions For example indices that don't exist.

Parameters:

indicesOptions - the desired behaviour regarding indices to ignore and indices wildcard expressions

Returns:

the request itself

setWaitForActiveShards

public CloseIndexRequestBuilder setWaitForActiveShards(ActiveShardCount waitForActiveShards)

Sets the number of shard copies that should be active for indices closing to return. Defaults to ActiveShardCount.DEFAULT, which will wait for one shard copy (the primary) to become active. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active before returning. Otherwise, use ActiveShardCount.from(int) to set this value to any non-negative integer, up to the number of copies per shard (number of replicas + 1), to wait for the desired amount of shard copies to become active before returning. Indices closing will only wait up until the timeout value for the number of shard copies to be active before returning.

Parameters:

waitForActiveShards - number of active shard copies to wait on

setWaitForActiveShards

public CloseIndexRequestBuilder setWaitForActiveShards(int waitForActiveShards)

A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.