Class CloseIndexRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CloseIndexRequest.Builder>
co.elastic.clients.elasticsearch.indices.CloseIndexRequest.Builder
- All Implemented Interfaces:
WithJson<CloseIndexRequest.Builder>
,ObjectBuilder<CloseIndexRequest>
- Enclosing class:
- CloseIndexRequest
public static class CloseIndexRequest.Builder
extends RequestBase.AbstractBuilder<CloseIndexRequest.Builder>
implements ObjectBuilder<CloseIndexRequest>
Builder for
CloseIndexRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.build()
Builds aCloseIndexRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.ignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)Required - A comma separated list of indices to closeRequired - A comma separated list of indices to closemasterTimeout
(Time value) Specify timeout for connection to masterSpecify timeout for connection to masterprotected CloseIndexRequest.Builder
self()
Explicit operation timeoutExplicit operation timeoutSets the number of active shards to wait for before the operation returns.Sets the number of active shards to wait for before the operation returns.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toexpandWildcards
. -
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
. -
index
Required - A comma separated list of indices to closeAPI name:
index
Adds all elements of
list
toindex
. -
index
Required - A comma separated list of indices to closeAPI name:
index
Adds one or more values to
index
. -
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
Sets the number of active shards to wait for before the operation returns.API name:
wait_for_active_shards
-
waitForActiveShards
public final CloseIndexRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) Sets the number of active shards to wait for before the operation returns.API name:
wait_for_active_shards
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<CloseIndexRequest.Builder>
-
build
Builds aCloseIndexRequest
.- Specified by:
build
in interfaceObjectBuilder<CloseIndexRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-