Class CloseIndexRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.CloseIndexRequest
Closes an index.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<CloseIndexRequest,
CloseIndexResponse, ErrorResponse> Endpoint "indices.close
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to ignore if a wildcard indices expression resolves into no concrete indices.final List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)index()
Required - A comma separated list of indices to closefinal Time
Specify timeout for connection to masterstatic CloseIndexRequest
final Time
timeout()
Explicit operation timeoutfinal WaitForActiveShards
Sets the number of active shards to wait for before the operation returns.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "indices.close
".
-
-
Method Details
-
of
public static CloseIndexRequest of(Function<CloseIndexRequest.Builder, ObjectBuilder<CloseIndexRequest>> fn) -
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
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
index
Required - A comma separated list of indices to closeAPI name:
index
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
Sets the number of active shards to wait for before the operation returns. Set toindex-setting
to wait according to the index settingindex.write.wait_for_active_shards
, orall
to wait for all shards, or an integer. Defaults to0
.API name:
wait_for_active_shards
-