Nik Everett ef6fc1e9fd
Docs: HighLevelRestClient#ping (#29070)
Add documentation for `HighLevelRestClient#ping`.

Relates to #28389
2018-03-14 14:27:01 -04:00

14 lines
422 B
Plaintext

[[java-rest-high-ping]]
=== Ping API
[[java-rest-high-ping-request]]
==== Execution
The `ping()` method checks if the cluster is up and available to
process requests and returns a boolean:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/MiscellaneousDocumentationIT.java[ping-execute]
--------------------------------------------------