From 8816e062d8708485e93c56af962e4cdeb8081065 Mon Sep 17 00:00:00 2001 From: Gordon Brown Date: Wed, 16 Oct 2019 07:59:18 -0600 Subject: [PATCH] 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. --- .../client/IndexLifecycleClient.java | 122 ++++++++++++------ 1 file changed, 82 insertions(+), 40 deletions(-) diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/IndexLifecycleClient.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/IndexLifecycleClient.java index 2fe3411ca46c3..2dfa1d588a39f 100644 --- a/client/rest-high-level/src/main/java/org/elasticsearch/client/IndexLifecycleClient.java +++ b/client/rest-high-level/src/main/java/org/elasticsearch/client/IndexLifecycleClient.java @@ -120,8 +120,11 @@ public Cancellable putLifecyclePolicyAsync(PutLifecyclePolicyRequest request, Re /** * Delete a lifecycle definition - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-delete-lifecycle-policy.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return the response @@ -135,8 +138,11 @@ public AcknowledgedResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest r /** * Asynchronously delete a lifecycle definition - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-delete-lifecycle-policy.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener the listener to be notified upon request completion @@ -151,8 +157,11 @@ public Cancellable deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest reque /** * Remove the index lifecycle policy for an index - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return the response @@ -166,8 +175,11 @@ public RemoveIndexLifecyclePolicyResponse removeIndexLifecyclePolicy(RemoveIndex /** * Asynchronously remove the index lifecycle policy for an index - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener the listener to be notified upon request completion @@ -182,8 +194,11 @@ public Cancellable removeIndexLifecyclePolicyAsync(RemoveIndexLifecyclePolicyReq /** * Start the Index Lifecycle Management feature. - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-start-ilm.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return the response @@ -196,8 +211,11 @@ public AcknowledgedResponse startILM(StartILMRequest request, RequestOptions opt /** * Asynchronously start the Index Lifecycle Management feature. - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-start-ilm.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener the listener to be notified upon request completion @@ -210,8 +228,11 @@ public Cancellable startILMAsync(StartILMRequest request, RequestOptions options /** * Stop the Index Lifecycle Management feature. - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-stop-ilm.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return the response @@ -222,10 +243,30 @@ public AcknowledgedResponse stopILM(StopILMRequest request, RequestOptions optio AcknowledgedResponse::fromXContent, emptySet()); } + /** + * Asynchronously stop the Index Lifecycle Management feature. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-stop-ilm.html
+     *
+ * for more. + * @param request the request + * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized + * @param listener the listener to be notified upon request completion + * @return cancellable that may be used to cancel the request + */ + public Cancellable stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener listener) { + return restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options, + AcknowledgedResponse::fromXContent, listener, emptySet()); + } + /** * Get the status of index lifecycle management - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-status.html
+     *
+ * for more. * * @param request the request * @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 /** * Asynchronously get the status of index lifecycle management - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-status.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener the listener to be notified upon request completion @@ -252,24 +296,13 @@ public Cancellable lifecycleManagementStatusAsync(LifecycleManagementStatusReque LifecycleManagementStatusResponse::fromXContent, listener, emptySet()); } - /** - * Asynchronously stop the Index Lifecycle Management feature. - * See - * the docs for more. - * @param request the request - * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized - * @param listener the listener to be notified upon request completion - * @return cancellable that may be used to cancel the request - */ - public Cancellable stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener listener) { - return restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options, - AcknowledgedResponse::fromXContent, listener, emptySet()); - } - /** * Explain the lifecycle state for an index - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-explain-lifecycle.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return the response @@ -282,8 +315,11 @@ public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request /** * Asynchronously explain the lifecycle state for an index - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-explain-lifecycle.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener the listener to be notified upon request completion @@ -297,8 +333,11 @@ public Cancellable explainLifecycleAsync(ExplainLifecycleRequest request, Reques /** * Retry lifecycle step for given indices - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-retry-lifecycle-policy.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @return the response @@ -311,8 +350,11 @@ public AcknowledgedResponse retryLifecyclePolicy(RetryLifecyclePolicyRequest req /** * Asynchronously retry the lifecycle step for given indices - * See - * the docs for more. + * See 
+     *  https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
+     *  java-rest-high-ilm-ilm-retry-lifecycle-policy.html
+     *
+ * for more. * @param request the request * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized * @param listener the listener to be notified upon request completion