Package org.opensearch.client.opensearch.search_relevance

Class OpenSearchSearchRelevanceAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.search_relevance.OpenSearchSearchRelevanceAsyncClient

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

Client for the search_relevance namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<DeleteExperimentsResponse>	deleteExperiments(Function<DeleteExperimentsRequest.Builder,ObjectBuilder<DeleteExperimentsRequest>> fn)	Deletes a specified experiment.
CompletableFuture<DeleteExperimentsResponse>	deleteExperiments(DeleteExperimentsRequest request)	Deletes a specified experiment.
final CompletableFuture<DeleteJudgmentsResponse>	deleteJudgments(Function<DeleteJudgmentsRequest.Builder,ObjectBuilder<DeleteJudgmentsRequest>> fn)	Deletes a specified judgment.
CompletableFuture<DeleteJudgmentsResponse>	deleteJudgments(DeleteJudgmentsRequest request)	Deletes a specified judgment.
final CompletableFuture<DeleteQuerySetsResponse>	deleteQuerySets(Function<DeleteQuerySetsRequest.Builder,ObjectBuilder<DeleteQuerySetsRequest>> fn)	Deletes a query set.
CompletableFuture<DeleteQuerySetsResponse>	deleteQuerySets(DeleteQuerySetsRequest request)	Deletes a query set.
final CompletableFuture<DeleteScheduledExperimentsResponse>	deleteScheduledExperiments(Function<DeleteScheduledExperimentsRequest.Builder,ObjectBuilder<DeleteScheduledExperimentsRequest>> fn)	Deletes a specified scheduled experiment.
CompletableFuture<DeleteScheduledExperimentsResponse>	deleteScheduledExperiments(DeleteScheduledExperimentsRequest request)	Deletes a specified scheduled experiment.
final CompletableFuture<DeleteSearchConfigurationsResponse>	deleteSearchConfigurations(Function<DeleteSearchConfigurationsRequest.Builder,ObjectBuilder<DeleteSearchConfigurationsRequest>> fn)	Deletes a specified search configuration.
CompletableFuture<DeleteSearchConfigurationsResponse>	deleteSearchConfigurations(DeleteSearchConfigurationsRequest request)	Deletes a specified search configuration.
final <TDocument> CompletableFuture<GetExperimentsResponse<TDocument>>	getExperiments(Function<GetExperimentsRequest.Builder,ObjectBuilder<GetExperimentsRequest>> fn, Class<TDocument> tDocumentClass)	Gets experiments.
<TDocument> CompletableFuture<GetExperimentsResponse<TDocument>>	getExperiments(GetExperimentsRequest request, Class<TDocument> tDocumentClass)	Gets experiments.
final <TDocument> CompletableFuture<GetJudgmentsResponse<TDocument>>	getJudgments(Function<GetJudgmentsRequest.Builder,ObjectBuilder<GetJudgmentsRequest>> fn, Class<TDocument> tDocumentClass)	Gets judgments.
<TDocument> CompletableFuture<GetJudgmentsResponse<TDocument>>	getJudgments(GetJudgmentsRequest request, Class<TDocument> tDocumentClass)	Gets judgments.
final CompletableFuture<GetNodeStatsResponse>	getNodeStats(Function<GetNodeStatsRequest.Builder,ObjectBuilder<GetNodeStatsRequest>> fn)	Gets stats by node.
CompletableFuture<GetNodeStatsResponse>	getNodeStats(GetNodeStatsRequest request)	Gets stats by node.
final <TDocument> CompletableFuture<GetQuerySetsResponse<TDocument>>	getQuerySets(Function<GetQuerySetsRequest.Builder,ObjectBuilder<GetQuerySetsRequest>> fn, Class<TDocument> tDocumentClass)	Lists the current query sets available.
<TDocument> CompletableFuture<GetQuerySetsResponse<TDocument>>	getQuerySets(GetQuerySetsRequest request, Class<TDocument> tDocumentClass)	Lists the current query sets available.
final <TDocument> CompletableFuture<GetScheduledExperimentsResponse<TDocument>>	getScheduledExperiments(Function<GetScheduledExperimentsRequest.Builder,ObjectBuilder<GetScheduledExperimentsRequest>> fn, Class<TDocument> tDocumentClass)	Gets the scheduled experiments.
<TDocument> CompletableFuture<GetScheduledExperimentsResponse<TDocument>>	getScheduledExperiments(GetScheduledExperimentsRequest request, Class<TDocument> tDocumentClass)	Gets the scheduled experiments.
final <TDocument> CompletableFuture<GetSearchConfigurationsResponse<TDocument>>	getSearchConfigurations(Function<GetSearchConfigurationsRequest.Builder,ObjectBuilder<GetSearchConfigurationsRequest>> fn, Class<TDocument> tDocumentClass)	Gets the search configurations.
<TDocument> CompletableFuture<GetSearchConfigurationsResponse<TDocument>>	getSearchConfigurations(GetSearchConfigurationsRequest request, Class<TDocument> tDocumentClass)	Gets the search configurations.
final CompletableFuture<GetStatsResponse>	getStats()	Gets stats.
final CompletableFuture<GetStatsResponse>	getStats(Function<GetStatsRequest.Builder,ObjectBuilder<GetStatsRequest>> fn)	Gets stats.
CompletableFuture<GetStatsResponse>	getStats(GetStatsRequest request)	Gets stats.
final CompletableFuture<PostQuerySetsResponse>	postQuerySets()	Creates a new query set by sampling queries from the user behavior data.
final CompletableFuture<PostQuerySetsResponse>	postQuerySets(Function<PostQuerySetsRequest.Builder,ObjectBuilder<PostQuerySetsRequest>> fn)	Creates a new query set by sampling queries from the user behavior data.
CompletableFuture<PostQuerySetsResponse>	postQuerySets(PostQuerySetsRequest request)	Creates a new query set by sampling queries from the user behavior data.
final CompletableFuture<PostScheduledExperimentsResponse>	postScheduledExperiments()	Creates a scheduled experiment.
final CompletableFuture<PostScheduledExperimentsResponse>	postScheduledExperiments(Function<PostScheduledExperimentsRequest.Builder,ObjectBuilder<PostScheduledExperimentsRequest>> fn)	Creates a scheduled experiment.
CompletableFuture<PostScheduledExperimentsResponse>	postScheduledExperiments(PostScheduledExperimentsRequest request)	Creates a scheduled experiment.
final CompletableFuture<PutExperimentsResponse>	putExperiments()	Creates an experiment.
final CompletableFuture<PutExperimentsResponse>	putExperiments(Function<PutExperimentsRequest.Builder,ObjectBuilder<PutExperimentsRequest>> fn)	Creates an experiment.
CompletableFuture<PutExperimentsResponse>	putExperiments(PutExperimentsRequest request)	Creates an experiment.
final CompletableFuture<PutJudgmentsResponse>	putJudgments()	Creates a judgment.
final CompletableFuture<PutJudgmentsResponse>	putJudgments(Function<PutJudgmentsRequest.Builder,ObjectBuilder<PutJudgmentsRequest>> fn)	Creates a judgment.
CompletableFuture<PutJudgmentsResponse>	putJudgments(PutJudgmentsRequest request)	Creates a judgment.
final CompletableFuture<PutQuerySetsResponse>	putQuerySets()	Creates a new query set by uploading manually.
final CompletableFuture<PutQuerySetsResponse>	putQuerySets(Function<PutQuerySetsRequest.Builder,ObjectBuilder<PutQuerySetsRequest>> fn)	Creates a new query set by uploading manually.
CompletableFuture<PutQuerySetsResponse>	putQuerySets(PutQuerySetsRequest request)	Creates a new query set by uploading manually.
final CompletableFuture<PutSearchConfigurationsResponse>	putSearchConfigurations()	Creates a search configuration.
final CompletableFuture<PutSearchConfigurationsResponse>	putSearchConfigurations(Function<PutSearchConfigurationsRequest.Builder,ObjectBuilder<PutSearchConfigurationsRequest>> fn)	Creates a search configuration.
CompletableFuture<PutSearchConfigurationsResponse>	putSearchConfigurations(PutSearchConfigurationsRequest request)	Creates a search configuration.
OpenSearchSearchRelevanceAsyncClient	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

