Package org.opensearch.client.opensearch.ism

Class OpenSearchIsmClient

java.lang.Object

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

org.opensearch.client.opensearch.ism.OpenSearchIsmClient

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

Client for the ism namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

OpenSearchIsmClient

public OpenSearchIsmClient(OpenSearchTransport transport)

OpenSearchIsmClient

public OpenSearchIsmClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchIsmClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchIsmClient>

addPolicy

public AddPolicyResponse addPolicy(AddPolicyRequest request)
                            throws IOException,
OpenSearchException

Adds a policy to an index.

Throws:

IOException

OpenSearchException

addPolicy

public final 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 ChangePolicyResponse changePolicy(ChangePolicyRequest request)
                                  throws IOException,
OpenSearchException

Updates the managed index policy to a new policy.

Throws:

IOException

OpenSearchException

changePolicy

public final 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 DeletePolicyResponse deletePolicy(DeletePolicyRequest request)
                                  throws IOException,
OpenSearchException

Deletes a policy.

Throws:

IOException

OpenSearchException

deletePolicy

public final 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 ExistsPolicyResponse existsPolicy(ExistsPolicyRequest request)
                                  throws IOException,
OpenSearchException

Checks for the existence of a policy.

Throws:

IOException

OpenSearchException

existsPolicy

public final 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 ExplainPolicyResponse explainPolicy(ExplainPolicyRequest request)
                                    throws IOException,
OpenSearchException

Retrieves the currently applied policy on the specified indexes.

Throws:

IOException

OpenSearchException

explainPolicy

public final 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 GetPoliciesResponse getPolicies(GetPoliciesRequest request)
                                throws IOException,
OpenSearchException

Retrieves the policies.

Throws:

IOException

OpenSearchException

getPolicies

public final 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 GetPoliciesResponse getPolicies()
                                      throws IOException,
OpenSearchException

Retrieves the policies.

Throws:

IOException

OpenSearchException

getPolicy

public GetPolicyResponse getPolicy(GetPolicyRequest request)
                            throws IOException,
OpenSearchException

Retrieves a specific policy.

Throws:

IOException

OpenSearchException

getPolicy

public final 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 PutPoliciesResponse putPolicies(PutPoliciesRequest request)
                                throws IOException,
OpenSearchException

Creates or updates policies.

Throws:

IOException

OpenSearchException

putPolicies

public final 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 PutPolicyResponse putPolicy(PutPolicyRequest request)
                            throws IOException,
OpenSearchException

Creates or updates a policy.

Throws:

IOException

OpenSearchException

putPolicy

public final 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 RefreshSearchAnalyzersResponse refreshSearchAnalyzers(RefreshSearchAnalyzersRequest request)
                                                      throws IOException,
OpenSearchException

Refreshes search analyzers in real time.

Throws:

IOException

OpenSearchException

refreshSearchAnalyzers

public final 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 RemovePolicyResponse removePolicy(RemovePolicyRequest request)
                                  throws IOException,
OpenSearchException

Removes a policy from an index.

Throws:

IOException

OpenSearchException

removePolicy

public final 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 RemovePolicyResponse removePolicy()
                                        throws IOException,
OpenSearchException

Removes a policy from an index.

Throws:

IOException

OpenSearchException

retryIndex

public RetryIndexResponse retryIndex(RetryIndexRequest request)
                              throws IOException,
OpenSearchException

Retries the failed action for an index.

Throws:

IOException

OpenSearchException

retryIndex

public final 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