[DOCS] Async search: clarify behaviour when submit returns final results #55934
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
javanna
added
>docs
jimczi
approved these changes
Apr 30, 2020
| @@ -98,7 +98,11 @@ some shards returned their results, or when the node that is coordinating the | |||
|
|
|||
| It is possible to block and wait until the search is completed up to a certain | |||
| timeout by providing the `wait_for_completion_timeout` parameter, which | |||
| defaults to `1` second. | |||
| defaults to `1` second. When the async search completes within such timeout, | |||
| the response won't include the ID as the results are not stored in the cluster. | |||
There was a problem hiding this comment.
I think this is how @jrodewig prefers us to mention the id, I will defer to him :)
| defaults to `1` second. When the async search completes within such timeout, | ||
| the response won't include the ID as the results are not stored in the cluster. | ||
| The `keep_on_completion` parameter, which defaults to `false`, can be set to | ||
| `true` to request that when the async search completes within the |
There was a problem hiding this comment.
nit: s/when the async search completes/when the search completes/ ? It's a parameter for a blocking API so async is maybe misleading.
rjernst
added
Team:Docs
javanna
added a commit
that referenced
this pull request
May 6, 2020
javanna
added a commit
that referenced
this pull request
May 6, 2020
javanna
added a commit
that referenced
this pull request
May 6, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #55636