Package org.opensearch.client.opensearch.ism

Class OpenSearchIsmAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.ism.OpenSearchIsmAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchIsmAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchIsmAsyncClient>

Client for the ism namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<AddPolicyResponse>	addPolicy(Function<AddPolicyRequest.Builder,ObjectBuilder<AddPolicyRequest>> fn)	Adds a policy to an index.
CompletableFuture<AddPolicyResponse>	addPolicy(AddPolicyRequest request)	Adds a policy to an index.
final CompletableFuture<ChangePolicyResponse>	changePolicy(Function<ChangePolicyRequest.Builder,ObjectBuilder<ChangePolicyRequest>> fn)	Updates the managed index policy to a new policy.
CompletableFuture<ChangePolicyResponse>	changePolicy(ChangePolicyRequest request)	Updates the managed index policy to a new policy.
final CompletableFuture<DeletePolicyResponse>	deletePolicy(Function<DeletePolicyRequest.Builder,ObjectBuilder<DeletePolicyRequest>> fn)	Deletes a policy.
CompletableFuture<DeletePolicyResponse>	deletePolicy(DeletePolicyRequest request)	Deletes a policy.
final CompletableFuture<ExistsPolicyResponse>	existsPolicy(Function<ExistsPolicyRequest.Builder,ObjectBuilder<ExistsPolicyRequest>> fn)	Checks for the existence of a policy.
CompletableFuture<ExistsPolicyResponse>	existsPolicy(ExistsPolicyRequest request)	Checks for the existence of a policy.
final CompletableFuture<ExplainPolicyResponse>	explainPolicy(Function<ExplainPolicyRequest.Builder,ObjectBuilder<ExplainPolicyRequest>> fn)	Retrieves the currently applied policy on the specified indexes.
CompletableFuture<ExplainPolicyResponse>	explainPolicy(ExplainPolicyRequest request)	Retrieves the currently applied policy on the specified indexes.
final CompletableFuture<GetPoliciesResponse>	getPolicies()	Retrieves the policies.
final CompletableFuture<GetPoliciesResponse>	getPolicies(Function<GetPoliciesRequest.Builder,ObjectBuilder<GetPoliciesRequest>> fn)	Retrieves the policies.
CompletableFuture<GetPoliciesResponse>	getPolicies(GetPoliciesRequest request)	Retrieves the policies.
final CompletableFuture<GetPolicyResponse>	getPolicy(Function<GetPolicyRequest.Builder,ObjectBuilder<GetPolicyRequest>> fn)	Retrieves a specific policy.
CompletableFuture<GetPolicyResponse>	getPolicy(GetPolicyRequest request)	Retrieves a specific policy.
final CompletableFuture<PutPoliciesResponse>	putPolicies(Function<PutPoliciesRequest.Builder,ObjectBuilder<PutPoliciesRequest>> fn)	Creates or updates policies.
CompletableFuture<PutPoliciesResponse>	putPolicies(PutPoliciesRequest request)	Creates or updates policies.
final CompletableFuture<PutPolicyResponse>	putPolicy(Function<PutPolicyRequest.Builder,ObjectBuilder<PutPolicyRequest>> fn)	Creates or updates a policy.
CompletableFuture<PutPolicyResponse>	putPolicy(PutPolicyRequest request)	Creates or updates a policy.
final CompletableFuture<RefreshSearchAnalyzersResponse>	refreshSearchAnalyzers(Function<RefreshSearchAnalyzersRequest.Builder,ObjectBuilder<RefreshSearchAnalyzersRequest>> fn)	Refreshes search analyzers in real time.
CompletableFuture<RefreshSearchAnalyzersResponse>	refreshSearchAnalyzers(RefreshSearchAnalyzersRequest request)	Refreshes search analyzers in real time.
final CompletableFuture<RemovePolicyResponse>	removePolicy()	Removes a policy from an index.
final CompletableFuture<RemovePolicyResponse>	removePolicy(Function<RemovePolicyRequest.Builder,ObjectBuilder<RemovePolicyRequest>> fn)	Removes a policy from an index.
CompletableFuture<RemovePolicyResponse>	removePolicy(RemovePolicyRequest request)	Removes a policy from an index.
final CompletableFuture<RetryIndexResponse>	retryIndex(Function<RetryIndexRequest.Builder,ObjectBuilder<RetryIndexRequest>> fn)	Retries the failed action for an index.
CompletableFuture<RetryIndexResponse>	retryIndex(RetryIndexRequest request)	Retries the failed action for an index.
OpenSearchIsmAsyncClient	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 Details

