Class FlushRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.FlushRequest
public class FlushRequest extends RequestBase
Performs the flush operation on one or more indices.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FlushRequest.Builder
Builder forFlushRequest
.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<FlushRequest,FlushResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.flush
". -
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<ExpandWildcard>
expandWildcards()
Whether to expand wildcard expression to concrete indices that are open, closed or both.java.lang.Boolean
force()
Whether a flush should be forced even if it is not necessarily needed ie.java.lang.Boolean
ignoreUnavailable()
Whether specified concrete indices should be ignored when unavailable (missing or closed)java.util.List<java.lang.String>
index()
A comma-separated list of index names; use_all
or empty string for all indicesstatic FlushRequest
of(java.util.function.Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> fn)
java.lang.Boolean
waitIfOngoing()
If set to true the flush operation will block until the flush can be executed if another flush operation is already executing.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "indices.flush
".
-
-
Method Details
-
of
public static FlushRequest of(java.util.function.Function<FlushRequest.Builder,ObjectBuilder<FlushRequest>> 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
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
force
@Nullable public final java.lang.Boolean force()Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)API name:
force
-
index
public final java.util.List<java.lang.String> index()A comma-separated list of index names; use_all
or empty string for all indicesAPI name:
index
-
waitIfOngoing
@Nullable public final java.lang.Boolean waitIfOngoing()If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.API name:
wait_if_ongoing
-