Package org.opensearch.client.opensearch.search_relevance

Class OpenSearchSearchRelevanceClient

java.lang.Object

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

org.opensearch.client.opensearch.search_relevance.OpenSearchSearchRelevanceClient

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

Client for the search_relevance namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

OpenSearchSearchRelevanceClient

public OpenSearchSearchRelevanceClient(OpenSearchTransport transport)

OpenSearchSearchRelevanceClient

public OpenSearchSearchRelevanceClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchSearchRelevanceClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchSearchRelevanceClient>

deleteExperiments

public DeleteExperimentsResponse deleteExperiments(DeleteExperimentsRequest request)
                                            throws IOException,
OpenSearchException

Deletes a specified experiment.

Throws:

IOException

OpenSearchException

deleteExperiments

public final 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 DeleteJudgmentsResponse deleteJudgments(DeleteJudgmentsRequest request)
                                        throws IOException,
OpenSearchException

Deletes a specified judgment.

Throws:

IOException

OpenSearchException

deleteJudgments

public final 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 DeleteQuerySetsResponse deleteQuerySets(DeleteQuerySetsRequest request)
                                        throws IOException,
OpenSearchException

Deletes a query set.

Throws:

IOException

OpenSearchException

deleteQuerySets

public final 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 DeleteScheduledExperimentsResponse deleteScheduledExperiments(DeleteScheduledExperimentsRequest request)
                                                              throws IOException,
OpenSearchException

Deletes a specified scheduled experiment.

Throws:

IOException

OpenSearchException

deleteScheduledExperiments

public final 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 DeleteSearchConfigurationsResponse deleteSearchConfigurations(DeleteSearchConfigurationsRequest request)
                                                              throws IOException,
OpenSearchException

Deletes a specified search configuration.

Throws:

IOException

OpenSearchException

deleteSearchConfigurations

public final 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>
GetExperimentsResponse<TDocument> getExperiments(GetExperimentsRequest request,
 Class<TDocument> tDocumentClass)
                                          throws IOException,
OpenSearchException

Gets experiments.

Throws:

IOException

OpenSearchException

getExperiments

public final <TDocument>
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> GetJudgmentsResponse<TDocument> getJudgments(GetJudgmentsRequest request,
 Class<TDocument> tDocumentClass)
                                                         throws IOException,
OpenSearchException

Gets judgments.

Throws:

IOException

OpenSearchException

getJudgments

public final <TDocument>
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 GetNodeStatsResponse getNodeStats(GetNodeStatsRequest request)
                                  throws IOException,
OpenSearchException

Gets stats by node.

Throws:

IOException

OpenSearchException

getNodeStats

public final 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> GetQuerySetsResponse<TDocument> getQuerySets(GetQuerySetsRequest request,
 Class<TDocument> tDocumentClass)
                                                         throws IOException,
OpenSearchException

Lists the current query sets available.

Throws:

IOException

OpenSearchException

getQuerySets

public final <TDocument>
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>
GetScheduledExperimentsResponse<TDocument> getScheduledExperiments(GetScheduledExperimentsRequest request,
 Class<TDocument> tDocumentClass)
                                                            throws IOException,
OpenSearchException

Gets the scheduled experiments.

Throws:

IOException

OpenSearchException

getScheduledExperiments

public final <TDocument>
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>
GetSearchConfigurationsResponse<TDocument> getSearchConfigurations(GetSearchConfigurationsRequest request,
 Class<TDocument> tDocumentClass)
                                                            throws IOException,
OpenSearchException

Gets the search configurations.

Throws:

IOException

OpenSearchException

getSearchConfigurations

public final <TDocument>
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 GetStatsResponse getStats(GetStatsRequest request)
                          throws IOException,
OpenSearchException

Gets stats.

Throws:

IOException

OpenSearchException

getStats

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

Gets stats.

Throws:

IOException

OpenSearchException

postQuerySets

public 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 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 PostQuerySetsResponse postQuerySets()
                                          throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

postScheduledExperiments

public PostScheduledExperimentsResponse postScheduledExperiments(PostScheduledExperimentsRequest request)
                                                          throws IOException,
OpenSearchException

Creates a scheduled experiment.

Throws:

IOException

OpenSearchException

postScheduledExperiments

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

Creates a scheduled experiment.

Throws:

IOException

OpenSearchException

putExperiments

public PutExperimentsResponse putExperiments(PutExperimentsRequest request)
                                      throws IOException,
OpenSearchException

Creates an experiment.

Throws:

IOException

OpenSearchException

putExperiments

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

Creates an experiment.

Throws:

IOException

OpenSearchException

putJudgments

public PutJudgmentsResponse putJudgments(PutJudgmentsRequest request)
                                  throws IOException,
OpenSearchException

Creates a judgment.

Throws:

IOException

OpenSearchException

putJudgments

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

Creates a judgment.

Throws:

IOException

OpenSearchException

putQuerySets

public PutQuerySetsResponse putQuerySets(PutQuerySetsRequest request)
                                  throws IOException,
OpenSearchException

Creates a new query set by uploading manually.

Throws:

IOException

OpenSearchException

putQuerySets

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

Creates a new query set by uploading manually.

Throws:

IOException

OpenSearchException

putSearchConfigurations

public PutSearchConfigurationsResponse putSearchConfigurations(PutSearchConfigurationsRequest request)
                                                        throws IOException,
OpenSearchException

Creates a search configuration.

Throws:

IOException

OpenSearchException

putSearchConfigurations

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

Creates a search configuration.

Throws:

IOException

OpenSearchException