Package org.opensearch.client.opensearch.indices

Class CloseIndexRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.CloseIndexRequest

public class CloseIndexRequest
extends RequestBase

Closes an index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CloseIndexRequest.Builder	Builder for CloseIndexRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<CloseIndexRequest,CloseIndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.close".

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<CloseIndexRequest,CloseIndexResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.close".

Method Detail

of

public static CloseIndexRequest of(java.util.function.Function<CloseIndexRequest.Builder,ObjectBuilder<CloseIndexRequest>> fn)

allowNoIndices

@Nullable
public final java.lang.Boolean allowNoIndices()

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 java.util.List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

index

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

Required - A comma separated list of indices to close

API name: index

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

waitForActiveShards

@Nullable
public final WaitForActiveShards waitForActiveShards()

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