mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 05:28:34 +00:00
075fdc579f
With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
72 lines
3.1 KiB
Plaintext
72 lines
3.1 KiB
Plaintext
[[java-rest-high-indices-exists]]
|
|
=== Indices Exists API
|
|
|
|
[[java-rest-high-indices-exists-request]]
|
|
==== Indices Exists Request
|
|
|
|
The high-level REST client uses a `GetIndexRequest` for Indices Exists API. The index name (or indices' names) are required.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[indices-exists-request]
|
|
--------------------------------------------------
|
|
<1> Index
|
|
|
|
[[java-rest-high-indices-exists-optional-args]]
|
|
==== Optional arguments
|
|
Indices Exists API also accepts following optional arguments, through a `GetIndexRequest`:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[indices-exists-request-optionals]
|
|
--------------------------------------------------
|
|
<1> Whether to return local information or retrieve the state from master node
|
|
<2> Return result in a format suitable for humans
|
|
<3> Whether to return all default setting for each of the indices
|
|
<4> Return settings in flat format
|
|
<5> Controls how unavailable indices are resolved and how wildcard expressions are expanded
|
|
|
|
[[java-rest-high-indices-sync]]
|
|
==== Synchronous Execution
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[indices-exists-response]
|
|
--------------------------------------------------
|
|
|
|
[[java-rest-high-indices-async]]
|
|
==== Asynchronous Execution
|
|
The asynchronous execution of an indices exists request requires both the
|
|
`GetIndexRequest` instance and an `ActionListener` instance to be passed
|
|
to the asynchronous method:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[indices-exists-async]
|
|
--------------------------------------------------
|
|
<1> The `GetIndexRequest` 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 the Indices Exists looks like:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[indices-exists-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-indices-exists-response]]
|
|
==== Response
|
|
The response is a `boolean` value, indicating whether the index (or indices) exist:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[indices-exists-response]
|
|
--------------------------------------------------
|