View Source ElasticsearchEx.API.Features (Elasticsearch_ex v1.8.3)
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
@type opts() :: ElasticsearchEx.opts()
Functions
@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"}
]
}}
@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"
}
]
}}