Package co.elastic.clients.elasticsearch.features

Class ElasticsearchFeaturesAsyncClient

java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchFeaturesAsyncClient>
co.elastic.clients.elasticsearch.features.ElasticsearchFeaturesAsyncClient
All Implemented Interfaces:
Closeable, AutoCloseable
public class ElasticsearchFeaturesAsyncClient extends ApiClient<ElasticsearchTransport,ElasticsearchFeaturesAsyncClient>
Client for the features namespace.

  • Constructor Details

  • Method Details

    • withTransportOptions

      public ElasticsearchFeaturesAsyncClient withTransportOptions(@Nullable TransportOptions transportOptions)
      Description copied from class: ApiClient
      Creates a new client with some request options
      Specified by:
      withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchFeaturesAsyncClient>

    • getFeatures

      public CompletableFuture<GetFeaturesResponse> getFeatures(GetFeaturesRequest request)
      Get the features. Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.

      A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.

      The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.

      See Also:

    • getFeatures

      public final CompletableFuture<GetFeaturesResponse> getFeatures(Function<GetFeaturesRequest.Builder,ObjectBuilder<GetFeaturesRequest>> fn)
      Get the features. Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.

      A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.

      The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.

      Parameters:
      fn - a function that initializes a builder to create the GetFeaturesRequest
      See Also:

    • getFeatures

      public CompletableFuture<GetFeaturesResponse> getFeatures()
      Get the features. Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.

      A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.

      The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.

      See Also:

    • resetFeatures

      public CompletableFuture<ResetFeaturesResponse> resetFeatures(ResetFeaturesRequest request)
      Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.

      WARNING: Intended for development and testing use only. Do not reset features on a production cluster.

      Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices.

      The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature.

      Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins.

      To list the features that will be affected, use the get features API.

      IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.

      See Also:

    • resetFeatures

      public final CompletableFuture<ResetFeaturesResponse> resetFeatures(Function<ResetFeaturesRequest.Builder,ObjectBuilder<ResetFeaturesRequest>> fn)
      Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.

      WARNING: Intended for development and testing use only. Do not reset features on a production cluster.

      Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices.

      The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature.

      Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins.

      To list the features that will be affected, use the get features API.

      IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.

      Parameters:
      fn - a function that initializes a builder to create the ResetFeaturesRequest
      See Also:

    • resetFeatures

      public CompletableFuture<ResetFeaturesResponse> resetFeatures()
      Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.

      WARNING: Intended for development and testing use only. Do not reset features on a production cluster.

      Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices.

      The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature.

      Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins.

      To list the features that will be affected, use the get features API.

      IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.

      See Also: