Class CloseRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.CloseRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
public final class CloseRequest extends RequestBase
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CloseRequest.Builder
Builder forCloseRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<CloseRequest,CloseResponse,ElasticsearchError>
ENDPOINT
Endpoint "indices.close
". -
Constructor Summary
Constructors Constructor Description CloseRequest(CloseRequest.Builder builder)
CloseRequest(java.util.function.Function<CloseRequest.Builder,CloseRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
Whether to ignore if a wildcard indices expression resolves into no concrete indices.java.util.List<ExpandWildcardOptions>
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 closejava.lang.String
masterTimeout()
Specify timeout for connection to masterjava.lang.String
timeout()
Explicit operation timeoutjakarta.json.JsonValue
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 Details
-
ENDPOINT
Endpoint "indices.close
".
-
-
Constructor Details
-
CloseRequest
-
CloseRequest
-
-
Method Details
-
index
public java.util.List<java.lang.String> index()Required - A comma separated list of indices to closeAPI name:
index
-
allowNoIndices
@Nullable public 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
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
masterTimeout
@Nullable public java.lang.String masterTimeout()Specify timeout for connection to masterAPI name:
master_timeout
-
timeout
@Nullable public java.lang.String timeout()Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
@Nullable public jakarta.json.JsonValue 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
-