Skip to content

Commit

Permalink
Fix ILM HLRC Javadoc->Documentation links (elastic#48083)
Browse files Browse the repository at this point in the history 
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.
  • Loading branch information
@gwbrown
gwbrown committed Oct 16, 2019
1 parent b5cf982 commit 90eae6b
Showing 1 changed file with 82 additions and 40 deletions.
122 changes: 82 additions & 40 deletions client/rest-high-level/src/main/java/org/elasticsearch/client/IndexLifecycleClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,11 @@ public void putLifecyclePolicyAsync(PutLifecyclePolicyRequest request, RequestOp

/**
* Delete a lifecycle definition
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-delete-lifecycle-policy.html
* </pre>
* 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
Expand All @@ -127,8 +130,11 @@ public AcknowledgedResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest r

/**
* Asynchronously delete a lifecycle definition
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-delete-lifecycle-policy.html
* </pre>
* 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
Expand All @@ -141,8 +147,11 @@ public void deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest request, Req

/**
* Remove the index lifecycle policy for an index
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
* </pre>
* 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
Expand All @@ -156,8 +165,11 @@ public RemoveIndexLifecyclePolicyResponse removeIndexLifecyclePolicy(RemoveIndex

/**
* Asynchronously remove the index lifecycle policy for an index
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-remove-lifecycle-policy-from-index.html
* </pre>
* 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
Expand All @@ -170,8 +182,11 @@ public void removeIndexLifecyclePolicyAsync(RemoveIndexLifecyclePolicyRequest re

/**
* Start the Index Lifecycle Management feature.
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-start-ilm.html
* </pre>
* 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
Expand All @@ -184,8 +199,11 @@ public AcknowledgedResponse startILM(StartILMRequest request, RequestOptions opt

/**
* Asynchronously start the Index Lifecycle Management feature.
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-start-ilm.html
* </pre>
* 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
Expand All @@ -197,8 +215,11 @@ public void startILMAsync(StartILMRequest request, RequestOptions options, Actio

/**
* Stop the Index Lifecycle Management feature.
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-stop-ilm.html
* </pre>
* 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
Expand All @@ -209,10 +230,30 @@ public AcknowledgedResponse stopILM(StopILMRequest request, RequestOptions optio
AcknowledgedResponse::fromXContent, emptySet());
}

/**
* Asynchronously stop the Index Lifecycle Management feature.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-stop-ilm.html
* </pre>
* 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<AcknowledgedResponse> listener) {
return restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
AcknowledgedResponse::fromXContent, listener, emptySet());
}

/**
* Get the status of index lifecycle management
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-status.html
* </pre>
* for more.
*
* @param request the request
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
Expand All @@ -225,9 +266,11 @@ public LifecycleManagementStatusResponse lifecycleManagementStatus(LifecycleMana

/**
* Asynchronously get the status of index lifecycle management
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
*
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-status.html
* </pre>
* 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
Expand All @@ -238,23 +281,13 @@ public void lifecycleManagementStatusAsync(LifecycleManagementStatusRequest requ
LifecycleManagementStatusResponse::fromXContent, listener, emptySet());
}

/**
* Asynchronously stop the Index Lifecycle Management feature.
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> 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
*/
public void stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener) {
restHighLevelClient.performRequestAsyncAndParseEntity(request, IndexLifecycleRequestConverters::stopILM, options,
AcknowledgedResponse::fromXContent, listener, emptySet());
}

/**
* Explain the lifecycle state for an index
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-explain-lifecycle.html
* </pre>
* 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
Expand All @@ -267,8 +300,11 @@ public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request

/**
* Asynchronously explain the lifecycle state for an index
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-explain-lifecycle.html
* </pre>
* 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
Expand All @@ -281,8 +317,11 @@ public void explainLifecycleAsync(ExplainLifecycleRequest request, RequestOption

/**
* Retry lifecycle step for given indices
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
* </pre>
* 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
Expand All @@ -295,8 +334,11 @@ public AcknowledgedResponse retryLifecyclePolicy(RetryLifecyclePolicyRequest req

/**
* Asynchronously retry the lifecycle step for given indices
* See <a href="https://fix-me-when-we-have-docs.com">
* the docs</a> for more.
* See <pre>
* https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
* java-rest-high-ilm-ilm-retry-lifecycle-policy.html
* </pre>
* 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
Expand Down

0 comments on commit 90eae6b

Please sign in to comment.