Skip to content

Commit 1447d75

Browse files
authored
Point deprecated settings to the new location. (opensearch-project#10522)
I was looking through some cluster settings, stumbled across the search back-pressure settings, saw they were deprecated, and the Javadoc alluded to some myserious new settings. I'm adding links to the class with the new settings to help future developers. Signed-off-by: Michael Froh <froh@amazon.com>
1 parent 382eb30 commit 1447d75

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

server/src/main/java/org/opensearch/search/backpressure/settings/SearchBackpressureSettings.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ private static class Defaults {
5555
* Defines the percentage of tasks to cancel relative to the number of successful task completions.
5656
* In other words, it is the number of tokens added to the bucket on each successful task completion.
5757
* <p>
58-
* The setting below is deprecated.
58+
* The setting below is deprecated. The new setting is in {@link SearchShardTaskSettings}.
5959
* To keep backwards compatibility, the old usage is remained, and it's also used as the fallback for the new usage.
6060
*/
6161
public static final Setting<Double> SETTING_CANCELLATION_RATIO = Setting.doubleSetting(
@@ -72,7 +72,7 @@ private static class Defaults {
7272
* Defines the number of tasks to cancel per unit time (in millis).
7373
* In other words, it is the number of tokens added to the bucket each millisecond.
7474
* <p>
75-
* The setting below is deprecated.
75+
* The setting below is deprecated. The new setting is in {@link SearchShardTaskSettings}.
7676
* To keep backwards compatibility, the old usage is remained, and it's also used as the fallback for the new usage.
7777
*/
7878
public static final Setting<Double> SETTING_CANCELLATION_RATE = Setting.doubleSetting(
@@ -87,7 +87,7 @@ private static class Defaults {
8787
/**
8888
* Defines the maximum number of tasks that can be cancelled before being rate-limited.
8989
* <p>
90-
* The setting below is deprecated.
90+
* The setting below is deprecated. The new setting is in {@link SearchShardTaskSettings}.
9191
* To keep backwards compatibility, the old usage is remained, and it's also used as the fallback for the new usage.
9292
*/
9393
public static final Setting<Double> SETTING_CANCELLATION_BURST = Setting.doubleSetting(

0 commit comments

Comments
 (0)