OpenSearchSearchRelevanceAsyncClient

public OpenSearchSearchRelevanceAsyncClient(OpenSearchTransport transport)

OpenSearchSearchRelevanceAsyncClient

public OpenSearchSearchRelevanceAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchSearchRelevanceAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchSearchRelevanceAsyncClient>

deleteExperiments

public CompletableFuture<DeleteExperimentsResponse> deleteExperiments(DeleteExperimentsRequest request)
                                                               throws IOException,
OpenSearchException

Deletes a specified experiment.

Throws:

IOException

OpenSearchException

deleteExperiments

public final CompletableFuture<DeleteExperimentsResponse> deleteExperiments(Function<DeleteExperimentsRequest.Builder,ObjectBuilder<DeleteExperimentsRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Deletes a specified experiment.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteJudgments

public CompletableFuture<DeleteJudgmentsResponse> deleteJudgments(DeleteJudgmentsRequest request)
                                                           throws IOException,
OpenSearchException

Deletes a specified judgment.

Throws:

IOException

OpenSearchException

deleteJudgments

public final CompletableFuture<DeleteJudgmentsResponse> deleteJudgments(Function<DeleteJudgmentsRequest.Builder,ObjectBuilder<DeleteJudgmentsRequest>> fn)
                                                                 throws IOException,
OpenSearchException

Deletes a specified judgment.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteQuerySets

public CompletableFuture<DeleteQuerySetsResponse> deleteQuerySets(DeleteQuerySetsRequest request)
                                                           throws IOException,
OpenSearchException

Deletes a query set.

Throws:

IOException

OpenSearchException

deleteQuerySets

public final CompletableFuture<DeleteQuerySetsResponse> deleteQuerySets(Function<DeleteQuerySetsRequest.Builder,ObjectBuilder<DeleteQuerySetsRequest>> fn)
                                                                 throws IOException,
OpenSearchException

Deletes a query set.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteScheduledExperiments

public CompletableFuture<DeleteScheduledExperimentsResponse> deleteScheduledExperiments(DeleteScheduledExperimentsRequest request)
                                                                                 throws IOException,
OpenSearchException

Deletes a specified scheduled experiment.

Throws:

IOException

OpenSearchException

deleteScheduledExperiments

public final CompletableFuture<DeleteScheduledExperimentsResponse> deleteScheduledExperiments(Function<DeleteScheduledExperimentsRequest.Builder,ObjectBuilder<DeleteScheduledExperimentsRequest>> fn)
                                                                                       throws IOException,
OpenSearchException

Deletes a specified scheduled experiment.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteSearchConfigurations

public CompletableFuture<DeleteSearchConfigurationsResponse> deleteSearchConfigurations(DeleteSearchConfigurationsRequest request)
                                                                                 throws IOException,
OpenSearchException

Deletes a specified search configuration.

Throws:

IOException

OpenSearchException

deleteSearchConfigurations

public final CompletableFuture<DeleteSearchConfigurationsResponse> deleteSearchConfigurations(Function<DeleteSearchConfigurationsRequest.Builder,ObjectBuilder<DeleteSearchConfigurationsRequest>> fn)
                                                                                       throws IOException,
OpenSearchException

Deletes a specified search configuration.

Parameters:

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

Throws:

IOException

OpenSearchException

getExperiments

public <TDocument>
CompletableFuture<GetExperimentsResponse<TDocument>> getExperiments(GetExperimentsRequest request,
 Class<TDocument> tDocumentClass)
                                                             throws IOException,
OpenSearchException

Gets experiments.

Throws:

IOException

OpenSearchException

getExperiments

public final <TDocument>
CompletableFuture<GetExperimentsResponse<TDocument>> getExperiments(Function<GetExperimentsRequest.Builder,ObjectBuilder<GetExperimentsRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                             throws IOException,
OpenSearchException

Gets experiments.

Parameters:

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

Throws:

IOException

OpenSearchException

getJudgments

public <TDocument>
CompletableFuture<GetJudgmentsResponse<TDocument>> getJudgments(GetJudgmentsRequest request,
 Class<TDocument> tDocumentClass)
                                                         throws IOException,
OpenSearchException

Gets judgments.

Throws:

IOException

OpenSearchException

getJudgments

public final <TDocument>
CompletableFuture<GetJudgmentsResponse<TDocument>> getJudgments(Function<GetJudgmentsRequest.Builder,ObjectBuilder<GetJudgmentsRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                         throws IOException,
OpenSearchException

Gets judgments.

Parameters:

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

Throws:

IOException

OpenSearchException

getNodeStats

public CompletableFuture<GetNodeStatsResponse> getNodeStats(GetNodeStatsRequest request)
                                                     throws IOException,
OpenSearchException

Gets stats by node.

Throws:

IOException

OpenSearchException

getNodeStats

public final CompletableFuture<GetNodeStatsResponse> getNodeStats(Function<GetNodeStatsRequest.Builder,ObjectBuilder<GetNodeStatsRequest>> fn)
                                                           throws IOException,
OpenSearchException

Gets stats by node.

Parameters:

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

Throws:

IOException

OpenSearchException

getQuerySets

public <TDocument>
CompletableFuture<GetQuerySetsResponse<TDocument>> getQuerySets(GetQuerySetsRequest request,
 Class<TDocument> tDocumentClass)
                                                         throws IOException,
OpenSearchException

Lists the current query sets available.

Throws:

IOException

OpenSearchException

getQuerySets

public final <TDocument>
CompletableFuture<GetQuerySetsResponse<TDocument>> getQuerySets(Function<GetQuerySetsRequest.Builder,ObjectBuilder<GetQuerySetsRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                         throws IOException,
OpenSearchException

Lists the current query sets available.

Parameters:

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

Throws:

IOException

OpenSearchException

getScheduledExperiments

public <TDocument>
CompletableFuture<GetScheduledExperimentsResponse<TDocument>> getScheduledExperiments(GetScheduledExperimentsRequest request,
 Class<TDocument> tDocumentClass)
                                                                               throws IOException,
OpenSearchException

Gets the scheduled experiments.

Throws:

IOException

OpenSearchException

getScheduledExperiments

public final <TDocument>
CompletableFuture<GetScheduledExperimentsResponse<TDocument>> getScheduledExperiments(Function<GetScheduledExperimentsRequest.Builder,ObjectBuilder<GetScheduledExperimentsRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                                               throws IOException,
OpenSearchException

Gets the scheduled experiments.

Parameters:

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

Throws:

IOException

OpenSearchException

getSearchConfigurations

public <TDocument>
CompletableFuture<GetSearchConfigurationsResponse<TDocument>> getSearchConfigurations(GetSearchConfigurationsRequest request,
 Class<TDocument> tDocumentClass)
                                                                               throws IOException,
OpenSearchException

Gets the search configurations.

Throws:

IOException

OpenSearchException

getSearchConfigurations

public final <TDocument>
CompletableFuture<GetSearchConfigurationsResponse<TDocument>> getSearchConfigurations(Function<GetSearchConfigurationsRequest.Builder,ObjectBuilder<GetSearchConfigurationsRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                                               throws IOException,
OpenSearchException

Gets the search configurations.

Parameters:

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

Throws:

IOException

OpenSearchException

getStats

public CompletableFuture<GetStatsResponse> getStats(GetStatsRequest request)
                                             throws IOException,
OpenSearchException

Gets stats.

Throws:

IOException

OpenSearchException

getStats

public final CompletableFuture<GetStatsResponse> getStats(Function<GetStatsRequest.Builder,ObjectBuilder<GetStatsRequest>> fn)
                                                   throws IOException,
OpenSearchException

Gets stats.

Parameters:

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

Throws:

IOException

OpenSearchException

getStats

public final CompletableFuture<GetStatsResponse> getStats()
                                                   throws IOException,
OpenSearchException

Gets stats.

Throws:

IOException

OpenSearchException

postQuerySets

public CompletableFuture<PostQuerySetsResponse> postQuerySets(PostQuerySetsRequest request)
                                                       throws IOException,
OpenSearchException

Creates a new query set by sampling queries from the user behavior data.

Throws:

IOException

OpenSearchException

postQuerySets

public final CompletableFuture<PostQuerySetsResponse> postQuerySets(Function<PostQuerySetsRequest.Builder,ObjectBuilder<PostQuerySetsRequest>> fn)
                                                             throws IOException,
OpenSearchException

Creates a new query set by sampling queries from the user behavior data.

Parameters:

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

Throws:

IOException

OpenSearchException

postQuerySets

public final CompletableFuture<PostQuerySetsResponse> postQuerySets()
                                                             throws IOException,
OpenSearchException

Creates a new query set by sampling queries from the user behavior data.

Throws:

IOException

OpenSearchException

postScheduledExperiments

public CompletableFuture<PostScheduledExperimentsResponse> postScheduledExperiments(PostScheduledExperimentsRequest request)
                                                                             throws IOException,
OpenSearchException

Creates a scheduled experiment.

Throws:

IOException

OpenSearchException

postScheduledExperiments

public final CompletableFuture<PostScheduledExperimentsResponse> postScheduledExperiments(Function<PostScheduledExperimentsRequest.Builder,ObjectBuilder<PostScheduledExperimentsRequest>> fn)
                                                                                   throws IOException,
OpenSearchException

Creates a scheduled experiment.

Parameters:

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

Throws:

IOException

OpenSearchException

postScheduledExperiments

public final CompletableFuture<PostScheduledExperimentsResponse> postScheduledExperiments()
                                                                                   throws IOException,
OpenSearchException

Creates a scheduled experiment.

Throws:

IOException

OpenSearchException

putExperiments

public CompletableFuture<PutExperimentsResponse> putExperiments(PutExperimentsRequest request)
                                                         throws IOException,
OpenSearchException

Creates an experiment.

Throws:

IOException

OpenSearchException

putExperiments

public final CompletableFuture<PutExperimentsResponse> putExperiments(Function<PutExperimentsRequest.Builder,ObjectBuilder<PutExperimentsRequest>> fn)
                                                               throws IOException,
OpenSearchException

Creates an experiment.

Parameters:

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

Throws:

IOException

OpenSearchException

putExperiments

public final CompletableFuture<PutExperimentsResponse> putExperiments()
                                                               throws IOException,
OpenSearchException

Creates an experiment.

Throws:

IOException

OpenSearchException

putJudgments

public CompletableFuture<PutJudgmentsResponse> putJudgments(PutJudgmentsRequest request)
                                                     throws IOException,
OpenSearchException

Creates a judgment.

Throws:

IOException

OpenSearchException

putJudgments

public final CompletableFuture<PutJudgmentsResponse> putJudgments(Function<PutJudgmentsRequest.Builder,ObjectBuilder<PutJudgmentsRequest>> fn)
                                                           throws IOException,
OpenSearchException

Creates a judgment.

Parameters:

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

Throws:

IOException

OpenSearchException

putJudgments

public final CompletableFuture<PutJudgmentsResponse> putJudgments()
                                                           throws IOException,
OpenSearchException

Creates a judgment.

Throws:

IOException

OpenSearchException

putQuerySets

public CompletableFuture<PutQuerySetsResponse> putQuerySets(PutQuerySetsRequest request)
                                                     throws IOException,
OpenSearchException

Creates a new query set by uploading manually.

Throws:

IOException

OpenSearchException

putQuerySets

public final CompletableFuture<PutQuerySetsResponse> putQuerySets(Function<PutQuerySetsRequest.Builder,ObjectBuilder<PutQuerySetsRequest>> fn)
                                                           throws IOException,
OpenSearchException

Creates a new query set by uploading manually.

Parameters:

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

Throws:

IOException

OpenSearchException

putQuerySets

public final CompletableFuture<PutQuerySetsResponse> putQuerySets()
                                                           throws IOException,
OpenSearchException

Creates a new query set by uploading manually.

Throws:

IOException

OpenSearchException

putSearchConfigurations

public CompletableFuture<PutSearchConfigurationsResponse> putSearchConfigurations(PutSearchConfigurationsRequest request)
                                                                           throws IOException,
OpenSearchException

Creates a search configuration.

Throws:

IOException

OpenSearchException

putSearchConfigurations

public final CompletableFuture<PutSearchConfigurationsResponse> putSearchConfigurations(Function<PutSearchConfigurationsRequest.Builder,ObjectBuilder<PutSearchConfigurationsRequest>> fn)
                                                                                 throws IOException,
OpenSearchException

Creates a search configuration.

Parameters:

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

Throws:

IOException

OpenSearchException

putSearchConfigurations

public final CompletableFuture<PutSearchConfigurationsResponse> putSearchConfigurations()
                                                                                 throws IOException,
OpenSearchException

Creates a search configuration.

Throws:

IOException

OpenSearchException