Package org.opensearch.client.opensearch

Class OpenSearchAsyncClientBase<Self extends OpenSearchAsyncClientBase<Self>>

java.lang.Object

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

org.opensearch.client.opensearch.OpenSearchAsyncClientBase<Self>

Direct Known Subclasses:

OpenSearchAsyncClient

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

Client for the namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchAsyncClientBase(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
OpenSearchCatAsyncClient	cat()
final CompletableFuture<ClearScrollResponse>	clearScroll()	Explicitly clears the search context for a scroll.
final CompletableFuture<ClearScrollResponse>	clearScroll(Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)	Explicitly clears the search context for a scroll.
CompletableFuture<ClearScrollResponse>	clearScroll(ClearScrollRequest request)	Explicitly clears the search context for a scroll.
OpenSearchClusterAsyncClient	cluster()
final CompletableFuture<CountResponse>	count()	Returns number of documents matching a query.
final CompletableFuture<CountResponse>	count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Returns number of documents matching a query.
CompletableFuture<CountResponse>	count(CountRequest request)	Returns number of documents matching a query.
final CompletableFuture<CreatePitResponse>	createPit(Function<CreatePitRequest.Builder,ObjectBuilder<CreatePitRequest>> fn)	Creates point in time context.
CompletableFuture<CreatePitResponse>	createPit(CreatePitRequest request)	Creates point in time context.
OpenSearchDanglingIndicesAsyncClient	danglingIndices()
final CompletableFuture<DeleteResponse>	delete(Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)	Removes a document from the index.
CompletableFuture<DeleteResponse>	delete(DeleteRequest request)	Removes a document from the index.
final CompletableFuture<DeleteAllPitsResponse>	deleteAllPits()	Deletes all active point in time searches.
final CompletableFuture<DeleteAllPitsResponse>	deleteAllPits(Function<DeleteAllPitsRequest.Builder,ObjectBuilder<DeleteAllPitsRequest>> fn)	Deletes all active point in time searches.
CompletableFuture<DeleteAllPitsResponse>	deleteAllPits(DeleteAllPitsRequest request)	Deletes all active point in time searches.
final CompletableFuture<DeleteByQueryResponse>	deleteByQuery(Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)	Deletes documents matching the provided query.
CompletableFuture<DeleteByQueryResponse>	deleteByQuery(DeleteByQueryRequest request)	Deletes documents matching the provided query.
final CompletableFuture<DeleteByQueryRethrottleResponse>	deleteByQueryRethrottle(Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn)	Changes the number of requests per second for a particular Delete By Query operation.
CompletableFuture<DeleteByQueryRethrottleResponse>	deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)	Changes the number of requests per second for a particular Delete By Query operation.
final CompletableFuture<DeletePitResponse>	deletePit(Function<DeletePitRequest.Builder,ObjectBuilder<DeletePitRequest>> fn)	Deletes one or more point in time searches based on the IDs passed.
CompletableFuture<DeletePitResponse>	deletePit(DeletePitRequest request)	Deletes one or more point in time searches based on the IDs passed.
final CompletableFuture<DeleteScriptResponse>	deleteScript(Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)	Deletes a script.
CompletableFuture<DeleteScriptResponse>	deleteScript(DeleteScriptRequest request)	Deletes a script.
final CompletableFuture<BooleanResponse>	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Returns information about whether a document exists in an index.
CompletableFuture<BooleanResponse>	exists(ExistsRequest request)	Returns information about whether a document exists in an index.
final CompletableFuture<BooleanResponse>	existsSource(Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)	Returns information about whether a document source exists in an index.
CompletableFuture<BooleanResponse>	existsSource(ExistsSourceRequest request)	Returns information about whether a document source exists in an index.
final CompletableFuture<FieldCapsResponse>	fieldCaps()	Returns the information about the capabilities of fields among multiple indexes.
final CompletableFuture<FieldCapsResponse>	fieldCaps(Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)	Returns the information about the capabilities of fields among multiple indexes.
CompletableFuture<FieldCapsResponse>	fieldCaps(FieldCapsRequest request)	Returns the information about the capabilities of fields among multiple indexes.
final CompletableFuture<GetAllPitsResponse>	getAllPits()	Lists all active point in time searches.
final CompletableFuture<GetAllPitsResponse>	getAllPits(Function<GetAllPitsRequest.Builder,ObjectBuilder<GetAllPitsRequest>> fn)	Lists all active point in time searches.
CompletableFuture<GetAllPitsResponse>	getAllPits(GetAllPitsRequest request)	Lists all active point in time searches.
final CompletableFuture<GetScriptResponse>	getScript(Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)	Returns a script.
CompletableFuture<GetScriptResponse>	getScript(GetScriptRequest request)	Returns a script.
final CompletableFuture<GetScriptContextResponse>	getScriptContext()	Returns all script contexts.
final CompletableFuture<GetScriptContextResponse>	getScriptContext(Function<GetScriptContextRequest.Builder,ObjectBuilder<GetScriptContextRequest>> fn)	Returns all script contexts.
CompletableFuture<GetScriptContextResponse>	getScriptContext(GetScriptContextRequest request)	Returns all script contexts.
final CompletableFuture<GetScriptLanguagesResponse>	getScriptLanguages()	Returns available script types, languages and contexts.
final CompletableFuture<GetScriptLanguagesResponse>	getScriptLanguages(Function<GetScriptLanguagesRequest.Builder,ObjectBuilder<GetScriptLanguagesRequest>> fn)	Returns available script types, languages and contexts.
CompletableFuture<GetScriptLanguagesResponse>	getScriptLanguages(GetScriptLanguagesRequest request)	Returns available script types, languages and contexts.
OpenSearchIndicesAsyncClient	indices()
final CompletableFuture<InfoResponse>	info()	Returns basic information about the cluster.
final CompletableFuture<InfoResponse>	info(Function<InfoRequest.Builder,ObjectBuilder<InfoRequest>> fn)	Returns basic information about the cluster.
CompletableFuture<InfoResponse>	info(InfoRequest request)	Returns basic information about the cluster.
OpenSearchIngestAsyncClient	ingest()
OpenSearchMlAsyncClient	ml()
final CompletableFuture<MtermvectorsResponse>	mtermvectors()	Returns multiple termvectors in one request.
final CompletableFuture<MtermvectorsResponse>	mtermvectors(Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)	Returns multiple termvectors in one request.
CompletableFuture<MtermvectorsResponse>	mtermvectors(MtermvectorsRequest request)	Returns multiple termvectors in one request.
OpenSearchNodesAsyncClient	nodes()
final CompletableFuture<BooleanResponse>	ping()	Returns whether the cluster is running.
final CompletableFuture<BooleanResponse>	ping(Function<PingRequest.Builder,ObjectBuilder<PingRequest>> fn)	Returns whether the cluster is running.
CompletableFuture<BooleanResponse>	ping(PingRequest request)	Returns whether the cluster is running.
final CompletableFuture<PutScriptResponse>	putScript(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)	Creates or updates a script.
CompletableFuture<PutScriptResponse>	putScript(PutScriptRequest request)	Creates or updates a script.
final CompletableFuture<RankEvalResponse>	rankEval(Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)	Allows to evaluate the quality of ranked search results over a set of typical search queries.
CompletableFuture<RankEvalResponse>	rankEval(RankEvalRequest request)	Allows to evaluate the quality of ranked search results over a set of typical search queries.
final CompletableFuture<ReindexResponse>	reindex(Function<ReindexRequest.Builder,ObjectBuilder<ReindexRequest>> fn)	Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
CompletableFuture<ReindexResponse>	reindex(ReindexRequest request)	Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
final CompletableFuture<ReindexRethrottleResponse>	reindexRethrottle(Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)	Changes the number of requests per second for a particular reindex operation.
CompletableFuture<ReindexRethrottleResponse>	reindexRethrottle(ReindexRethrottleRequest request)	Changes the number of requests per second for a particular reindex operation.
final CompletableFuture<RenderSearchTemplateResponse>	renderSearchTemplate()	Allows to use the Mustache language to pre-render a search definition.
final CompletableFuture<RenderSearchTemplateResponse>	renderSearchTemplate(Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)	Allows to use the Mustache language to pre-render a search definition.
CompletableFuture<RenderSearchTemplateResponse>	renderSearchTemplate(RenderSearchTemplateRequest request)	Allows to use the Mustache language to pre-render a search definition.
OpenSearchSearchPipelineAsyncClient	searchPipeline()
final CompletableFuture<SearchShardsResponse>	searchShards()	Returns information about the indexes and shards that a search request would be executed against.
final CompletableFuture<SearchShardsResponse>	searchShards(Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)	Returns information about the indexes and shards that a search request would be executed against.
CompletableFuture<SearchShardsResponse>	searchShards(SearchShardsRequest request)	Returns information about the indexes and shards that a search request would be executed against.
OpenSearchSnapshotAsyncClient	snapshot()
OpenSearchTasksAsyncClient	tasks()
final CompletableFuture<UpdateByQueryResponse>	updateByQuery(Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn)	Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
CompletableFuture<UpdateByQueryResponse>	updateByQuery(UpdateByQueryRequest request)	Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
final CompletableFuture<UpdateByQueryRethrottleResponse>	updateByQueryRethrottle(Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)	Changes the number of requests per second for a particular Update By Query operation.
CompletableFuture<UpdateByQueryRethrottleResponse>	updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)	Changes the number of requests per second for a particular Update By Query operation.

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchAsyncClientBase

public OpenSearchAsyncClientBase(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

cat

public OpenSearchCatAsyncClient cat()

cluster

public OpenSearchClusterAsyncClient cluster()

danglingIndices

public OpenSearchDanglingIndicesAsyncClient danglingIndices()

indices

public OpenSearchIndicesAsyncClient indices()

ingest

public OpenSearchIngestAsyncClient ingest()

ml

public OpenSearchMlAsyncClient ml()

nodes

public OpenSearchNodesAsyncClient nodes()

searchPipeline

public OpenSearchSearchPipelineAsyncClient searchPipeline()

snapshot

public OpenSearchSnapshotAsyncClient snapshot()

tasks

public OpenSearchTasksAsyncClient tasks()

clearScroll

public CompletableFuture<ClearScrollResponse> clearScroll(ClearScrollRequest request)
                                                   throws IOException,
OpenSearchException

Explicitly clears the search context for a scroll.

Throws:

IOException

OpenSearchException

clearScroll

public final CompletableFuture<ClearScrollResponse> clearScroll(Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)
                                                         throws IOException,
OpenSearchException

Explicitly clears the search context for a scroll.

Parameters:

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

Throws:

IOException

OpenSearchException

clearScroll

public final CompletableFuture<ClearScrollResponse> clearScroll()
                                                         throws IOException,
OpenSearchException

Explicitly clears the search context for a scroll.

Throws:

IOException

OpenSearchException

count

public CompletableFuture<CountResponse> count(CountRequest request)
                                       throws IOException,
OpenSearchException

Returns number of documents matching a query.

Throws:

IOException

OpenSearchException

count

public final CompletableFuture<CountResponse> count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)
                                             throws IOException,
