Add documentation for Clone Snapshot Java API #70720
Merged
Conversation
This file contains hidden or 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
tlrx
added
>docs
elasticmachine
added
Team:Docs
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
Collaborator
|
Pinging @elastic/es-distributed (Team:Distributed) |
Member
Author
|
Tests failed for unrelated failure tracked reported in #70746: @elasticmachine run elasticsearch-ci/2 |
ywelsch
approved these changes
Mar 24, 2021
| ==== Indices to Clone | ||
|
|
||
| The `indices` property is used to provide the list of | ||
| indices that should be included in the snapshot: |
Contributor
There was a problem hiding this comment.
provide the list of indices from the source snapshot to be included in the snapshot clone
jrodewig
approved these changes
Mar 24, 2021
| [[java-rest-high-snapshot-clone-snapshot]] | ||
| === Clone Snapshot API | ||
|
|
||
| The Clone Snapshot API allows to clone part or all of a snapshot into a new snapshot. |
Contributor
There was a problem hiding this comment.
Suggested change
| The Clone Snapshot API allows to clone part or all of a snapshot into a new snapshot. | |
| The Clone Snapshot API clones part or all of a snapshot into a new snapshot. |
| The Clone Snapshot API allows to clone part or all of a snapshot into a new snapshot. | ||
|
|
||
| [[java-rest-high-snapshot-clone-snapshot-request]] | ||
| ==== Clone Snapshot Request |
Contributor
There was a problem hiding this comment.
nit
Suggested change
| ==== Clone Snapshot Request | |
| ==== Request |
| <2> Called in case of a failure. The raised exception is provided as an argument. | ||
|
|
||
| [[java-rest-high-cluster-clone-snapshot-response]] | ||
| ==== Clone Snapshot Response |
Contributor
There was a problem hiding this comment.
nit
Suggested change
| ==== Clone Snapshot Response | |
| ==== Response |
Comment on lines
18
to
19
| The `indices` property is used to provide the list of | ||
| indices that should be included in the snapshot: |
Contributor
There was a problem hiding this comment.
Suggested change
| The `indices` property is used to provide the list of | |
| indices that should be included in the snapshot: | |
| Use `indices` to specify a list of indices from the source snapshot to include | |
| in the snapshot clone: |
| -------------------------------------------------- | ||
| include-tagged::{doc-tests}/SnapshotClientDocumentationIT.java[clone-snapshot-request-indices] | ||
| -------------------------------------------------- | ||
| <1> Request that Elasticsearch only includes "test_index" from the source snapshot. |
Contributor
There was a problem hiding this comment.
Suggested change
| <1> Request that Elasticsearch only includes "test_index" from the source snapshot. | |
| <1> Include only `test_index` from the source snapshot. |
|
|
||
| ==== Further Arguments | ||
|
|
||
| The following arguments can optionally be provided: |
Contributor
There was a problem hiding this comment.
Suggested change
| The following arguments can optionally be provided: | |
| You can also provide the following optional arguments: |
| -------------------------------------------------- | ||
| include-tagged::{doc-tests}/SnapshotClientDocumentationIT.java[clone-snapshot-response] | ||
| -------------------------------------------------- | ||
| <1> A boolean value of `true` if the clone successfully completed, `false` otherwise. |
Contributor
There was a problem hiding this comment.
Nit
Suggested change
| <1> A boolean value of `true` if the clone successfully completed, `false` otherwise. | |
| <1> A boolean value of `true` if the clone successfully completed. Otherwise, the value is `false`. |
Comment on lines
89
to
90
| The returned `AcknowledgedResponse` contains a value on whether or not the request | ||
| was received: |
Contributor
There was a problem hiding this comment.
Suggested change
| The returned `AcknowledgedResponse` contains a value on whether or not the request | |
| was received: | |
| `AcknowledgedResponse` indicates whether the request was received: |
Member
Author
|
Thanks both! @jrodewig I initially borrowed most of the content of this change from the other create/delete/restore Java APIs docs, so I think many of your comments are also applicable there. |
tlrx
added a commit
to tlrx/elasticsearch
that referenced
this pull request
Mar 24, 2021
This commit adds some missing documentation about the Clone Snapshot Java API. Relates elastic#63863
tlrx
added a commit
to tlrx/elasticsearch
that referenced
this pull request
Mar 24, 2021
This commit adds some missing documentation about the Clone Snapshot Java API. Relates elastic#63863
tlrx
added a commit
that referenced
this pull request
Mar 24, 2021
tlrx
added a commit
that referenced
this pull request
Mar 24, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
This commit adds some missing documentation about the Clone Snapshot Java API.
Relates #63863