Docs: HighLevelRestClient#exists #29073
Conversation
Add documentation for `HighLevelRestClient#exists`. Relates to elastic#28389
|
Pinging @elastic/es-core-infra |
| [[java-rest-high-document-exists-request]] | ||
| ==== Exists Request | ||
|
|
||
| The `exists()` API is `true` if a document exists, and `false` otherwise. |
There was a problem hiding this comment.
Hm... In most docs there is no explanation what the API is for ( just how to use it )
Should this be moved into the above section?
There was a problem hiding this comment.
Yeah, I should move it to the section above.
I can use returns instead of is, sure. I wanted to use is because async calls don't really return, but is is much less clear. returns is almost certainly better.
| The `exists()` API is `true` if a document exists, and `false` otherwise. | ||
| It uses `GetRequest` just like the <<java-rest-high-document-get>>. | ||
| All of its <<java-rest-high-document-get-request-optional-arguments, optional arguments>> | ||
| are supported. Since `exists()` only returns `true` or false, we recommend |
There was a problem hiding this comment.
false wrapped with backticks as well?
| include-tagged::{doc-tests}/CRUDDocumentationIT.java[exists-execute-async] | ||
| -------------------------------------------------- | ||
| <1> The `GetRequest` to execute and the `ActionListener` to use when | ||
| the execution completes |
| // tag::exists-request | ||
| GetRequest getRequest = new GetRequest( | ||
| "posts", // <1> | ||
| "doc", // <2> |
There was a problem hiding this comment.
would "_doc" be better here ?
There was a problem hiding this comment.
I don't think it makes a difference to be honest.
| [[java-rest-high-document-exists-request]] | ||
| ==== Exists Request | ||
|
|
||
| The `exists()` API is `true` if a document exists, and `false` otherwise. |
There was a problem hiding this comment.
Hm... In most docs there is no explanation what the API is for ( just how to use it )
Should this be moved into the above section?
| [[java-rest-high-document-exists-async]] | ||
| ==== Asynchronous Execution | ||
|
|
||
| The asynchronous execution of `exists()` requires both the `GetRequest` |
There was a problem hiding this comment.
In most docs this section starts something like :
Update API
The asynchronous execution of an update request requires both the UpdateRequest instance and an ActionListener instance to be passed to the asynchronous method:
Would it be more consistent if :
s/exists()/exists request/
There was a problem hiding this comment.
I can do that. I'm not sure it is better, but it is more consistent.
| <2> Type | ||
| <3> Document id | ||
| <4> Disable fetching `_source`. | ||
| <5> Disable fetching stored fields. |
There was a problem hiding this comment.
Hm... I would say with . or without . for all? What do you think?
There was a problem hiding this comment.
I put the . because these are sentences and the ones above aren't.
|
Thanks for reviewing @javanna, @cbuescher, and @olcbean! This is a fairly good introduction to the high level rest client for me so I'm quite happy to do it! |
Docs: HighLevelRestClient#exists Add documentation for `HighLevelRestClient#exists`. Relates to #28389
* es/6.x: (89 commits) Clarify requirements of strict date formats. (#29090) Clarify that dates are always rendered as strings. (#29093) [Docs] Fix link to Grok patterns (#29088) Fix starting on Windows from another drive (#29086) Use removeTask instead of finishTask in PersistentTasksClusterService (#29055) Added minimal docs for reindex api in java-api docs Allow overriding JVM options in Windows service (#29044) Clarify how to set compiler and runtime JDKs (#29101) Fix Parsing Bug with Update By Query for Stored Scripts (#29039) TEST: write ops should execute under shard permit (#28966) [DOCS] Add X-Pack upgrade details (#29038) Revert "Improve error message for installing plugin (#28298)" Docs: HighLevelRestClient#exists (#29073) Validate regular expressions in dynamic templates. (#29013) [Tests] Fix GetResultTests and DocumentFieldTests failures (#29083) Reenable LiveVersionMapTests.testRamBytesUsed on Java 9. (#29063) Mute failing GetResultTests and DocumentFieldTests [Docs] Fix Java Api index administration usage (#28260) Improve error message for installing plugin (#28298) Decouple XContentBuilder from BytesReference (#28972) ...
* es/master: (97 commits) Clarify requirements of strict date formats. (#29090) Clarify that dates are always rendered as strings. (#29093) Compilation fix for #29067 [Docs] Fix link to Grok patterns (#29088) Store offsets in index prefix fields when stored in the parent field (#29067) Fix starting on Windows from another drive (#29086) Use removeTask instead of finishTask in PersistentTasksClusterService (#29055) Added minimal docs for reindex api in java-api docs Allow overriding JVM options in Windows service (#29044) Clarify how to set compiler and runtime JDKs (#29101) CLI: Close subcommands in MultiCommand (#28954) TEST: write ops should execute under shard permit (#28966) [DOCS] Add X-Pack upgrade details (#29038) Revert "Improve error message for installing plugin (#28298)" Docs: HighLevelRestClient#exists (#29073) Validate regular expressions in dynamic templates. (#29013) [Tests] Fix GetResultTests and DocumentFieldTests failures (#29083) Reenable LiveVersionMapTests.testRamBytesUsed on Java 9. (#29063) Mute failing GetResultTests and DocumentFieldTests Improve error message for installing plugin (#28298) ...
Add documentation for
HighLevelRestClient#exists.Relates to #28389