OpenSearchException

Returns number of documents matching a query.

Parameters:

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

Throws:

IOException

OpenSearchException

count

public final CompletableFuture<CountResponse> count()
                                             throws IOException,
OpenSearchException

Returns number of documents matching a query.

Throws:

IOException

OpenSearchException

createPit

public CompletableFuture<CreatePitResponse> createPit(CreatePitRequest request)
                                               throws IOException,
OpenSearchException

Creates point in time context.

Throws:

IOException

OpenSearchException

createPit

public final CompletableFuture<CreatePitResponse> createPit(Function<CreatePitRequest.Builder,ObjectBuilder<CreatePitRequest>> fn)
                                                     throws IOException,
OpenSearchException

Creates point in time context.

Parameters:

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

Throws:

IOException

OpenSearchException

delete

public CompletableFuture<DeleteResponse> delete(DeleteRequest request)
                                         throws IOException,
OpenSearchException

Removes a document from the index.

Throws:

IOException

OpenSearchException

delete

public final CompletableFuture<DeleteResponse> delete(Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)
                                               throws IOException,
OpenSearchException

Removes a document from the index.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteAllPits

public CompletableFuture<DeleteAllPitsResponse> deleteAllPits(DeleteAllPitsRequest request)
                                                       throws IOException,
OpenSearchException

Deletes all active point in time searches.

Throws:

IOException

OpenSearchException

deleteAllPits

public final CompletableFuture<DeleteAllPitsResponse> deleteAllPits(Function<DeleteAllPitsRequest.Builder,ObjectBuilder<DeleteAllPitsRequest>> fn)
                                                             throws IOException,
OpenSearchException

Deletes all active point in time searches.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteAllPits

public final CompletableFuture<DeleteAllPitsResponse> deleteAllPits()
                                                             throws IOException,
OpenSearchException

Deletes all active point in time searches.

Throws:

