Skip to content

Commit 90eae6b

Browse files
gwbrowngwbrown
committed
Fix ILM HLRC Javadoc->Documentation links (elastic#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 b5cf982 commit 90eae6b

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
@@ -112,8 +112,11 @@ public void putLifecyclePolicyAsync(PutLifecyclePolicyRequest request, RequestOp
112112

113113
/**
114114
* Delete a lifecycle definition
115-
* See <a href="https://fix-me-when-we-have-docs.com">
116-
* the docs</a> for more.
115+
* See <pre>
116+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
117+
* java-rest-high-ilm-ilm-delete-lifecycle-policy.html
118+
* </pre>
119+
* for more.
117120
* @param request the request
118121
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
119122
* @return the response
@@ -127,8 +130,11 @@ public AcknowledgedResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest r
127130

128131
/**
129132
* Asynchronously delete a lifecycle definition
130-
* See <a href="https://fix-me-when-we-have-docs.com">
131-
* the docs</a> for more.
133+
* See <pre>
134+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
135+
* java-rest-high-ilm-ilm-delete-lifecycle-policy.html
136+
* </pre>
137+
* for more.
132138
* @param request the request
133139
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
134140
* @param listener the listener to be notified upon request completion
@@ -141,8 +147,11 @@ public void deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest request, Req
141147

142148
/**
143149
* Remove the index lifecycle policy for an index
144-
* See <a href="https://fix-me-when-we-have-docs.com">
145-
* the docs</a> for more.
150+
* See <pre>
151+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
152+
* java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
153+
* </pre>
154+
* for more.
146155
* @param request the request
147156
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
148157
* @return the response
@@ -156,8 +165,11 @@ public RemoveIndexLifecyclePolicyResponse removeIndexLifecyclePolicy(RemoveIndex
156165

157166
/**
158167
* Asynchronously remove the index lifecycle policy for an index
159-
* See <a href="https://fix-me-when-we-have-docs.com">
160-
* the docs</a> for more.
168+
* See <pre>
169+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
170+
* java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
171+
* </pre>
172+
* for more.
161173
* @param request the request
162174
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
163175
* @param listener the listener to be notified upon request completion
@@ -170,8 +182,11 @@ public void removeIndexLifecyclePolicyAsync(RemoveIndexLifecyclePolicyRequest re
170182

171183
/**
172184
* Start the Index Lifecycle Management feature.
173-
* See <a href="https://fix-me-when-we-have-docs.com">
174-
* the docs</a> for more.
185+
* See <pre>
186+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
187+
* java-rest-high-ilm-ilm-start-ilm.html
188+
* </pre>
189+
* for more.
175190
* @param request the request
176191
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
177192
* @return the response
@@ -184,8 +199,11 @@ public AcknowledgedResponse startILM(StartILMRequest request, RequestOptions opt
184199

185200
/**
186201
* Asynchronously start the Index Lifecycle Management feature.
187-
* See <a href="https://fix-me-when-we-have-docs.com">
188-
* the docs</a> for more.
202+
* See <pre>
203+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
204+
* java-rest-high-ilm-ilm-start-ilm.html
205+
* </pre>
206+
* for more.
189207
* @param request the request
190208
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
191209
* @param listener the listener to be notified upon request completion
@@ -197,8 +215,11 @@ public void startILMAsync(StartILMRequest request, RequestOptions options, Actio
197215

198216
/**
199217
* Stop the Index Lifecycle Management feature.
200-
* See <a href="https://fix-me-when-we-have-docs.com">
201-
* the docs</a> for more.
218+
* See <pre>
219+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
220+
* java-rest-high-ilm-ilm-stop-ilm.html
221+
* </pre>
222+
* for more.
202223
* @param request the request
203224
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
204225
* @return the response
@@ -209,10 +230,30 @@ public AcknowledgedResponse stopILM(StopILMRequest request, RequestOptions optio
209230
AcknowledgedResponse::fromXContent, emptySet());
210231
}
211232

233+
/**
234+
* Asynchronously stop the Index Lifecycle Management feature.
235+
* See <pre>
236+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
237+
* java-rest-high-ilm-ilm-stop-ilm.html
238+
* </pre>
239+
* for more.
240+
* @param request the request
241+
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
242+
* @param listener the listener to be notified upon request completion
243+
* @return cancellable that may be used to cancel the request
244+
*/
245+
public Cancellable stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
246+
return restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
247+
AcknowledgedResponse::fromXContent, listener, emptySet());
248+
}
249+
212250
/**
213251
* Get the status of index lifecycle management
214-
* See <a href="https://fix-me-when-we-have-docs.com">
215-
* the docs</a> for more.
252+
* See <pre>
253+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
254+
* java-rest-high-ilm-ilm-status.html
255+
* </pre>
256+
* for more.
216257
*
217258
* @param request the request
218259
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -225,9 +266,11 @@ public LifecycleManagementStatusResponse lifecycleManagementStatus(LifecycleMana
225266

226267
/**
227268
* Asynchronously get the status of index lifecycle management
228-
* See <a href="https://fix-me-when-we-have-docs.com">
229-
* the docs</a> for more.
230-
*
269+
* See <pre>
270+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
271+
* java-rest-high-ilm-ilm-status.html
272+
* </pre>
273+
* for more.
231274
* @param request the request
232275
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
233276
* @param listener the listener to be notified upon request completion
@@ -238,23 +281,13 @@ public void lifecycleManagementStatusAsync(LifecycleManagementStatusRequest requ
238281
LifecycleManagementStatusResponse::fromXContent, listener, emptySet());
239282
}
240283

241-
/**
242-
* Asynchronously stop the Index Lifecycle Management feature.
243-
* See <a href="https://fix-me-when-we-have-docs.com">
244-
* the docs</a> for more.
245-
* @param request the request
246-
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
247-
* @param listener the listener to be notified upon request completion
248-
*/
249-
public void stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
250-
restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
251-
AcknowledgedResponse::fromXContent, listener, emptySet());
252-
}
253-
254284
/**
255285
* Explain the lifecycle state for an index
256-
* See <a href="https://fix-me-when-we-have-docs.com">
257-
* the docs</a> for more.
286+
* See <pre>
287+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
288+
* java-rest-high-ilm-ilm-explain-lifecycle.html
289+
* </pre>
290+
* for more.
258291
* @param request the request
259292
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
260293
* @return the response
@@ -267,8 +300,11 @@ public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request
267300

268301
/**
269302
* Asynchronously explain the lifecycle state for an index
270-
* See <a href="https://fix-me-when-we-have-docs.com">
271-
* the docs</a> for more.
303+
* See <pre>
304+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
305+
* java-rest-high-ilm-ilm-explain-lifecycle.html
306+
* </pre>
307+
* for more.
272308
* @param request the request
273309
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
274310
* @param listener the listener to be notified upon request completion
@@ -281,8 +317,11 @@ public void explainLifecycleAsync(ExplainLifecycleRequest request, RequestOption
281317

282318
/**
283319
* Retry lifecycle step for given indices
284-
* See <a href="https://fix-me-when-we-have-docs.com">
285-
* the docs</a> for more.
320+
* See <pre>
321+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
322+
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
323+
* </pre>
324+
* for more.
286325
* @param request the request
287326
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
288327
* @return the response
@@ -295,8 +334,11 @@ public AcknowledgedResponse retryLifecyclePolicy(RetryLifecyclePolicyRequest req
295334

296335
/**
297336
* Asynchronously retry the lifecycle step for given indices
298-
* See <a href="https://fix-me-when-we-have-docs.com">
299-
* the docs</a> for more.
337+
* See <pre>
338+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
339+
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
340+
* </pre>
341+
* for more.
300342
* @param request the request
301343
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
302344
* @param listener the listener to be notified upon request completion

0 commit comments

Comments
 (0)