-
Notifications
You must be signed in to change notification settings - Fork 25.2k
HLRC: Add support for reindex rethrottling #33832
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
77 changes: 77 additions & 0 deletions
77
client/rest-high-level/src/main/java/org/elasticsearch/client/RethrottleRequest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.client; | ||
|
|
||
| import org.elasticsearch.tasks.TaskId; | ||
|
|
||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * A request changing throttling of a task. | ||
| */ | ||
| public class RethrottleRequest implements Validatable { | ||
|
|
||
| static final String REQUEST_PER_SECOND_PARAMETER = "requests_per_second"; | ||
|
|
||
| private final TaskId taskId; | ||
| private final float requestsPerSecond; | ||
|
|
||
| /** | ||
| * Create a new {@link RethrottleRequest} which disables any throttling for the given taskId. | ||
| * @param taskId the task for which throttling will be disabled | ||
| */ | ||
| public RethrottleRequest(TaskId taskId) { | ||
| this.taskId = taskId; | ||
| this.requestsPerSecond = Float.POSITIVE_INFINITY; | ||
| } | ||
|
|
||
| /** | ||
| * Create a new {@link RethrottleRequest} which changes the throttling for the given taskId. | ||
| * @param taskId the task that throttling changes will be applied to | ||
| * @param requestsPerSecond the number of requests per second that the task should perform. This needs to be a positive value. | ||
| */ | ||
| public RethrottleRequest(TaskId taskId, float requestsPerSecond) { | ||
| Objects.requireNonNull(taskId, "taskId cannot be null"); | ||
| if (requestsPerSecond <= 0) { | ||
| throw new IllegalArgumentException("requestsPerSecond needs to be positive value but was [" + requestsPerSecond+"]"); | ||
| } | ||
| this.taskId = taskId; | ||
| this.requestsPerSecond = requestsPerSecond; | ||
| } | ||
|
|
||
| /** | ||
| * @return the task Id | ||
| */ | ||
| public TaskId getTaskId() { | ||
| return taskId; | ||
| } | ||
|
|
||
| /** | ||
| * @return the requests per seconds value | ||
| */ | ||
| public float getRequestsPerSecond() { | ||
| return requestsPerSecond; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "RethrottleRequest: taskID = " + taskId +"; reqestsPerSecond = " + requestsPerSecond; | ||
| } | ||
| } |
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
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
Oops, something went wrong.
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.
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 wasn't sure if I should also include the analogous deleteByQueryRethrottle and updateByQueryRethrottle methods in this PR since I'm not sure how we want to expose the three rethrottling types. Maybe we just want a single method since I thin the Request/Response objects are mostly identical? They even target the same RestAction I think. On the other hand, if at any point in the future we want to untie those, maybe it makes sense to add separate method pairs for each flavour, wdyt?
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 think we said we'd like to line the client up with the REST API. So, yes, I'd make all three of them.
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.
Okay, thanks. I'd probably prefer to that in a follow-up PR though then, its a bit of a copy/paste job but then we also need to add two more documentation cases.