-
Notifications
You must be signed in to change notification settings - Fork 24.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds ignoreUnavailable option to the snapshot status API #20066
Adds ignoreUnavailable option to the snapshot status API #20066
Conversation
with the get snapshots API which has a similar parameter. If ignoreUnavailable is set to true, then the snapshot status request will ignore any snapshots that were not found in the repository, instead of throwing a SnapshotMissingException. Closes elastic#18522
* Set to <code>true</code> to ignore unavailable snapshots, instead of throwing an exception. | ||
* Defaults to <code>false</code>, which means unavailable snapshots cause an exception to be thrown. | ||
* | ||
* @param ignoreUnavailable whether to ignore unavailable snapshots |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think the @param
or @return
adds anything to the information. Personally I wouldn't add them. You can do what you want. I just wanted to let you know its ok (by me) not to add them if they don't make the API more clear.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, I usually don't add them but in this case I did to be consistent with the rest of the class' javadocs
Left a bunch of small stuff. |
- is_true: snapshots | ||
|
||
--- | ||
teardown: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd stick this up at the top near the setup so they are together. Easier to see that they are acting together that way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
Left one final minor things. LGTM otherwise, merge when ready! |
@nik9000 thanks for the review! |
Adds ignoreUnavailable to the snapshot status API to be consistant
with the get snapshots API which has a similar parameter. If
ignoreUnavailable is set to true, then the snapshot status request
will ignore any snapshots that were not found in the repository,
instead of throwing a SnapshotMissingException.
Closes #18522