IOException

OpenSearchException

deleteByQuery

public CompletableFuture<DeleteByQueryResponse> deleteByQuery(DeleteByQueryRequest request)
                                                       throws IOException,
OpenSearchException

Deletes documents matching the provided query.

Throws:

IOException

OpenSearchException

deleteByQuery

public final CompletableFuture<DeleteByQueryResponse> deleteByQuery(Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)
                                                             throws IOException,
OpenSearchException

Deletes documents matching the provided query.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteByQueryRethrottle

public CompletableFuture<DeleteByQueryRethrottleResponse> deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)
                                                                           throws IOException,
OpenSearchException

Changes the number of requests per second for a particular Delete By Query operation.

Throws:

IOException

OpenSearchException

deleteByQueryRethrottle

public final CompletableFuture<DeleteByQueryRethrottleResponse> deleteByQueryRethrottle(Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn)
                                                                                 throws IOException,
OpenSearchException

Changes the number of requests per second for a particular Delete By Query operation.

Parameters:

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

Throws:

IOException

OpenSearchException

deletePit

public CompletableFuture<DeletePitResponse> deletePit(DeletePitRequest request)
                                               throws IOException,
OpenSearchException

Deletes one or more point in time searches based on the IDs passed.

Throws:

IOException

OpenSearchException

deletePit

public final CompletableFuture<DeletePitResponse> deletePit(Function<DeletePitRequest.Builder,ObjectBuilder<DeletePitRequest>> fn)
                                                     throws IOException,
OpenSearchException

Deletes one or more point in time searches based on the IDs passed.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteScript

public CompletableFuture<DeleteScriptResponse> deleteScript(DeleteScriptRequest request)
                                                     throws IOException,
OpenSearchException

Deletes a script.

Throws:

IOException

OpenSearchException

deleteScript

public final CompletableFuture<DeleteScriptResponse> deleteScript(Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)
                                                           throws IOException,
OpenSearchException

Deletes a script.

Parameters:

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

Throws:

IOException

OpenSearchException

exists

public CompletableFuture<BooleanResponse> exists(ExistsRequest request)
                                          throws IOException,
OpenSearchException

Returns information about whether a document exists in an index.

Throws:

IOException

OpenSearchException

exists

public final CompletableFuture<BooleanResponse> exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)
                                                throws IOException,
OpenSearchException

Returns information about whether a document exists in an index.

Parameters:

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

Throws:

IOException

OpenSearchException

existsSource

public CompletableFuture<BooleanResponse> existsSource(ExistsSourceRequest request)
                                                throws IOException,
OpenSearchException

Returns information about whether a document source exists in an index.

Throws:

IOException

OpenSearchException

existsSource

public final CompletableFuture<BooleanResponse> existsSource(Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)
                                                      throws IOException,
OpenSearchException

Returns information about whether a document source exists in an index.

Parameters:

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

Throws:

IOException

OpenSearchException

fieldCaps

public CompletableFuture<FieldCapsResponse> fieldCaps(FieldCapsRequest request)
                                               throws IOException,
OpenSearchException

Returns the information about the capabilities of fields among multiple indexes.

Throws:

IOException

OpenSearchException

fieldCaps

public final CompletableFuture<FieldCapsResponse> fieldCaps(Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)
                                                     throws IOException,
OpenSearchException

Returns the information about the capabilities of fields among multiple indexes.

Parameters:

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

Throws:

IOException

OpenSearchException

fieldCaps

public final CompletableFuture<FieldCapsResponse> fieldCaps()
                                                     throws IOException,
OpenSearchException

Returns the information about the capabilities of fields among multiple indexes.

Throws:

IOException

OpenSearchException

getAllPits

public CompletableFuture<GetAllPitsResponse> getAllPits(GetAllPitsRequest request)
                                                 throws IOException,
OpenSearchException

Lists all active point in time searches.

Throws:

IOException

OpenSearchException

getAllPits

public final CompletableFuture<GetAllPitsResponse> getAllPits(Function<GetAllPitsRequest.Builder,ObjectBuilder<GetAllPitsRequest>> fn)
                                                       throws IOException,
OpenSearchException

Lists all active point in time searches.

Parameters:

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

Throws:

IOException

OpenSearchException

getAllPits

public final CompletableFuture<GetAllPitsResponse> getAllPits()
                                                       throws IOException,
OpenSearchException

Lists all active point in time searches.