OpenSearchIsmAsyncClient

public OpenSearchIsmAsyncClient(OpenSearchTransport transport)

OpenSearchIsmAsyncClient

public OpenSearchIsmAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchIsmAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchIsmAsyncClient>

addPolicy

public CompletableFuture<AddPolicyResponse> addPolicy(AddPolicyRequest request)
                                               throws IOException,
OpenSearchException

Adds a policy to an index.

Throws:

IOException

OpenSearchException

addPolicy

public final CompletableFuture<AddPolicyResponse> addPolicy(Function<AddPolicyRequest.Builder,ObjectBuilder<AddPolicyRequest>> fn)
                                                     throws IOException,
OpenSearchException

Adds a policy to an index.

Parameters:

fn - a function that initializes a builder to create the AddPolicyRequest

Throws:

IOException

OpenSearchException

changePolicy

public CompletableFuture<ChangePolicyResponse> changePolicy(ChangePolicyRequest request)
                                                     throws IOException,
OpenSearchException

Updates the managed index policy to a new policy.

Throws:

IOException

OpenSearchException

changePolicy

public final CompletableFuture<ChangePolicyResponse> changePolicy(Function<ChangePolicyRequest.Builder,ObjectBuilder<ChangePolicyRequest>> fn)
                                                           throws IOException,
OpenSearchException

Updates the managed index policy to a new policy.

Parameters:

fn - a function that initializes a builder to create the ChangePolicyRequest

Throws:

IOException

OpenSearchException

deletePolicy

public CompletableFuture<DeletePolicyResponse> deletePolicy(DeletePolicyRequest request)
                                                     throws IOException,
OpenSearchException

Deletes a policy.

Throws:

IOException

OpenSearchException

deletePolicy

public final CompletableFuture<DeletePolicyResponse> deletePolicy(Function<DeletePolicyRequest.Builder,ObjectBuilder<DeletePolicyRequest>> fn)
                                                           throws IOException,
OpenSearchException

Deletes a policy.

Parameters:

fn - a function that initializes a builder to create the DeletePolicyRequest

Throws:

IOException

OpenSearchException

existsPolicy

public CompletableFuture<ExistsPolicyResponse> existsPolicy(ExistsPolicyRequest request)
                                                     throws IOException,
OpenSearchException

Checks for the existence of a policy.

Throws:

IOException

OpenSearchException

existsPolicy

public final CompletableFuture<ExistsPolicyResponse> existsPolicy(Function<ExistsPolicyRequest.Builder,ObjectBuilder<ExistsPolicyRequest>> fn)
                                                           throws IOException,
OpenSearchException

Checks for the existence of a policy.

Parameters:

fn - a function that initializes a builder to create the ExistsPolicyRequest

Throws:

IOException

OpenSearchException

explainPolicy

public CompletableFuture<ExplainPolicyResponse> explainPolicy(ExplainPolicyRequest request)
                                                       throws IOException,
OpenSearchException

Retrieves the currently applied policy on the specified indexes.

Throws:

IOException

OpenSearchException

explainPolicy

public final CompletableFuture<ExplainPolicyResponse> explainPolicy(Function<ExplainPolicyRequest.Builder,ObjectBuilder<ExplainPolicyRequest>> fn)
                                                             throws IOException,
OpenSearchException

Retrieves the currently applied policy on the specified indexes.

Parameters:

fn - a function that initializes a builder to create the ExplainPolicyRequest

Throws:

IOException

OpenSearchException

getPolicies

public CompletableFuture<GetPoliciesResponse> getPolicies(GetPoliciesRequest request)
                                                   throws IOException,
OpenSearchException

Retrieves the policies.

Throws:

IOException

OpenSearchException

getPolicies

public final CompletableFuture<GetPoliciesResponse> getPolicies(Function<GetPoliciesRequest.Builder,ObjectBuilder<GetPoliciesRequest>> fn)
                                                         throws IOException,
OpenSearchException

Retrieves the policies.

Parameters:

fn - a function that initializes a builder to create the GetPoliciesRequest

Throws:

