Package org.opensearch.client.opensearch.api.features

Class FeaturesClient

java.lang.Object

org.opensearch.client.base.ApiClient<FeaturesClient>

org.opensearch.client.opensearch.api.features.FeaturesClient

public class FeaturesClient
extends ApiClient<FeaturesClient>

Client for the features namespace.

Field Summary

Fields inherited from class org.opensearch.client.base.ApiClient

requestOptions, transport

Constructor Summary

Constructors

Constructor	Description
FeaturesClient(Transport transport)
FeaturesClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Summary

Modifier and Type	Method	Description
GetFeaturesResponse	getFeatures(java.util.function.Function<GetFeaturesRequest.Builder,ObjectBuilder<GetFeaturesRequest>> fn)	Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
GetFeaturesResponse	getFeatures(GetFeaturesRequest request)	Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
ResetFeaturesResponse	resetFeatures(java.util.function.Function<ResetFeaturesRequest.Builder,ObjectBuilder<ResetFeaturesRequest>> fn)	Resets the internal state of features, usually by deleting system indices
ResetFeaturesResponse	resetFeatures(ResetFeaturesRequest request)	Resets the internal state of features, usually by deleting system indices
FeaturesClient	withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)	Creates a new FeaturesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.
FeaturesClient	withRequestOptions(org.opensearch.client.RequestOptions options)	Creates a new FeaturesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Methods inherited from class org.opensearch.client.base.ApiClient

getDeserializer, requestOptions

Methods inherited from class java.lang.Object

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

Constructor Details

FeaturesClient

public FeaturesClient(Transport transport)

FeaturesClient

public FeaturesClient(Transport transport, org.opensearch.client.RequestOptions options)

Method Details

getFeatures

public GetFeaturesResponse getFeatures(GetFeaturesRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

getFeatures

public final GetFeaturesResponse getFeatures(java.util.function.Function<GetFeaturesRequest.Builder,ObjectBuilder<GetFeaturesRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

resetFeatures

public ResetFeaturesResponse resetFeatures(ResetFeaturesRequest request) throws java.io.IOException

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

Throws:

java.io.IOException

resetFeatures

public final ResetFeaturesResponse resetFeatures(java.util.function.Function<ResetFeaturesRequest.Builder,ObjectBuilder<ResetFeaturesRequest>> fn) throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

withRequestOptions

public FeaturesClient withRequestOptions(@Nullable org.opensearch.client.RequestOptions options)

Creates a new FeaturesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options.

Specified by:

withRequestOptions in class ApiClient<FeaturesClient>

withRequestOptions

public FeaturesClient withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)

Creates a new FeaturesClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions) with specific request options, inheriting existing options.

Parameters:

fn - a function taking an options builder initialized with the current request options, or initialized with default values.