Throws:

IOException

OpenSearchException

getScript

public CompletableFuture<GetScriptResponse> getScript(GetScriptRequest request)
                                               throws IOException,
OpenSearchException

Returns a script.

Throws:

IOException

OpenSearchException

getScript

public final CompletableFuture<GetScriptResponse> getScript(Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)
                                                     throws IOException,
OpenSearchException

Returns a script.

Parameters:

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

Throws:

IOException

OpenSearchException

getScriptContext

public CompletableFuture<GetScriptContextResponse> getScriptContext(GetScriptContextRequest request)
                                                             throws IOException,
OpenSearchException

Returns all script contexts.

Throws:

IOException

OpenSearchException

getScriptContext

public final CompletableFuture<GetScriptContextResponse> getScriptContext(Function<GetScriptContextRequest.Builder,ObjectBuilder<GetScriptContextRequest>> fn)
                                                                   throws IOException,
OpenSearchException

Returns all script contexts.

Parameters:

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

Throws:

IOException

OpenSearchException

getScriptContext

public final CompletableFuture<GetScriptContextResponse> getScriptContext()
                                                                   throws IOException,
OpenSearchException

Returns all script contexts.

Throws:

IOException

OpenSearchException

getScriptLanguages

public CompletableFuture<GetScriptLanguagesResponse> getScriptLanguages(GetScriptLanguagesRequest request)
                                                                 throws IOException,
OpenSearchException

Returns available script types, languages and contexts.

Throws:

IOException

OpenSearchException

getScriptLanguages

public final CompletableFuture<GetScriptLanguagesResponse> getScriptLanguages(Function<GetScriptLanguagesRequest.Builder,ObjectBuilder<GetScriptLanguagesRequest>> fn)
                                                                       throws IOException,
OpenSearchException

Returns available script types, languages and contexts.

Parameters:

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

Throws:

IOException

OpenSearchException

getScriptLanguages

public final CompletableFuture<GetScriptLanguagesResponse> getScriptLanguages()
                                                                       throws IOException,
OpenSearchException

Returns available script types, languages and contexts.

Throws:

IOException

OpenSearchException

info

public CompletableFuture<InfoResponse> info(InfoRequest request)
                                     throws IOException,
OpenSearchException

Returns basic information about the cluster.

Throws:

IOException

OpenSearchException

info

public final CompletableFuture<InfoResponse> info(Function<InfoRequest.Builder,ObjectBuilder<InfoRequest>> fn)
                                           throws IOException,
OpenSearchException

Returns basic information about the cluster.

Parameters:

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

Throws:

IOException

OpenSearchException

info

public final CompletableFuture<InfoResponse> info()
                                           throws IOException,
OpenSearchException

Returns basic information about the cluster.

Throws:

IOException

OpenSearchException

mtermvectors

public CompletableFuture<MtermvectorsResponse> mtermvectors(MtermvectorsRequest request)
                                                     throws IOException,
OpenSearchException

Returns multiple termvectors in one request.

Throws:

IOException

OpenSearchException

mtermvectors

public final CompletableFuture<MtermvectorsResponse> mtermvectors(Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)
                                                           throws IOException,
OpenSearchException

Returns multiple termvectors in one request.

Parameters:

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

Throws:

IOException

OpenSearchException

mtermvectors

public final CompletableFuture<MtermvectorsResponse> mtermvectors()
                                                           throws IOException,
OpenSearchException

Returns multiple termvectors in one request.

Throws:

IOException

OpenSearchException

ping

public CompletableFuture<BooleanResponse> ping(PingRequest request)
                                        throws IOException,
OpenSearchException

Returns whether the cluster is running.

Throws:

IOException

OpenSearchException

ping

public final CompletableFuture<BooleanResponse> ping(Function<PingRequest.Builder,ObjectBuilder<PingRequest>> fn)
                                              throws IOException,
OpenSearchException

Returns whether the cluster is running.

Parameters:

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

Throws:

IOException

OpenSearchException

ping

public final CompletableFuture<BooleanResponse> ping()
                                              throws IOException,
OpenSearchException

Returns whether the cluster is running.

Throws:

IOException

OpenSearchException

putScript

public CompletableFuture<PutScriptResponse> putScript(PutScriptRequest request)
                                               throws IOException,
OpenSearchException

Creates or updates a script.

Throws:

IOException

OpenSearchException

putScript

