Skip to content

Commit 11f0c99

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 1cc1885 commit 11f0c99

File tree

1 file changed

+81
-40
lines changed

1 file changed

+81
-40
lines changed

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

Lines changed: 81 additions & 40 deletions
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,29 @@ 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+
*/
238+
public void stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
239+
restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
240+
AcknowledgedResponse::fromXContent, listener, emptySet());
241+
}
242+
206243
/**
207244
* 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.
245+
* See <pre>
246+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
247+
* java-rest-high-ilm-ilm-status.html
248+
* </pre>
249+
* for more.
210250
*
211251
* @param request the request
212252
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -219,9 +259,11 @@ public LifecycleManagementStatusResponse lifecycleManagementStatus(LifecycleMana
219259

220260
/**
221261
* 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-
*
262+
* See <pre>
263+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
264+
* java-rest-high-ilm-ilm-status.html
265+
* </pre>
266+
* for more.
225267
* @param request the request
226268
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
227269
* @param listener the listener to be notified upon request completion
@@ -232,23 +274,13 @@ public void lifecycleManagementStatusAsync(LifecycleManagementStatusRequest requ
232274
LifecycleManagementStatusResponse::fromXContent, listener, emptySet());
233275
}
234276

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-
248277
/**
249278
* 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.
279+
* See <pre>
280+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
281+
* java-rest-high-ilm-ilm-explain-lifecycle.html
282+
* </pre>
283+
* for more.
252284
* @param request the request
253285
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
254286
* @return the response
@@ -261,8 +293,11 @@ public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request
261293

262294
/**
263295
* 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.
296+
* See <pre>
297+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
298+
* java-rest-high-ilm-ilm-explain-lifecycle.html
299+
* </pre>
300+
* for more.
266301
* @param request the request
267302
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
268303
* @param listener the listener to be notified upon request completion
@@ -275,8 +310,11 @@ public void explainLifecycleAsync(ExplainLifecycleRequest request, RequestOption
275310

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

290328
/**
291329
* 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.
330+
* See <pre>
331+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
332+
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
333+
* </pre>
334+
* for more.
294335
* @param request the request
295336
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
296337
* @param listener the listener to be notified upon request completion

0 commit comments

Comments
 (0)