Package org.opensearch.client.opensearch.features

Class OpenSearchFeaturesAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.features.OpenSearchFeaturesAsyncClient

public class OpenSearchFeaturesAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchFeaturesAsyncClient>

Client for the features namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<GetFeaturesResponse>	getFeatures()	Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
java.util.concurrent.CompletableFuture<ResetFeaturesResponse>	resetFeatures()	Resets the internal state of features, usually by deleting system indices
OpenSearchFeaturesAsyncClient	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

OpenSearchFeaturesAsyncClient

public OpenSearchFeaturesAsyncClient(OpenSearchTransport transport)

OpenSearchFeaturesAsyncClient

public OpenSearchFeaturesAsyncClient(OpenSearchTransport transport,
                                     @Nullable
                                     TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchFeaturesAsyncClient withTransportOptions(@Nullable
                                                          TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchFeaturesAsyncClient>

getFeatures

public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<ResetFeaturesResponse> resetFeatures()
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException