Skip to content

Commit 1e367b6

Browse files
[7.3][ML] Add missing doc links to df-analytics rest spec and HLRC javadocs (#44025) (#44034)
1 parent feacbed commit 1e367b6

8 files changed

+35
-14
lines changed

client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java

+28-14
Original file line numberDiff line numberDiff line change
@@ -1894,7 +1894,8 @@ public void setUpgradeModeAsync(SetUpgradeModeRequest request, RequestOptions op
18941894
* Creates a new Data Frame Analytics config
18951895
* <p>
18961896
* For additional info
1897-
* see <a href="https://www.TODO.com">PUT Data Frame Analytics documentation</a>
1897+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html">
1898+
* PUT Data Frame Analytics documentation</a>
18981899
*
18991900
* @param request The {@link PutDataFrameAnalyticsRequest} containing the
19001901
* {@link org.elasticsearch.client.ml.dataframe.DataFrameAnalyticsConfig}
@@ -1916,7 +1917,8 @@ public PutDataFrameAnalyticsResponse putDataFrameAnalytics(PutDataFrameAnalytics
19161917
* Creates a new Data Frame Analytics config asynchronously and notifies listener upon completion
19171918
* <p>
19181919
* For additional info
1919-
* see <a href="https://www.TODO.com">PUT Data Frame Analytics documentation</a>
1920+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html">
1921+
* PUT Data Frame Analytics documentation</a>
19201922
*
19211923
* @param request The {@link PutDataFrameAnalyticsRequest} containing the
19221924
* {@link org.elasticsearch.client.ml.dataframe.DataFrameAnalyticsConfig}
@@ -1937,7 +1939,8 @@ public void putDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequest request, Req
19371939
* Gets a single or multiple Data Frame Analytics configs
19381940
* <p>
19391941
* For additional info
1940-
* see <a href="https://www.TODO.com">GET Data Frame Analytics documentation</a>
1942+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html">
1943+
* GET Data Frame Analytics documentation</a>
19411944
*
19421945
* @param request The {@link GetDataFrameAnalyticsRequest}
19431946
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -1957,7 +1960,8 @@ public GetDataFrameAnalyticsResponse getDataFrameAnalytics(GetDataFrameAnalytics
19571960
* Gets a single or multiple Data Frame Analytics configs asynchronously and notifies listener upon completion
19581961
* <p>
19591962
* For additional info
1960-
* see <a href="https://www.TODO.com">GET Data Frame Analytics documentation</a>
1963+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html">
1964+
* GET Data Frame Analytics documentation</a>
19611965
*
19621966
* @param request The {@link GetDataFrameAnalyticsRequest}
19631967
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -1977,7 +1981,8 @@ public void getDataFrameAnalyticsAsync(GetDataFrameAnalyticsRequest request, Req
19771981
* Gets the running statistics of a Data Frame Analytics
19781982
* <p>
19791983
* For additional info
1980-
* see <a href="https://www.TODO.com">GET Data Frame Analytics Stats documentation</a>
1984+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html">
1985+
* GET Data Frame Analytics Stats documentation</a>
19811986
*
19821987
* @param request The {@link GetDataFrameAnalyticsStatsRequest}
19831988
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -1996,7 +2001,8 @@ public GetDataFrameAnalyticsStatsResponse getDataFrameAnalyticsStats(GetDataFram
19962001
* Gets the running statistics of a Data Frame Analytics asynchronously and notifies listener upon completion
19972002
* <p>
19982003
* For additional info
1999-
* see <a href="https://www.TODO.com">GET Data Frame Analytics Stats documentation</a>
2004+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html">
2005+
* GET Data Frame Analytics Stats documentation</a>
20002006
*
20012007
* @param request The {@link GetDataFrameAnalyticsStatsRequest}
20022008
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2016,7 +2022,8 @@ public void getDataFrameAnalyticsStatsAsync(GetDataFrameAnalyticsStatsRequest re
20162022
* Starts Data Frame Analytics
20172023
* <p>
20182024
* For additional info
2019-
* see <a href="https://www.TODO.com">Start Data Frame Analytics documentation</a>
2025+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html">
2026+
* Start Data Frame Analytics documentation</a>
20202027
*
20212028
* @param request The {@link StartDataFrameAnalyticsRequest}
20222029
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2036,7 +2043,8 @@ public AcknowledgedResponse startDataFrameAnalytics(StartDataFrameAnalyticsReque
20362043
* Starts Data Frame Analytics asynchronously and notifies listener upon completion
20372044
* <p>
20382045
* For additional info
2039-
* see <a href="https://www.TODO.com">Start Data Frame Analytics documentation</a>
2046+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html">
2047+
* Start Data Frame Analytics documentation</a>
20402048
*
20412049
* @param request The {@link StartDataFrameAnalyticsRequest}
20422050
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2056,7 +2064,8 @@ public void startDataFrameAnalyticsAsync(StartDataFrameAnalyticsRequest request,
20562064
* Stops Data Frame Analytics
20572065
* <p>
20582066
* For additional info
2059-
* see <a href="https://www.TODO.com">Stop Data Frame Analytics documentation</a>
2067+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html">
2068+
* Stop Data Frame Analytics documentation</a>
20602069
*
20612070
* @param request The {@link StopDataFrameAnalyticsRequest}
20622071
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2076,7 +2085,8 @@ public StopDataFrameAnalyticsResponse stopDataFrameAnalytics(StopDataFrameAnalyt
20762085
* Stops Data Frame Analytics asynchronously and notifies listener upon completion
20772086
* <p>
20782087
* For additional info
2079-
* see <a href="https://www.TODO.com">Stop Data Frame Analytics documentation</a>
2088+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html">
2089+
* Stop Data Frame Analytics documentation</a>
20802090
*
20812091
* @param request The {@link StopDataFrameAnalyticsRequest}
20822092
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2096,7 +2106,8 @@ public void stopDataFrameAnalyticsAsync(StopDataFrameAnalyticsRequest request, R
20962106
* Deletes the given Data Frame Analytics config
20972107
* <p>
20982108
* For additional info
2099-
* see <a href="https://www.TODO.com">DELETE Data Frame Analytics documentation</a>
2109+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html">
2110+
* DELETE Data Frame Analytics documentation</a>
21002111
*
21012112
* @param request The {@link DeleteDataFrameAnalyticsRequest}
21022113
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2116,7 +2127,8 @@ public AcknowledgedResponse deleteDataFrameAnalytics(DeleteDataFrameAnalyticsReq
21162127
* Deletes the given Data Frame Analytics config asynchronously and notifies listener upon completion
21172128
* <p>
21182129
* For additional info
2119-
* see <a href="https://www.TODO.com">DELETE Data Frame Analytics documentation</a>
2130+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html">
2131+
* DELETE Data Frame Analytics documentation</a>
21202132
*
21212133
* @param request The {@link DeleteDataFrameAnalyticsRequest}
21222134
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2136,7 +2148,8 @@ public void deleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequest reques
21362148
* Evaluates the given Data Frame
21372149
* <p>
21382150
* For additional info
2139-
* see <a href="https://www.TODO.com">Evaluate Data Frame documentation</a>
2151+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html">
2152+
* Evaluate Data Frame documentation</a>
21402153
*
21412154
* @param request The {@link EvaluateDataFrameRequest}
21422155
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2156,7 +2169,8 @@ public EvaluateDataFrameResponse evaluateDataFrame(EvaluateDataFrameRequest requ
21562169
* Evaluates the given Data Frame asynchronously and notifies listener upon completion
21572170
* <p>
21582171
* For additional info
2159-
* see <a href="https://www.TODO.com">Evaluate Data Frame documentation</a>
2172+
* see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html">
2173+
* Evaluate Data Frame documentation</a>
21602174
*
21612175
* @param request The {@link EvaluateDataFrameRequest}
21622176
* @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized

x-pack/plugin/src/test/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"ml.delete_data_frame_analytics": {
3+
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html",
34
"stability": "experimental",
45
"methods": [ "DELETE" ],
56
"url": {

x-pack/plugin/src/test/resources/rest-api-spec/api/ml.evaluate_data_frame.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"ml.evaluate_data_frame": {
3+
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html",
34
"stability": "experimental",
45
"methods": [ "POST" ],
56
"url": {

x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"ml.get_data_frame_analytics": {
3+
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html",
34
"stability": "experimental",
45
"methods": [ "GET"],
56
"url": {

x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"ml.get_data_frame_analytics_stats": {
3+
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html",
34
"stability": "experimental",
45
"methods": [ "GET"],
56
"url": {

x-pack/plugin/src/test/resources/rest-api-spec/api/ml.put_data_frame_analytics.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"ml.put_data_frame_analytics": {
3+
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html",
34
"stability": "experimental",
45
"methods": [ "PUT" ],
56
"url": {

x-pack/plugin/src/test/resources/rest-api-spec/api/ml.start_data_frame_analytics.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"ml.start_data_frame_analytics": {
3+
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html",
34
"stability": "experimental",
45
"methods": [ "POST" ],
56
"url": {

x-pack/plugin/src/test/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"ml.stop_data_frame_analytics": {
3+
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html",
34
"stability": "experimental",
45
"methods": [ "POST" ],
56
"url": {

0 commit comments

Comments
 (0)