Package org.elasticsearch.client

Class IndexLifecycleClient

java.lang.Object
org.elasticsearch.client.IndexLifecycleClient
@Deprecated public class IndexLifecycleClient extends Object
Deprecated.
The High Level Rest Client is deprecated in favor of the Elasticsearch Java API Client

  • Method Details

    • getLifecyclePolicy

      public GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Retrieve one or more lifecycle policy definition. See the docs for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getLifecyclePolicyAsync

      public Cancellable getLifecyclePolicyAsync(GetLifecyclePolicyRequest request, RequestOptions options, ActionListener<GetLifecyclePolicyResponse> listener)
      Deprecated.
      Asynchronously retrieve one or more lifecycle policy definition. See the docs for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • putLifecyclePolicy

      public AcknowledgedResponse putLifecyclePolicy(PutLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Create or modify a lifecycle definition. See the docs for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • putLifecyclePolicyAsync

      public Cancellable putLifecyclePolicyAsync(PutLifecyclePolicyRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously create or modify a lifecycle definition. See the docs for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • deleteLifecyclePolicy

      public AcknowledgedResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Delete a lifecycle definition See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-delete-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • deleteLifecyclePolicyAsync

      public Cancellable deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously delete a lifecycle definition See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-delete-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • removeIndexLifecyclePolicy

      public RemoveIndexLifecyclePolicyResponse removeIndexLifecyclePolicy(RemoveIndexLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Remove the index lifecycle policy for an index 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.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • removeIndexLifecyclePolicyAsync

      public Cancellable removeIndexLifecyclePolicyAsync(RemoveIndexLifecyclePolicyRequest request, RequestOptions options, ActionListener<RemoveIndexLifecyclePolicyResponse> listener)
      Deprecated.
      Asynchronously remove the index lifecycle policy for an index 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.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • startILM

      public AcknowledgedResponse startILM(StartILMRequest request, RequestOptions options) throws IOException
      Deprecated.
      Start the Index Lifecycle Management feature. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-start-ilm.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • startILMAsync

      public Cancellable startILMAsync(StartILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously start the Index Lifecycle Management feature. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-start-ilm.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • stopILM

      public AcknowledgedResponse stopILM(StopILMRequest request, RequestOptions options) throws IOException
      Deprecated.
      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.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • stopILMAsync

      public Cancellable stopILMAsync(StopILMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      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.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • lifecycleManagementStatus

      public LifecycleManagementStatusResponse lifecycleManagementStatus(LifecycleManagementStatusRequest request, RequestOptions options) throws IOException
      Deprecated.
      Get the status of index lifecycle management See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-status.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Throws:
      IOException

    • lifecycleManagementStatusAsync

      public Cancellable lifecycleManagementStatusAsync(LifecycleManagementStatusRequest request, RequestOptions options, ActionListener<LifecycleManagementStatusResponse> listener)
      Deprecated.
      Asynchronously get the status of index lifecycle management See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-status.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • explainLifecycle

      public ExplainLifecycleResponse explainLifecycle(ExplainLifecycleRequest request, RequestOptions options) throws IOException
      Deprecated.
      Explain the lifecycle state for an index See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-explain-lifecycle.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • explainLifecycleAsync

      public Cancellable explainLifecycleAsync(ExplainLifecycleRequest request, RequestOptions options, ActionListener<ExplainLifecycleResponse> listener)
      Deprecated.
      Asynchronously explain the lifecycle state for an index See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-explain-lifecycle.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • retryLifecyclePolicy

      public AcknowledgedResponse retryLifecyclePolicy(RetryLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Retry lifecycle step for given indices See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-retry-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • retryLifecyclePolicyAsync

      public Cancellable retryLifecyclePolicyAsync(RetryLifecyclePolicyRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously retry the lifecycle step for given indices See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-ilm-retry-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getSnapshotLifecyclePolicy

      public GetSnapshotLifecyclePolicyResponse getSnapshotLifecyclePolicy(GetSnapshotLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Retrieve one or more snapshot lifecycle policy definitions. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-get-snapshot-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getSnapshotLifecyclePolicyAsync

      public Cancellable getSnapshotLifecyclePolicyAsync(GetSnapshotLifecyclePolicyRequest request, RequestOptions options, ActionListener<GetSnapshotLifecyclePolicyResponse> listener)
      Deprecated.
      Asynchronously retrieve one or more snapshot lifecycle policy definition. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-get-snapshot-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • putSnapshotLifecyclePolicy

      public AcknowledgedResponse putSnapshotLifecyclePolicy(PutSnapshotLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Create or modify a snapshot lifecycle definition. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-put-snapshot-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • putSnapshotLifecyclePolicyAsync

      public Cancellable putSnapshotLifecyclePolicyAsync(PutSnapshotLifecyclePolicyRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously create or modify a snapshot lifecycle definition. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-put-snapshot-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • deleteSnapshotLifecyclePolicy

      public AcknowledgedResponse deleteSnapshotLifecyclePolicy(DeleteSnapshotLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Delete a snapshot lifecycle definition See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-delete-snapshot-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • deleteSnapshotLifecyclePolicyAsync

      public Cancellable deleteSnapshotLifecyclePolicyAsync(DeleteSnapshotLifecyclePolicyRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously delete a snapshot lifecycle definition See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-delete-snapshot-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • executeSnapshotLifecyclePolicy

      public ExecuteSnapshotLifecyclePolicyResponse executeSnapshotLifecyclePolicy(ExecuteSnapshotLifecyclePolicyRequest request, RequestOptions options) throws IOException
      Deprecated.
      Execute a snapshot lifecycle definition See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-execute-snapshot-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • executeSnapshotLifecyclePolicyAsync

      public Cancellable executeSnapshotLifecyclePolicyAsync(ExecuteSnapshotLifecyclePolicyRequest request, RequestOptions options, ActionListener<ExecuteSnapshotLifecyclePolicyResponse> listener)
      Deprecated.
      Asynchronously execute a snapshot lifecycle definition See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-execute-snapshot-lifecycle-policy.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • executeSnapshotLifecycleRetention

      public AcknowledgedResponse executeSnapshotLifecycleRetention(ExecuteSnapshotLifecycleRetentionRequest request, RequestOptions options) throws IOException
      Deprecated.
      Execute snapshot lifecycle retention See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-execute-snapshot-lifecycle-retention.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • executeSnapshotLifecycleRetentionAsync

      public Cancellable executeSnapshotLifecycleRetentionAsync(ExecuteSnapshotLifecycleRetentionRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously execute snapshot lifecycle retention See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-execute-snapshot-lifecycle-retention.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getSnapshotLifecycleStats

      public GetSnapshotLifecycleStatsResponse getSnapshotLifecycleStats(GetSnapshotLifecycleStatsRequest request, RequestOptions options) throws IOException
      Deprecated.
      Retrieve snapshot lifecycle statistics. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-get-snapshot-lifecycle-stats.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getSnapshotLifecycleStatsAsync

      public Cancellable getSnapshotLifecycleStatsAsync(GetSnapshotLifecycleStatsRequest request, RequestOptions options, ActionListener<GetSnapshotLifecycleStatsResponse> listener)
      Deprecated.
      Asynchronously retrieve snapshot lifecycle statistics. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-get-snapshot-lifecycle-stats.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion

    • startSLM

      public AcknowledgedResponse startSLM(StartSLMRequest request, RequestOptions options) throws IOException
      Deprecated.
      Start the Snapshot Lifecycle Management feature. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-start-slm.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • startSLMAsync

      public Cancellable startSLMAsync(StartSLMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously start the Snapshot Lifecycle Management feature. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-start-slm.html
      for more.
      Parameters:
      request - the request
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • stopSLM

      public AcknowledgedResponse stopSLM(StopSLMRequest request, RequestOptions options) throws IOException
      Deprecated.
      Stop the Snapshot Lifecycle Management feature. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-stop-slm.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • stopSLMAsync

      public Cancellable stopSLMAsync(StopSLMRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)
      Deprecated.
      Asynchronously stop the Snapshot Lifecycle Management feature. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-stop-slm.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getSLMStatus

      public LifecycleManagementStatusResponse getSLMStatus(SnapshotLifecycleManagementStatusRequest request, RequestOptions options) throws IOException
      Deprecated.
      Get the status of Snapshot Lifecycle Management. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-status.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException - in case there is a problem sending the request or parsing back the response

    • getSLMStatusAsync

      public Cancellable getSLMStatusAsync(SnapshotLifecycleManagementStatusRequest request, RequestOptions options, ActionListener<LifecycleManagementStatusResponse> listener)
      Deprecated.
      Asynchronously get the status of Snapshot Lifecycle Management. See 
        https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/
  java-rest-high-ilm-slm-status.html
      for more.
      Parameters:
      request - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - the listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request