View Source ElasticsearchEx.Api.Features (Elasticsearch_ex v1.6.0)

You can use the following APIs to introspect and manage Features provided by Elasticsearch and Elasticsearch plugins.

Summary

Functions

Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot.

Clears all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.

Types

Functions

Link to this function

get(opts \\ [])

View Source (since 1.5.0)
@spec get(opts()) :: ElasticsearchEx.response()

Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot.

Examples

iex> ElasticsearchEx.Api.Features.get()
{:ok,
 %{
   "features" => [
     %{
       "description" => "Manages Kibana configuration and reports",
       "name" => "kibana"
     },
     %{"description" => "Manages synonyms", "name" => "synonyms"}
   ]
 }}
Link to this function

reset(opts \\ [])

View Source (since 1.5.0)
@spec reset(opts()) :: ElasticsearchEx.response()

Clears all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.

Important

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

Examples

iex> ElasticsearchEx.Api.Features.reset()
{:ok,
 %{
   "features" => [
     %{
       "feature_name" => "security",
       "status" => "SUCCESS"
     },
     %{
       "feature_name" => "tasks",
       "status" => "SUCCESS"
     }
   ]
 }}