Package org.opensearch.client.opensearch.features

Class OpenSearchFeaturesClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchFeaturesClient>

org.opensearch.client.opensearch.features.OpenSearchFeaturesClient

public class OpenSearchFeaturesClient
extends ApiClient<OpenSearchTransport,OpenSearchFeaturesClient>

Client for the features namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchFeaturesClient(OpenSearchTransport transport)
OpenSearchFeaturesClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
GetFeaturesResponse	getFeatures()	Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
ResetFeaturesResponse	resetFeatures()	Resets the internal state of features, usually by deleting system indices
OpenSearchFeaturesClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchFeaturesClient

public OpenSearchFeaturesClient(OpenSearchTransport transport)

OpenSearchFeaturesClient

public OpenSearchFeaturesClient(OpenSearchTransport transport,
                                @Nullable
                                TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchFeaturesClient withTransportOptions(@Nullable
                                                     TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchFeaturesClient>

getFeatures

public GetFeaturesResponse getFeatures()
                                throws java.io.IOException,
                                       OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

resetFeatures

public ResetFeaturesResponse resetFeatures()
                                    throws java.io.IOException,
                                           OpenSearchException

Resets the internal state of features, usually by deleting system indices

Throws:

java.io.IOException

OpenSearchException