IOException

OpenSearchException

getPolicies

public final CompletableFuture<GetPoliciesResponse> getPolicies()
                                                         throws IOException,
OpenSearchException

Retrieves the policies.

Throws:

IOException

OpenSearchException

getPolicy

public CompletableFuture<GetPolicyResponse> getPolicy(GetPolicyRequest request)
                                               throws IOException,
OpenSearchException

Retrieves a specific policy.

Throws:

IOException

OpenSearchException

getPolicy

public final CompletableFuture<GetPolicyResponse> getPolicy(Function<GetPolicyRequest.Builder,ObjectBuilder<GetPolicyRequest>> fn)
                                                     throws IOException,
OpenSearchException

Retrieves a specific policy.

Parameters:

fn - a function that initializes a builder to create the GetPolicyRequest

Throws:

IOException

OpenSearchException

putPolicies

public CompletableFuture<PutPoliciesResponse> putPolicies(PutPoliciesRequest request)
                                                   throws IOException,
OpenSearchException

Creates or updates policies.

Throws:

IOException

OpenSearchException

putPolicies

public final CompletableFuture<PutPoliciesResponse> putPolicies(Function<PutPoliciesRequest.Builder,ObjectBuilder<PutPoliciesRequest>> fn)
                                                         throws IOException,
OpenSearchException

Creates or updates policies.

Parameters:

fn - a function that initializes a builder to create the PutPoliciesRequest

Throws:

IOException

OpenSearchException

putPolicy

public CompletableFuture<PutPolicyResponse> putPolicy(PutPolicyRequest request)
                                               throws IOException,
OpenSearchException

Creates or updates a policy.

Throws:

IOException

OpenSearchException

putPolicy

public final CompletableFuture<PutPolicyResponse> putPolicy(Function<PutPolicyRequest.Builder,ObjectBuilder<PutPolicyRequest>> fn)
                                                     throws IOException,
OpenSearchException

Creates or updates a policy.

Parameters:

fn - a function that initializes a builder to create the PutPolicyRequest

Throws:

IOException

OpenSearchException

refreshSearchAnalyzers

public CompletableFuture<RefreshSearchAnalyzersResponse> refreshSearchAnalyzers(RefreshSearchAnalyzersRequest request)
                                                                         throws IOException,
OpenSearchException

Refreshes search analyzers in real time.

Throws:

IOException

OpenSearchException

refreshSearchAnalyzers

public final CompletableFuture<RefreshSearchAnalyzersResponse> refreshSearchAnalyzers(Function<RefreshSearchAnalyzersRequest.Builder,ObjectBuilder<RefreshSearchAnalyzersRequest>> fn)
                                                                               throws IOException,
OpenSearchException

Refreshes search analyzers in real time.

Parameters:

fn - a function that initializes a builder to create the RefreshSearchAnalyzersRequest

Throws:

IOException

OpenSearchException

removePolicy

public CompletableFuture<RemovePolicyResponse> removePolicy(RemovePolicyRequest request)
                                                     throws IOException,
OpenSearchException

Removes a policy from an index.

Throws:

IOException

OpenSearchException

removePolicy

public final CompletableFuture<RemovePolicyResponse> removePolicy(Function<RemovePolicyRequest.Builder,ObjectBuilder<RemovePolicyRequest>> fn)
                                                           throws IOException,
OpenSearchException

Removes a policy from an index.

Parameters:

fn - a function that initializes a builder to create the RemovePolicyRequest

Throws:

IOException

OpenSearchException

removePolicy

public final CompletableFuture<RemovePolicyResponse> removePolicy()
                                                           throws IOException,
OpenSearchException

Removes a policy from an index.

Throws:

IOException

OpenSearchException

retryIndex

public CompletableFuture<RetryIndexResponse> retryIndex(RetryIndexRequest request)
                                                 throws IOException,
OpenSearchException

Retries the failed action for an index.

Throws:

IOException

OpenSearchException

retryIndex

public final CompletableFuture<RetryIndexResponse> retryIndex(Function<RetryIndexRequest.Builder,ObjectBuilder<RetryIndexRequest>> fn)
                                                       throws IOException,
OpenSearchException

Retries the failed action for an index.

Parameters:

fn - a function that initializes a builder to create the RetryIndexRequest

Throws:

IOException

OpenSearchException