Skip to content

Commit

Permalink
[Docs] Minor fix for SubmitAsyncSearchRequest.keepOnCompletion javadoc (
Browse files Browse the repository at this point in the history
#54325)

The semantics and the default value for this parameter have changed, adapting
the javadoc accordingly.
  • Loading branch information
Christoph Büscher committed Mar 27, 2020
1 parent 8baa1b6 commit e23de0e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ public void setWaitForCompletionTimeout(TimeValue waitForCompletionTimeout) {
}

/**
* Returns whether the resource resource should be removed on completion or failure (defaults to true).
* Returns whether the resource resource should be kept on completion or failure (defaults to false).
*/
public Boolean isKeepOnCompletion() {
return keepOnCompletion;
}

/**
* Determines if the resource should be removed on completion or failure (defaults to true).
* Determines if the resource should be kept on completion or failure (defaults to false).
*/
public void setKeepOnCompletion(boolean keepOnCompletion) {
this.keepOnCompletion = keepOnCompletion;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public SearchRequest getSearchRequest() {
}

/**
* Should the resource be removed on completion or failure (defaults to true).
* Should the resource be kept on completion or failure (defaults to false).
*/
public SubmitAsyncSearchRequest setKeepOnCompletion(boolean value) {
this.keepOnCompletion = value;
Expand Down Expand Up @@ -162,8 +162,12 @@ public boolean shouldCancelChildrenOnCancellation() {

@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
SubmitAsyncSearchRequest request1 = (SubmitAsyncSearchRequest) o;
return keepOnCompletion == request1.keepOnCompletion &&
waitForCompletionTimeout.equals(request1.waitForCompletionTimeout) &&
Expand Down

0 comments on commit e23de0e

Please sign in to comment.