public final CompletableFuture<PutScriptResponse> putScript(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)
                                                     throws IOException,
OpenSearchException

Creates or updates a script.

Parameters:

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

Throws:

IOException

OpenSearchException

rankEval

public CompletableFuture<RankEvalResponse> rankEval(RankEvalRequest request)
                                             throws IOException,
OpenSearchException

Allows to evaluate the quality of ranked search results over a set of typical search queries.

Throws:

IOException

OpenSearchException

rankEval

public final CompletableFuture<RankEvalResponse> rankEval(Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)
                                                   throws IOException,
OpenSearchException

Allows to evaluate the quality of ranked search results over a set of typical search queries.

Parameters:

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

Throws:

IOException

OpenSearchException

reindex

public CompletableFuture<ReindexResponse> reindex(ReindexRequest request)
                                           throws IOException,
OpenSearchException

Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.

Throws:

IOException

OpenSearchException

reindex

public final CompletableFuture<ReindexResponse> reindex(Function<ReindexRequest.Builder,ObjectBuilder<ReindexRequest>> fn)
                                                 throws IOException,
OpenSearchException

Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.

Parameters:

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

Throws:

IOException

OpenSearchException

reindexRethrottle

public CompletableFuture<ReindexRethrottleResponse> reindexRethrottle(ReindexRethrottleRequest request)
                                                               throws IOException,
OpenSearchException

Changes the number of requests per second for a particular reindex operation.

Throws:

IOException

OpenSearchException

reindexRethrottle

public final CompletableFuture<ReindexRethrottleResponse> reindexRethrottle(Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Changes the number of requests per second for a particular reindex operation.

Parameters:

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

Throws:

IOException

OpenSearchException

renderSearchTemplate

public CompletableFuture<RenderSearchTemplateResponse> renderSearchTemplate(RenderSearchTemplateRequest request)
                                                                     throws IOException,
OpenSearchException

Allows to use the Mustache language to pre-render a search definition.

Throws:

IOException

OpenSearchException

renderSearchTemplate

public final CompletableFuture<RenderSearchTemplateResponse> renderSearchTemplate(Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)
                                                                           throws IOException,
OpenSearchException

Allows to use the Mustache language to pre-render a search definition.

Parameters:

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

Throws:

IOException

OpenSearchException

renderSearchTemplate

public final CompletableFuture<RenderSearchTemplateResponse> renderSearchTemplate()
                                                                           throws IOException,
OpenSearchException

Allows to use the Mustache language to pre-render a search definition.

Throws:

IOException

OpenSearchException

searchShards

public CompletableFuture<SearchShardsResponse> searchShards(SearchShardsRequest request)
                                                     throws IOException,
OpenSearchException

Returns information about the indexes and shards that a search request would be executed against.

Throws:

IOException

OpenSearchException

searchShards

public final CompletableFuture<SearchShardsResponse> searchShards(Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)
                                                           throws IOException,
OpenSearchException

Returns information about the indexes and shards that a search request would be executed against.

Parameters:

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

Throws:

IOException

OpenSearchException

searchShards

public final CompletableFuture<SearchShardsResponse> searchShards()
                                                           throws IOException,
OpenSearchException

Returns information about the indexes and shards that a search request would be executed against.

Throws:

IOException

OpenSearchException

updateByQuery

public CompletableFuture<UpdateByQueryResponse> updateByQuery(UpdateByQueryRequest request)
                                                       throws IOException,
OpenSearchException

Performs an update on every document in the index without changing the source, for example to pick up a mapping change.

Throws:

IOException

OpenSearchException

updateByQuery

public final CompletableFuture<UpdateByQueryResponse> updateByQuery(Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn)
                                                             throws IOException,
OpenSearchException

Performs an update on every document in the index without changing the source, for example to pick up a mapping change.

Parameters:

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

Throws:

IOException

OpenSearchException

updateByQueryRethrottle

public CompletableFuture<UpdateByQueryRethrottleResponse> updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)
                                                                           throws IOException,
OpenSearchException

Changes the number of requests per second for a particular Update By Query operation.

Throws:

IOException

OpenSearchException

updateByQueryRethrottle

public final CompletableFuture<UpdateByQueryRethrottleResponse> updateByQueryRethrottle(Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)
                                                                                 throws IOException,
OpenSearchException

Changes the number of requests per second for a particular Update By Query operation.

Parameters:

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

Throws:

IOException

OpenSearchException