Package co.elastic.clients.elasticsearch.features

Class ElasticsearchFeaturesClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchFeaturesClient>

co.elastic.clients.elasticsearch.features.ElasticsearchFeaturesClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchFeaturesClient
extends ApiClient<ElasticsearchTransport,ElasticsearchFeaturesClient>

Client for the features namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchFeaturesClient(ElasticsearchTransport transport)
ElasticsearchFeaturesClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
GetFeaturesResponse	getFeatures()	Get the features.
GetFeaturesResponse	getFeatures(GetFeaturesRequest request)	Get the features.
final GetFeaturesResponse	getFeatures(Function<GetFeaturesRequest.Builder,ObjectBuilder<GetFeaturesRequest>> fn)	Get the features.
ResetFeaturesResponse	resetFeatures()	Reset the features.
ResetFeaturesResponse	resetFeatures(ResetFeaturesRequest request)	Reset the features.
final ResetFeaturesResponse	resetFeatures(Function<ResetFeaturesRequest.Builder,ObjectBuilder<ResetFeaturesRequest>> fn)	Reset the features.
ElasticsearchFeaturesClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElasticsearchFeaturesClient

public ElasticsearchFeaturesClient(ElasticsearchTransport transport)

ElasticsearchFeaturesClient

public ElasticsearchFeaturesClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchFeaturesClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchFeaturesClient>

getFeatures

public GetFeaturesResponse getFeatures(GetFeaturesRequest request)
                                throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFeatures

public final GetFeaturesResponse getFeatures(Function<GetFeaturesRequest.Builder,ObjectBuilder<GetFeaturesRequest>> fn)
                                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFeatures

public GetFeaturesResponse getFeatures()
                                throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resetFeatures

public ResetFeaturesResponse resetFeatures(ResetFeaturesRequest request)
                                    throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resetFeatures

public final ResetFeaturesResponse resetFeatures(Function<ResetFeaturesRequest.Builder,ObjectBuilder<ResetFeaturesRequest>> fn)
                                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

resetFeatures

public ResetFeaturesResponse resetFeatures()
                                    throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co