Skip to content

Commit 498b4ea

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 97e64fe commit 498b4ea

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

+82-40
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,11 @@ public void putLifecyclePolicyAsync(PutLifecyclePolicyRequest request, RequestOp
106106

107107
/**
108108
* Delete a lifecycle definition
109-
* See <a href="https://fix-me-when-we-have-docs.com">
110-
* the docs</a> for more.
109+
* See <pre>
110+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
111+
* java-rest-high-ilm-ilm-delete-lifecycle-policy.html
112+
* </pre>
113+
* for more.
111114
* @param request the request
112115
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
113116
* @return the response
@@ -121,8 +124,11 @@ public AcknowledgedResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest r
121124

122125
/**
123126
* Asynchronously delete a lifecycle definition
124-
* See <a href="https://fix-me-when-we-have-docs.com">
125-
* the docs</a> for more.
127+
* See <pre>
128+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
129+
* java-rest-high-ilm-ilm-delete-lifecycle-policy.html
130+
* </pre>
131+
* for more.
126132
* @param request the request
127133
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
128134
* @param listener the listener to be notified upon request completion
@@ -135,8 +141,11 @@ public void deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest request, Req
135141

136142
/**
137143
* Remove the index lifecycle policy for an index
138-
* See <a href="https://fix-me-when-we-have-docs.com">
139-
* the docs</a> for more.
144+
* See <pre>
145+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
146+
* java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
147+
* </pre>
148+
* for more.
140149
* @param request the request
141150
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
142151
* @return the response
@@ -150,8 +159,11 @@ public RemoveIndexLifecyclePolicyResponse removeIndexLifecyclePolicy(RemoveIndex
150159

151160
/**
152161
* Asynchronously remove the index lifecycle policy for an index
153-
* See <a href="https://fix-me-when-we-have-docs.com">
154-
* the docs</a> for more.
162+
* See <pre>
163+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
164+
* java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
165+
* </pre>
166+
* for more.
155167
* @param request the request
156168
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
157169
* @param listener the listener to be notified upon request completion
@@ -164,8 +176,11 @@ public void removeIndexLifecyclePolicyAsync(RemoveIndexLifecyclePolicyRequest re
164176

165177
/**
166178
* Start the Index Lifecycle Management feature.
167-
* See <a href="https://fix-me-when-we-have-docs.com">
168-
* the docs</a> for more.
179+
* See <pre>
180+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
181+
* java-rest-high-ilm-ilm-start-ilm.html
182+
* </pre>
183+
* for more.
169184
* @param request the request
170185
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
171186
* @return the response
@@ -178,8 +193,11 @@ public AcknowledgedResponse startILM(StartILMRequest request, RequestOptions opt
178193

179194
/**
180195
* Asynchronously start the Index Lifecycle Management feature.
181-
* See <a href="https://fix-me-when-we-have-docs.com">
182-
* the docs</a> for more.
196+
* See <pre>
197+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
198+
* java-rest-high-ilm-ilm-start-ilm.html
199+
* </pre>
200+
* for more.
183201
* @param request the request
184202
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
185203
* @param listener the listener to be notified upon request completion
@@ -191,8 +209,11 @@ public void startILMAsync(StartILMRequest request, RequestOptions options, Actio
191209

192210
/**
193211
* Stop the Index Lifecycle Management feature.
194-
* See <a href="https://fix-me-when-we-have-docs.com">
195-
* the docs</a> for more.
212+
* See <pre>
213+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
214+
* java-rest-high-ilm-ilm-stop-ilm.html
215+
* </pre>
216+
* for more.
196217
* @param request the request
197218
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
198219
* @return the response
@@ -203,10 +224,30 @@ public AcknowledgedResponse stopILM(StopILMRequest request, RequestOptions optio
203224
AcknowledgedResponse::fromXContent, emptySet());
204225
}
205226

227+
/**
228+
* Asynchronously stop the Index Lifecycle Management feature.
229+
* See <pre>
230+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
231+
* java-rest-high-ilm-ilm-stop-ilm.html
232+
* </pre>
233+
* for more.
234+
* @param request the request
235+
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
236+
* @param listener the listener to be notified upon request completion
237+
* @return cancellable that may be used to cancel the request
238+
*/
239+
public Cancellable stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
240+
return restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
241+
AcknowledgedResponse::fromXContent, listener, emptySet());
242+
}
243+
206244
/**
207245
* Get the status of index lifecycle management
208-
* See <a href="https://fix-me-when-we-have-docs.com">
209-
* the docs</a> for more.
246+
* See <pre>
247+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
248+
* java-rest-high-ilm-ilm-status.html
249+
* </pre>
250+
* for more.
210251
*
211252
* @param request the request
212253
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -219,9 +260,11 @@ public LifecycleManagementStatusResponse lifecycleManagementStatus(LifecycleMana
219260

220261
/**
221262
* Asynchronously get the status of index lifecycle management
222-
* See <a href="https://fix-me-when-we-have-docs.com">
223-
* the docs</a> for more.
224-
*
263+
* See <pre>
264+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
265+
* java-rest-high-ilm-ilm-status.html
266+
* </pre>
267+
* for more.
225268
* @param request the request
226269
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
227270
* @param listener the listener to be notified upon request completion
@@ -232,23 +275,13 @@ public void lifecycleManagementStatusAsync(LifecycleManagementStatusRequest requ
232275
LifecycleManagementStatusResponse::fromXContent, listener, emptySet());
233276
}
234277

235-
/**
236-
* Asynchronously stop the Index Lifecycle Management feature.
237-
* See <a href="https://fix-me-when-we-have-docs.com">
238-
* the docs</a> for more.
239-
* @param request the request
240-
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
241-
* @param listener the listener to be notified upon request completion
242-
*/
243-
public void stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
244-
restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
245-
AcknowledgedResponse::fromXContent, listener, emptySet());
246-
}
247-
248278
/**
249279
* Explain the lifecycle state for an index
250-
* See <a href="https://fix-me-when-we-have-docs.com">
251-
* the docs</a> for more.
280+
* See <pre>
281+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
282+
* java-rest-high-ilm-ilm-explain-lifecycle.html
283+
* </pre>
284+
* for more.
252285
* @param request the request
253286
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
254287
* @return the response
@@ -261,8 +294,11 @@ public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request
261294

262295
/**
263296
* Asynchronously explain the lifecycle state for an index
264-
* See <a href="https://fix-me-when-we-have-docs.com">
265-
* the docs</a> for more.
297+
* See <pre>
298+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
299+
* java-rest-high-ilm-ilm-explain-lifecycle.html
300+
* </pre>
301+
* for more.
266302
* @param request the request
267303
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
268304
* @param listener the listener to be notified upon request completion
@@ -275,8 +311,11 @@ public void explainLifecycleAsync(ExplainLifecycleRequest request, RequestOption
275311

276312
/**
277313
* Retry lifecycle step for given indices
278-
* See <a href="https://fix-me-when-we-have-docs.com">
279-
* the docs</a> for more.
314+
* See <pre>
315+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
316+
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
317+
* </pre>
318+
* for more.
280319
* @param request the request
281320
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
282321
* @return the response
@@ -289,8 +328,11 @@ public AcknowledgedResponse retryLifecyclePolicy(RetryLifecyclePolicyRequest req
289328

290329
/**
291330
* Asynchronously retry the lifecycle step for given indices
292-
* See <a href="https://fix-me-when-we-have-docs.com">
293-
* the docs</a> for more.
331+
* See <pre>
332+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
333+
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
334+
* </pre>
335+
* for more.
294336
* @param request the request
295337
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
296338
* @param listener the listener to be notified upon request completion

0 commit comments

Comments
 (0)