Skip to content

Commit

Permalink
[DOCS] Clarify criteria for restore completion (elastic#74094)
Browse files Browse the repository at this point in the history
A restore operation is complete when all attempts to recover primary shards have finished, even if unsuccessful.

Closes elastic#70854
  • Loading branch information
jrodewig authored Jun 15, 2021
1 parent 0d659fe commit 51ec860
Showing 1 changed file with 5 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]

`wait_for_completion`::
(Optional, Boolean) If `true`, the request returns a response when the restore
operation completes. If `false`, the request returns a response when the restore
operation completes. The operation is complete when it finishes all attempts to
<<_monitoring_restore_operations,recover primary shards>> for restored indices.
This applies even if one or more of the recovery attempts fail.
+
If `false`, the request returns a response when the restore
operation initializes. Defaults to `false`.

[role="child_attributes"]
Expand Down

0 comments on commit 51ec860

Please sign in to comment.