Skip to content

Commit eb7969e

Browse files
gwbrowngwbrown
authored
Fix ILM HLRC Javadoc->Documentation links (#48083)
Several links from the ILM HLRC Javadoc to the online documentation were not updated when the ILM HLRC documentation was written. This commit fixes those links.
1 parent 356eef0 commit eb7969e

File tree

1 file changed

+82
-40
lines changed

1 file changed

+82
-40
lines changed

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

Lines changed: 82 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,11 @@ public Cancellable putLifecyclePolicyAsync(PutLifecyclePolicyRequest request, Re
120120

121121
/**
122122
* Delete a lifecycle definition
123-
* See <a href="https://fix-me-when-we-have-docs.com">
124-
* the docs</a> for more.
123+
* See <pre>
124+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
125+
* java-rest-high-ilm-ilm-delete-lifecycle-policy.html
126+
* </pre>
127+
* for more.
125128
* @param request the request
126129
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
127130
* @return the response
@@ -135,8 +138,11 @@ public AcknowledgedResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest r
135138

136139
/**
137140
* Asynchronously delete a lifecycle definition
138-
* See <a href="https://fix-me-when-we-have-docs.com">
139-
* the docs</a> for more.
141+
* See <pre>
142+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
143+
* java-rest-high-ilm-ilm-delete-lifecycle-policy.html
144+
* </pre>
145+
* for more.
140146
* @param request the request
141147
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
142148
* @param listener the listener to be notified upon request completion
@@ -151,8 +157,11 @@ public Cancellable deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest reque
151157

152158
/**
153159
* Remove the index lifecycle policy for an index
154-
* See <a href="https://fix-me-when-we-have-docs.com">
155-
* the docs</a> for more.
160+
* See <pre>
161+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
162+
* java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
163+
* </pre>
164+
* for more.
156165
* @param request the request
157166
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
158167
* @return the response
@@ -166,8 +175,11 @@ public RemoveIndexLifecyclePolicyResponse removeIndexLifecyclePolicy(RemoveIndex
166175

167176
/**
168177
* Asynchronously remove the index lifecycle policy for an index
169-
* See <a href="https://fix-me-when-we-have-docs.com">
170-
* the docs</a> for more.
178+
* See <pre>
179+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
180+
* java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
181+
* </pre>
182+
* for more.
171183
* @param request the request
172184
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
173185
* @param listener the listener to be notified upon request completion
@@ -182,8 +194,11 @@ public Cancellable removeIndexLifecyclePolicyAsync(RemoveIndexLifecyclePolicyReq
182194

183195
/**
184196
* Start the Index Lifecycle Management feature.
185-
* See <a href="https://fix-me-when-we-have-docs.com">
186-
* the docs</a> for more.
197+
* See <pre>
198+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
199+
* java-rest-high-ilm-ilm-start-ilm.html
200+
* </pre>
201+
* for more.
187202
* @param request the request
188203
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
189204
* @return the response
@@ -196,8 +211,11 @@ public AcknowledgedResponse startILM(StartILMRequest request, RequestOptions opt
196211

197212
/**
198213
* Asynchronously start the Index Lifecycle Management feature.
199-
* See <a href="https://fix-me-when-we-have-docs.com">
200-
* the docs</a> for more.
214+
* See <pre>
215+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
216+
* java-rest-high-ilm-ilm-start-ilm.html
217+
* </pre>
218+
* for more.
201219
* @param request the request
202220
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
203221
* @param listener the listener to be notified upon request completion
@@ -210,8 +228,11 @@ public Cancellable startILMAsync(StartILMRequest request, RequestOptions options
210228

211229
/**
212230
* Stop the Index Lifecycle Management feature.
213-
* See <a href="https://fix-me-when-we-have-docs.com">
214-
* the docs</a> for more.
231+
* See <pre>
232+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
233+
* java-rest-high-ilm-ilm-stop-ilm.html
234+
* </pre>
235+
* for more.
215236
* @param request the request
216237
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
217238
* @return the response
@@ -222,10 +243,30 @@ public AcknowledgedResponse stopILM(StopILMRequest request, RequestOptions optio
222243
AcknowledgedResponse::fromXContent, emptySet());
223244
}
224245

246+
/**
247+
* Asynchronously stop the Index Lifecycle Management feature.
248+
* See <pre>
249+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
250+
* java-rest-high-ilm-ilm-stop-ilm.html
251+
* </pre>
252+
* for more.
253+
* @param request the request
254+
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
255+
* @param listener the listener to be notified upon request completion
256+
* @return cancellable that may be used to cancel the request
257+
*/
258+
public Cancellable stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
259+
return restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
260+
AcknowledgedResponse::fromXContent, listener, emptySet());
261+
}
262+
225263
/**
226264
* Get the status of index lifecycle management
227-
* See <a href="https://fix-me-when-we-have-docs.com">
228-
* the docs</a> for more.
265+
* See <pre>
266+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
267+
* java-rest-high-ilm-ilm-status.html
268+
* </pre>
269+
* for more.
229270
*
230271
* @param request the request
231272
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -238,8 +279,11 @@ public LifecycleManagementStatusResponse lifecycleManagementStatus(LifecycleMana
238279

239280
/**
240281
* Asynchronously get the status of index lifecycle management
241-
* See <a href="https://fix-me-when-we-have-docs.com">
242-
* the docs</a> for more.
282+
* See <pre>
283+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
284+
* java-rest-high-ilm-ilm-status.html
285+
* </pre>
286+
* for more.
243287
* @param request the request
244288
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
245289
* @param listener the listener to be notified upon request completion
@@ -252,24 +296,13 @@ public Cancellable lifecycleManagementStatusAsync(LifecycleManagementStatusReque
252296
LifecycleManagementStatusResponse::fromXContent, listener, emptySet());
253297
}
254298

255-
/**
256-
* Asynchronously stop the Index Lifecycle Management feature.
257-
* See <a href="https://fix-me-when-we-have-docs.com">
258-
* the docs</a> for more.
259-
* @param request the request
260-
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
261-
* @param listener the listener to be notified upon request completion
262-
* @return cancellable that may be used to cancel the request
263-
*/
264-
public Cancellable stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
265-
return restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
266-
AcknowledgedResponse::fromXContent, listener, emptySet());
267-
}
268-
269299
/**
270300
* Explain the lifecycle state for an index
271-
* See <a href="https://fix-me-when-we-have-docs.com">
272-
* the docs</a> for more.
301+
* See <pre>
302+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
303+
* java-rest-high-ilm-ilm-explain-lifecycle.html
304+
* </pre>
305+
* for more.
273306
* @param request the request
274307
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
275308
* @return the response
@@ -282,8 +315,11 @@ public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request
282315

283316
/**
284317
* Asynchronously explain the lifecycle state for an index
285-
* See <a href="https://fix-me-when-we-have-docs.com">
286-
* the docs</a> for more.
318+
* See <pre>
319+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
320+
* java-rest-high-ilm-ilm-explain-lifecycle.html
321+
* </pre>
322+
* for more.
287323
* @param request the request
288324
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
289325
* @param listener the listener to be notified upon request completion
@@ -297,8 +333,11 @@ public Cancellable explainLifecycleAsync(ExplainLifecycleRequest request, Reques
297333

298334
/**
299335
* Retry lifecycle step for given indices
300-
* See <a href="https://fix-me-when-we-have-docs.com">
301-
* the docs</a> for more.
336+
* See <pre>
337+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
338+
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
339+
* </pre>
340+
* for more.
302341
* @param request the request
303342
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
304343
* @return the response
@@ -311,8 +350,11 @@ public AcknowledgedResponse retryLifecyclePolicy(RetryLifecyclePolicyRequest req
311350

312351
/**
313352
* Asynchronously retry the lifecycle step for given indices
314-
* See <a href="https://fix-me-when-we-have-docs.com">
315-
* the docs</a> for more.
353+
* See <pre>
354+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
355+
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
356+
* </pre>
357+
* for more.
316358
* @param request the request
317359
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
318360
* @param listener the listener to be notified upon request completion

0 commit comments

Comments
 (0)