Package co.elastic.clients.elasticsearch.features

Class GetFeaturesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.features.GetFeaturesRequest

public class GetFeaturesRequest
extends RequestBase

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:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetFeaturesRequest.Builder	Builder for GetFeaturesRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetFeaturesRequest,GetFeaturesResponse,ErrorResponse>	_ENDPOINT	Endpoint "features.get_features".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	Period to wait for a connection to the master node.
static GetFeaturesRequest	of(Function<GetFeaturesRequest.Builder,ObjectBuilder<GetFeaturesRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<GetFeaturesRequest,GetFeaturesResponse,ErrorResponse> _ENDPOINT

Endpoint "features.get_features".

Method Details

of

public static GetFeaturesRequest of(Function<GetFeaturesRequest.Builder,ObjectBuilder<GetFeaturesRequest>> fn)

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node.

API name: master_timeout