Skip to content

Commit 3a3517a

Browse files
gwbrowngwbrown
authored
[7.4] 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 0ae110a commit 3a3517a

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
@@ -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,29 @@ 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+
*/
244+
public void stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
245+
restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
246+
AcknowledgedResponse::fromXContent, listener, emptySet());
247+
}
248+
212249
/**
213250
* 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.
251+
* See <pre>
252+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
253+
* java-rest-high-ilm-ilm-status.html
254+
* </pre>
255+
* for more.
216256
*
217257
* @param request the request
218258
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -225,9 +265,11 @@ public LifecycleManagementStatusResponse lifecycleManagementStatus(LifecycleMana
225265

226266
/**
227267
* 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-
*
268+
* See <pre>
269+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
270+
* java-rest-high-ilm-ilm-status.html
271+
* </pre>
272+
* for more.
231273
* @param request the request
232274
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
233275
* @param listener the listener to be notified upon request completion
@@ -238,23 +280,13 @@ public void lifecycleManagementStatusAsync(LifecycleManagementStatusRequest requ
238280
LifecycleManagementStatusResponse::fromXContent, listener, emptySet());
239281
}
240282

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-
254283
/**
255284
* 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.
285+
* See <pre>
286+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
287+
* java-rest-high-ilm-ilm-explain-lifecycle.html
288+
* </pre>
289+
* for more.
258290
* @param request the request
259291
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
260292
* @return the response
@@ -267,8 +299,11 @@ public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request
267299

268300
/**
269301
* 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.
302+
* See <pre>
303+
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
304+
* java-rest-high-ilm-ilm-explain-lifecycle.html
305+
* </pre>
306+
* for more.
272307
* @param request the request
273308
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
274309
* @param listener the listener to be notified upon request completion
@@ -281,8 +316,11 @@ public void explainLifecycleAsync(ExplainLifecycleRequest request, RequestOption
281316

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

296334
/**
297335
* 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.
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.
300341
* @param request the request
301342
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
302343
* @param listener the listener to be notified upon request completion

0 commit comments

Comments
 (0)