96 lines
3.9 KiB
Plaintext
96 lines
3.9 KiB
Plaintext
|
[[java-rest-high-flush]]
|
||
|
|
=== Flush API
|
||
|
|
|
||
|
|
[[java-rest-high-flush-request]]
|
||
|
|
==== Flush Request
|
||
|
|
|
||
|
|
A `FlushRequest` can be applied to one or more indices, or even on `_all` the indices:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-request]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Flush one index
|
||
|
|
<2> Flush multiple indices
|
||
|
|
<3> Flush all the indices
|
||
|
|
|
||
|
|
==== Optional arguments
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-request-indicesOptions]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Setting `IndicesOptions` controls how unavailable indices are resolved and
|
||
|
|
how wildcard expressions are expanded
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-request-wait]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Set the `wait_if_ongoing` flag to `true`
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-request-force]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Set the `force` flag to `true`
|
||
|
|
|
||
|
|
[[java-rest-high-flush-sync]]
|
||
|
|
==== Synchronous Execution
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-execute]
|
||
|
|
--------------------------------------------------
|
||
|
|
|
||
|
|
[[java-rest-high-flush-async]]
|
||
|
|
==== Asynchronous Execution
|
||
|
|
|
||
|
|
The asynchronous execution of a flush request requires both the `FlushRequest`
|
||
|
|
instance and an `ActionListener` instance to be passed to the asynchronous
|
||
|
|
method:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-execute-async]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> The `FlushRequest` to execute and the `ActionListener` to use when
|
||
|
|
the execution completes
|
||
|
|
|
||
|
|
The asynchronous method does not block and returns immediately. Once it is
|
||
|
|
completed the `ActionListener` is called back using the `onResponse` method
|
||
|
|
if the execution successfully completed or using the `onFailure` method if
|
||
|
|
it failed.
|
||
|
|
|
||
|
|
A typical listener for `FlushResponse` looks like:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-execute-listener]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Called when the execution is successfully completed. The response is
|
||
|
|
provided as an argument
|
||
|
|
<2> Called in case of failure. The raised exception is provided as an argument
|
||
|
|
|
||
|
|
[[java-rest-high-flush-response]]
|
||
|
|
==== Flush Response
|
||
|
|
|
||
|
|
The returned `FlushResponse` allows to retrieve information about the
|
||
|
|
executed operation as follows:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-response]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Total number of shards hit by the flush request
|
||
|
|
<2> Number of shards where the flush has succeeded
|
||
|
|
<3> Number of shards where the flush has failed
|
||
|
|
<4> A list of failures if the operation failed on one or more shards
|
||
|
|
|
||
|
|
By default, if the indices were not found, an `ElasticsearchException` will be thrown:
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[flush-notfound]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Do something if the indices to be flushed were not found
|