Class FeaturesClient

java.lang.Object
org.elasticsearch.client.FeaturesClient

public class FeaturesClient
extends java.lang.Object
A wrapper for the RestHighLevelClient that provides methods for accessing the Snapshot API.

See Snapshot API on elastic.co

  • Method Summary

    Modifier and Type Method Description
    GetFeaturesResponse getFeatures​(GetFeaturesRequest getFeaturesRequest, org.elasticsearch.client.RequestOptions options)
    Get a list of features which can be included in a snapshot as feature states.
    org.elasticsearch.client.Cancellable getFeaturesAsync​(GetFeaturesRequest getFeaturesRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetFeaturesResponse> listener)
    Asynchronously get a list of features which can be included in a snapshot as feature states.
    ResetFeaturesResponse resetFeatures​(ResetFeaturesRequest resetFeaturesRequest, org.elasticsearch.client.RequestOptions options)
    Reset the state of Elasticsearch features, deleting system indices and performing other cleanup operations.
    org.elasticsearch.client.Cancellable resetFeaturesAsync​(ResetFeaturesRequest resetFeaturesRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<ResetFeaturesResponse> listener)
    Asynchronously reset the state of Elasticsearch features, deleting system indices and performing other cleanup operations.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • getFeatures

      public GetFeaturesResponse getFeatures​(GetFeaturesRequest getFeaturesRequest, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Get a list of features which can be included in a snapshot as feature states. See Get Snapshottable Features API on elastic.co
      Parameters:
      getFeaturesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      java.io.IOException - in case there is a problem sending the request or parsing back the response
    • getFeaturesAsync

      public org.elasticsearch.client.Cancellable getFeaturesAsync​(GetFeaturesRequest getFeaturesRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetFeaturesResponse> listener)
      Asynchronously get a list of features which can be included in a snapshot as feature states. See Get Snapshottable Features API on elastic.co
      Parameters:
      getFeaturesRequest - 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
    • resetFeatures

      public ResetFeaturesResponse resetFeatures​(ResetFeaturesRequest resetFeaturesRequest, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Reset the state of Elasticsearch features, deleting system indices and performing other cleanup operations. See Rest Features API on elastic.co
      Parameters:
      resetFeaturesRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      java.io.IOException - in case there is a problem sending the request or parsing back the response
    • resetFeaturesAsync

      public org.elasticsearch.client.Cancellable resetFeaturesAsync​(ResetFeaturesRequest resetFeaturesRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<ResetFeaturesResponse> listener)
      Asynchronously reset the state of Elasticsearch features, deleting system indices and performing other cleanup operations. See Get Snapshottable Features API on elastic.co
      Parameters:
      resetFeaturesRequest - 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