Package co.elastic.clients.elasticsearch

Class ElasticsearchAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchAsyncClient>

co.elastic.clients.elasticsearch.ElasticsearchAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchAsyncClient>

Client for the namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchAsyncClient(ElasticsearchTransport transport)
ElasticsearchAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
ElasticsearchAsyncSearchAsyncClient	asyncSearch()
ElasticsearchAutoscalingAsyncClient	autoscaling()
CompletableFuture<BulkResponse>	bulk()	Bulk index or delete documents.
CompletableFuture<BulkResponse>	bulk(BulkRequest request)	Bulk index or delete documents.
final CompletableFuture<BulkResponse>	bulk(Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)	Bulk index or delete documents.
ElasticsearchCatAsyncClient	cat()
ElasticsearchCcrAsyncClient	ccr()
CompletableFuture<ClearScrollResponse>	clearScroll()	Clear a scrolling search.
CompletableFuture<ClearScrollResponse>	clearScroll(ClearScrollRequest request)	Clear a scrolling search.
final CompletableFuture<ClearScrollResponse>	clearScroll(Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)	Clear a scrolling search.
CompletableFuture<ClosePointInTimeResponse>	closePointInTime(ClosePointInTimeRequest request)	Close a point in time.
final CompletableFuture<ClosePointInTimeResponse>	closePointInTime(Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn)	Close a point in time.
ElasticsearchClusterAsyncClient	cluster()
ElasticsearchConnectorAsyncClient	connector()
CompletableFuture<CountResponse>	count()	Returns number of documents matching a query.
CompletableFuture<CountResponse>	count(CountRequest request)	Returns number of documents matching a query.
final CompletableFuture<CountResponse>	count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Returns number of documents matching a query.
<TDocument> CompletableFuture<CreateResponse>	create(CreateRequest<TDocument> request)	Index a document.
final <TDocument> CompletableFuture<CreateResponse>	create(Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)	Index a document.
ElasticsearchDanglingIndicesAsyncClient	danglingIndices()
CompletableFuture<DeleteResponse>	delete(DeleteRequest request)	Delete a document.
final CompletableFuture<DeleteResponse>	delete(Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)	Delete a document.
CompletableFuture<DeleteByQueryResponse>	deleteByQuery(DeleteByQueryRequest request)	Delete documents.
final CompletableFuture<DeleteByQueryResponse>	deleteByQuery(Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)	Delete documents.
CompletableFuture<DeleteByQueryRethrottleResponse>	deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)	Throttle a delete by query operation.
final CompletableFuture<DeleteByQueryRethrottleResponse>	deleteByQueryRethrottle(Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn)	Throttle a delete by query operation.
CompletableFuture<DeleteScriptResponse>	deleteScript(DeleteScriptRequest request)	Delete a script or search template.
final CompletableFuture<DeleteScriptResponse>	deleteScript(Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)	Delete a script or search template.
ElasticsearchEnrichAsyncClient	enrich()
ElasticsearchEqlAsyncClient	eql()
ElasticsearchEsqlAsyncClient	esql()
CompletableFuture<BooleanResponse>	exists(ExistsRequest request)	Check a document.
final CompletableFuture<BooleanResponse>	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Check a document.
CompletableFuture<BooleanResponse>	existsSource(ExistsSourceRequest request)	Check for a document source.
final CompletableFuture<BooleanResponse>	existsSource(Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)	Check for a document source.
<TDocument> CompletableFuture<ExplainResponse<TDocument>>	explain(ExplainRequest request, Class<TDocument> tDocumentClass)	Explain a document match result.
<TDocument> CompletableFuture<ExplainResponse<TDocument>>	explain(ExplainRequest request, Type tDocumentType)	Explain a document match result.
final <TDocument> CompletableFuture<ExplainResponse<TDocument>>	explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, Class<TDocument> tDocumentClass)	Explain a document match result.
final <TDocument> CompletableFuture<ExplainResponse<TDocument>>	explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, Type tDocumentType)	Explain a document match result.
ElasticsearchFeaturesAsyncClient	features()
CompletableFuture<FieldCapsResponse>	fieldCaps()	Get the field capabilities.
CompletableFuture<FieldCapsResponse>	fieldCaps(FieldCapsRequest request)	Get the field capabilities.
final CompletableFuture<FieldCapsResponse>	fieldCaps(Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)	Get the field capabilities.
ElasticsearchFleetAsyncClient	fleet()
<TDocument> CompletableFuture<GetResponse<TDocument>>	get(GetRequest request, Class<TDocument> tDocumentClass)	Get a document by its ID.
<TDocument> CompletableFuture<GetResponse<TDocument>>	get(GetRequest request, Type tDocumentType)	Get a document by its ID.
final <TDocument> CompletableFuture<GetResponse<TDocument>>	get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, Class<TDocument> tDocumentClass)	Get a document by its ID.
final <TDocument> CompletableFuture<GetResponse<TDocument>>	get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, Type tDocumentType)	Get a document by its ID.
CompletableFuture<GetScriptResponse>	getScript(GetScriptRequest request)	Get a script or search template.
final CompletableFuture<GetScriptResponse>	getScript(Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)	Get a script or search template.
CompletableFuture<GetScriptContextResponse>	getScriptContext()	Get script contexts.
CompletableFuture<GetScriptLanguagesResponse>	getScriptLanguages()	Get script languages.
<TDocument> CompletableFuture<GetSourceResponse<TDocument>>	getSource(GetSourceRequest request, Class<TDocument> tDocumentClass)	Get a document's source.
<TDocument> CompletableFuture<GetSourceResponse<TDocument>>	getSource(GetSourceRequest request, Type tDocumentType)	Get a document's source.
final <TDocument> CompletableFuture<GetSourceResponse<TDocument>>	getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, Class<TDocument> tDocumentClass)	Get a document's source.
final <TDocument> CompletableFuture<GetSourceResponse<TDocument>>	getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, Type tDocumentType)	Get a document's source.
ElasticsearchGraphAsyncClient	graph()
CompletableFuture<HealthReportResponse>	healthReport()	Returns the health of the cluster.
CompletableFuture<HealthReportResponse>	healthReport(HealthReportRequest request)	Returns the health of the cluster.
final CompletableFuture<HealthReportResponse>	healthReport(Function<HealthReportRequest.Builder,ObjectBuilder<HealthReportRequest>> fn)	Returns the health of the cluster.
ElasticsearchIlmAsyncClient	ilm()
<TDocument> CompletableFuture<IndexResponse>	index(IndexRequest<TDocument> request)	Index a document.
final <TDocument> CompletableFuture<IndexResponse>	index(Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)	Index a document.
ElasticsearchIndicesAsyncClient	indices()
ElasticsearchInferenceAsyncClient	inference()
CompletableFuture<InfoResponse>	info()	Get cluster info.
ElasticsearchIngestAsyncClient	ingest()
<TDocument> CompletableFuture<KnnSearchResponse<TDocument>>	knnSearch(KnnSearchRequest request, Class<TDocument> tDocumentClass)	Run a knn search.
<TDocument> CompletableFuture<KnnSearchResponse<TDocument>>	knnSearch(KnnSearchRequest request, Type tDocumentType)	Run a knn search.
final <TDocument> CompletableFuture<KnnSearchResponse<TDocument>>	knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn, Class<TDocument> tDocumentClass)	Run a knn search.
final <TDocument> CompletableFuture<KnnSearchResponse<TDocument>>	knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn, Type tDocumentType)	Run a knn search.
ElasticsearchLicenseAsyncClient	license()
ElasticsearchLogstashAsyncClient	logstash()
<TDocument> CompletableFuture<MgetResponse<TDocument>>	mget(MgetRequest request, Class<TDocument> tDocumentClass)	Get multiple documents.
<TDocument> CompletableFuture<MgetResponse<TDocument>>	mget(MgetRequest request, Type tDocumentType)	Get multiple documents.
final <TDocument> CompletableFuture<MgetResponse<TDocument>>	mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, Class<TDocument> tDocumentClass)	Get multiple documents.
final <TDocument> CompletableFuture<MgetResponse<TDocument>>	mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, Type tDocumentType)	Get multiple documents.
ElasticsearchMigrationAsyncClient	migration()
ElasticsearchMlAsyncClient	ml()
ElasticsearchMonitoringAsyncClient	monitoring()
<TDocument> CompletableFuture<MsearchResponse<TDocument>>	msearch(MsearchRequest request, Class<TDocument> tDocumentClass)	Run multiple searches.
<TDocument> CompletableFuture<MsearchResponse<TDocument>>	msearch(MsearchRequest request, Type tDocumentType)	Run multiple searches.
final <TDocument> CompletableFuture<MsearchResponse<TDocument>>	msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, Class<TDocument> tDocumentClass)	Run multiple searches.
final <TDocument> CompletableFuture<MsearchResponse<TDocument>>	msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, Type tDocumentType)	Run multiple searches.
<TDocument> CompletableFuture<MsearchTemplateResponse<TDocument>>	msearchTemplate(MsearchTemplateRequest request, Class<TDocument> tDocumentClass)	Run multiple templated searches.
<TDocument> CompletableFuture<MsearchTemplateResponse<TDocument>>	msearchTemplate(MsearchTemplateRequest request, Type tDocumentType)	Run multiple templated searches.
final <TDocument> CompletableFuture<MsearchTemplateResponse<TDocument>>	msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Run multiple templated searches.
final <TDocument> CompletableFuture<MsearchTemplateResponse<TDocument>>	msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, Type tDocumentType)	Run multiple templated searches.
CompletableFuture<MtermvectorsResponse>	mtermvectors()	Get multiple term vectors.
CompletableFuture<MtermvectorsResponse>	mtermvectors(MtermvectorsRequest request)	Get multiple term vectors.
final CompletableFuture<MtermvectorsResponse>	mtermvectors(Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)	Get multiple term vectors.
ElasticsearchNodesAsyncClient	nodes()
CompletableFuture<OpenPointInTimeResponse>	openPointInTime(OpenPointInTimeRequest request)	Open a point in time.
final CompletableFuture<OpenPointInTimeResponse>	openPointInTime(Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)	Open a point in time.
CompletableFuture<BooleanResponse>	ping()	Ping the cluster.
CompletableFuture<PutScriptResponse>	putScript(PutScriptRequest request)	Create or update a script or search template.
final CompletableFuture<PutScriptResponse>	putScript(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)	Create or update a script or search template.
ElasticsearchQueryRulesAsyncClient	queryRules()
CompletableFuture<RankEvalResponse>	rankEval(RankEvalRequest request)	Evaluate ranked search results.
final CompletableFuture<RankEvalResponse>	rankEval(Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)	Evaluate ranked search results.
CompletableFuture<ReindexResponse>	reindex(ReindexRequest request)	Reindex documents.
final CompletableFuture<ReindexResponse>	reindex(Function<ReindexRequest.Builder,ObjectBuilder<ReindexRequest>> fn)	Reindex documents.
CompletableFuture<ReindexRethrottleResponse>	reindexRethrottle(ReindexRethrottleRequest request)	Throttle a reindex operation.
final CompletableFuture<ReindexRethrottleResponse>	reindexRethrottle(Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)	Throttle a reindex operation.
CompletableFuture<RenderSearchTemplateResponse>	renderSearchTemplate()	Render a search template.
CompletableFuture<RenderSearchTemplateResponse>	renderSearchTemplate(RenderSearchTemplateRequest request)	Render a search template.
final CompletableFuture<RenderSearchTemplateResponse>	renderSearchTemplate(Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)	Render a search template.
ElasticsearchRollupAsyncClient	rollup()
<TResult> CompletableFuture<ScriptsPainlessExecuteResponse<TResult>>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, Class<TResult> tResultClass)	Run a script.
<TResult> CompletableFuture<ScriptsPainlessExecuteResponse<TResult>>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, Type tResultType)	Run a script.
final <TResult> CompletableFuture<ScriptsPainlessExecuteResponse<TResult>>	scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, Class<TResult> tResultClass)	Run a script.
final <TResult> CompletableFuture<ScriptsPainlessExecuteResponse<TResult>>	scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, Type tResultType)	Run a script.
<TDocument> CompletableFuture<ScrollResponse<TDocument>>	scroll(ScrollRequest request, Class<TDocument> tDocumentClass)	Run a scrolling search.
<TDocument> CompletableFuture<ScrollResponse<TDocument>>	scroll(ScrollRequest request, Type tDocumentType)	Run a scrolling search.
final <TDocument> CompletableFuture<ScrollResponse<TDocument>>	scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, Class<TDocument> tDocumentClass)	Run a scrolling search.
final <TDocument> CompletableFuture<ScrollResponse<TDocument>>	scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, Type tDocumentType)	Run a scrolling search.
<TDocument> CompletableFuture<SearchResponse<TDocument>>	search(SearchRequest request, Class<TDocument> tDocumentClass)	Run a search.
<TDocument> CompletableFuture<SearchResponse<TDocument>>	search(SearchRequest request, Type tDocumentType)	Run a search.
final <TDocument> CompletableFuture<SearchResponse<TDocument>>	search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, Class<TDocument> tDocumentClass)	Run a search.
final <TDocument> CompletableFuture<SearchResponse<TDocument>>	search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, Type tDocumentType)	Run a search.
ElasticsearchSearchableSnapshotsAsyncClient	searchableSnapshots()
ElasticsearchSearchApplicationAsyncClient	searchApplication()
CompletableFuture<BinaryResponse>	searchMvt(SearchMvtRequest request)	Search a vector tile.
final CompletableFuture<BinaryResponse>	searchMvt(Function<SearchMvtRequest.Builder,ObjectBuilder<SearchMvtRequest>> fn)	Search a vector tile.
CompletableFuture<SearchShardsResponse>	searchShards()	Get the search shards.
CompletableFuture<SearchShardsResponse>	searchShards(SearchShardsRequest request)	Get the search shards.
final CompletableFuture<SearchShardsResponse>	searchShards(Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)	Get the search shards.
<TDocument> CompletableFuture<SearchTemplateResponse<TDocument>>	searchTemplate(SearchTemplateRequest request, Class<TDocument> tDocumentClass)	Run a search with a search template.
<TDocument> CompletableFuture<SearchTemplateResponse<TDocument>>	searchTemplate(SearchTemplateRequest request, Type tDocumentType)	Run a search with a search template.
final <TDocument> CompletableFuture<SearchTemplateResponse<TDocument>>	searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Run a search with a search template.
final <TDocument> CompletableFuture<SearchTemplateResponse<TDocument>>	searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, Type tDocumentType)	Run a search with a search template.
ElasticsearchSecurityAsyncClient	security()
ElasticsearchShutdownAsyncClient	shutdown()
ElasticsearchSlmAsyncClient	slm()
ElasticsearchSnapshotAsyncClient	snapshot()
ElasticsearchSqlAsyncClient	sql()
ElasticsearchSslAsyncClient	ssl()
ElasticsearchSynonymsAsyncClient	synonyms()
ElasticsearchTasksAsyncClient	tasks()
CompletableFuture<TermsEnumResponse>	termsEnum(TermsEnumRequest request)	Get terms in an index.
final CompletableFuture<TermsEnumResponse>	termsEnum(Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)	Get terms in an index.
<TDocument> CompletableFuture<TermvectorsResponse>	termvectors(TermvectorsRequest<TDocument> request)	Get term vector information.
final <TDocument> CompletableFuture<TermvectorsResponse>	termvectors(Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)	Get term vector information.
ElasticsearchTextStructureAsyncClient	textStructure()
ElasticsearchTransformAsyncClient	transform()
<TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDocument>>	update(UpdateRequest<TDocument,TPartialDocument> request, Class<TDocument> tDocumentClass)	Update a document.
<TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDocument>>	update(UpdateRequest<TDocument,TPartialDocument> request, Type tDocumentType)	Update a document.
final <TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDocument>>	update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, Class<TDocument> tDocumentClass)	Update a document.
final <TDocument, TPartialDocument> CompletableFuture<UpdateResponse<TDocument>>	update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, Type tDocumentType)	Update a document.
CompletableFuture<UpdateByQueryResponse>	updateByQuery(UpdateByQueryRequest request)	Update documents.
final CompletableFuture<UpdateByQueryResponse>	updateByQuery(Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn)	Update documents.
CompletableFuture<UpdateByQueryRethrottleResponse>	updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)	Throttle an update by query operation.
final CompletableFuture<UpdateByQueryRethrottleResponse>	updateByQueryRethrottle(Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)	Throttle an update by query operation.
ElasticsearchWatcherAsyncClient	watcher()
ElasticsearchAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options
ElasticsearchXpackAsyncClient	xpack()

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchAsyncClient

public ElasticsearchAsyncClient(ElasticsearchTransport transport)

ElasticsearchAsyncClient

public ElasticsearchAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchAsyncClient>

asyncSearch

public ElasticsearchAsyncSearchAsyncClient asyncSearch()

autoscaling

public ElasticsearchAutoscalingAsyncClient autoscaling()

cat

public ElasticsearchCatAsyncClient cat()

ccr

public ElasticsearchCcrAsyncClient ccr()

cluster

public ElasticsearchClusterAsyncClient cluster()

connector

public ElasticsearchConnectorAsyncClient connector()

danglingIndices

public ElasticsearchDanglingIndicesAsyncClient danglingIndices()

enrich

public ElasticsearchEnrichAsyncClient enrich()

eql

public ElasticsearchEqlAsyncClient eql()

esql

public ElasticsearchEsqlAsyncClient esql()

features

public ElasticsearchFeaturesAsyncClient features()

fleet

public ElasticsearchFleetAsyncClient fleet()

graph

public ElasticsearchGraphAsyncClient graph()

ilm

public ElasticsearchIlmAsyncClient ilm()

indices

public ElasticsearchIndicesAsyncClient indices()

inference

public ElasticsearchInferenceAsyncClient inference()

ingest

public ElasticsearchIngestAsyncClient ingest()

license

public ElasticsearchLicenseAsyncClient license()

logstash

public ElasticsearchLogstashAsyncClient logstash()

migration

public ElasticsearchMigrationAsyncClient migration()

ml

public ElasticsearchMlAsyncClient ml()

monitoring

public ElasticsearchMonitoringAsyncClient monitoring()

nodes

public ElasticsearchNodesAsyncClient nodes()

queryRules

public ElasticsearchQueryRulesAsyncClient queryRules()

rollup

public ElasticsearchRollupAsyncClient rollup()

searchApplication

public ElasticsearchSearchApplicationAsyncClient searchApplication()

searchableSnapshots

public ElasticsearchSearchableSnapshotsAsyncClient searchableSnapshots()

security

public ElasticsearchSecurityAsyncClient security()

shutdown

public ElasticsearchShutdownAsyncClient shutdown()

slm

public ElasticsearchSlmAsyncClient slm()

snapshot

public ElasticsearchSnapshotAsyncClient snapshot()

sql

public ElasticsearchSqlAsyncClient sql()

ssl

public ElasticsearchSslAsyncClient ssl()

synonyms

public ElasticsearchSynonymsAsyncClient synonyms()

tasks

public ElasticsearchTasksAsyncClient tasks()

textStructure

public ElasticsearchTextStructureAsyncClient textStructure()

transform

public ElasticsearchTransformAsyncClient transform()

watcher

public ElasticsearchWatcherAsyncClient watcher()

xpack

public ElasticsearchXpackAsyncClient xpack()

bulk

public CompletableFuture<BulkResponse> bulk(BulkRequest request)

Bulk index or delete documents. Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.

See Also:

• Documentation on elastic.co

bulk

public final CompletableFuture<BulkResponse> bulk(Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)

Bulk index or delete documents. Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.

Parameters:

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

See Also:

• Documentation on elastic.co

bulk

public CompletableFuture<BulkResponse> bulk()

Bulk index or delete documents. Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.

See Also:

• Documentation on elastic.co

clearScroll

public CompletableFuture<ClearScrollResponse> clearScroll(ClearScrollRequest request)

Clear a scrolling search.

Clear the search context and results for a scrolling search.

See Also:

• Documentation on elastic.co

clearScroll

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

Clear a scrolling search.

Clear the search context and results for a scrolling search.

Parameters:

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

See Also:

• Documentation on elastic.co

clearScroll

public CompletableFuture<ClearScrollResponse> clearScroll()

Clear a scrolling search.

Clear the search context and results for a scrolling search.

See Also:

• Documentation on elastic.co

closePointInTime

public CompletableFuture<ClosePointInTimeResponse> closePointInTime(ClosePointInTimeRequest request)

Close a point in time.

A point in time must be opened explicitly before being used in search requests. The keep_alive parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the keep_alive period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.

See Also:

• Documentation on elastic.co

closePointInTime

public final CompletableFuture<ClosePointInTimeResponse> closePointInTime(Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn)

Close a point in time.

A point in time must be opened explicitly before being used in search requests. The keep_alive parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the keep_alive period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.

Parameters:

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

See Also:

• Documentation on elastic.co

count

public CompletableFuture<CountResponse> count(CountRequest request)

Returns number of documents matching a query.

See Also:

• Documentation on elastic.co

count

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

Returns number of documents matching a query.

Parameters:

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

See Also:

• Documentation on elastic.co

count

public CompletableFuture<CountResponse> count()

Returns number of documents matching a query.

See Also:

• Documentation on elastic.co

create

public <TDocument>
CompletableFuture<CreateResponse> create(CreateRequest<TDocument> request)

Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

See Also:

• Documentation on elastic.co

create

public final <TDocument>
CompletableFuture<CreateResponse> create(Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)

Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

Parameters:

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

See Also:

• Documentation on elastic.co

delete

public CompletableFuture<DeleteResponse> delete(DeleteRequest request)

Delete a document. Removes a JSON document from the specified index.

See Also:

• Documentation on elastic.co

delete

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

Delete a document. Removes a JSON document from the specified index.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteByQuery

public CompletableFuture<DeleteByQueryResponse> deleteByQuery(DeleteByQueryRequest request)

Delete documents. Deletes documents that match the specified query.

See Also:

• Documentation on elastic.co

deleteByQuery

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

Delete documents. Deletes documents that match the specified query.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteByQueryRethrottle

public CompletableFuture<DeleteByQueryRethrottleResponse> deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)

Throttle a delete by query operation.

Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

See Also:

• Documentation on elastic.co

deleteByQueryRethrottle

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

Throttle a delete by query operation.

Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteScript

public CompletableFuture<DeleteScriptResponse> deleteScript(DeleteScriptRequest request)

Delete a script or search template. Deletes a stored script or search template.

See Also:

• Documentation on elastic.co

deleteScript

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

Delete a script or search template. Deletes a stored script or search template.

Parameters:

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

See Also:

• Documentation on elastic.co

exists

public CompletableFuture<BooleanResponse> exists(ExistsRequest request)

Check a document. Checks if a specified document exists.

See Also:

• Documentation on elastic.co

exists

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

Check a document. Checks if a specified document exists.

Parameters:

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

See Also:

• Documentation on elastic.co

existsSource

public CompletableFuture<BooleanResponse> existsSource(ExistsSourceRequest request)

Check for a document source. Checks if a document's _source is stored.

See Also:

• Documentation on elastic.co

existsSource

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

Check for a document source. Checks if a document's _source is stored.

Parameters:

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

See Also:

• Documentation on elastic.co

explain

public <TDocument>
CompletableFuture<ExplainResponse<TDocument>> explain(ExplainRequest request,
 Class<TDocument> tDocumentClass)

Explain a document match result. Returns information about why a specific document matches, or doesn’t match, a query.

See Also:

• Documentation on elastic.co

explain

public final <TDocument>
CompletableFuture<ExplainResponse<TDocument>> explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn,
 Class<TDocument> tDocumentClass)

Explain a document match result. Returns information about why a specific document matches, or doesn’t match, a query.

Parameters:

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

See Also:

• Documentation on elastic.co

explain

public <TDocument>
CompletableFuture<ExplainResponse<TDocument>> explain(ExplainRequest request,
 Type tDocumentType)

Explain a document match result. Returns information about why a specific document matches, or doesn’t match, a query.

See Also:

• Documentation on elastic.co

explain

public final <TDocument>
CompletableFuture<ExplainResponse<TDocument>> explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn,
 Type tDocumentType)

Explain a document match result. Returns information about why a specific document matches, or doesn’t match, a query.

Parameters:

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

See Also:

• Documentation on elastic.co

fieldCaps

public CompletableFuture<FieldCapsResponse> fieldCaps(FieldCapsRequest request)

Get the field capabilities.

Get information about the capabilities of fields among multiple indices.

For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family.

See Also:

• Documentation on elastic.co

fieldCaps

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

Get the field capabilities.

Get information about the capabilities of fields among multiple indices.

For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family.

Parameters:

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

See Also:

• Documentation on elastic.co

fieldCaps

public CompletableFuture<FieldCapsResponse> fieldCaps()

Get the field capabilities.

Get information about the capabilities of fields among multiple indices.

For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family.

See Also:

• Documentation on elastic.co

get

public <TDocument>
CompletableFuture<GetResponse<TDocument>> get(GetRequest request,
 Class<TDocument> tDocumentClass)

Get a document by its ID. Retrieves the document with the specified ID from an index.

See Also:

• Documentation on elastic.co

get

public final <TDocument>
CompletableFuture<GetResponse<TDocument>> get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn,
 Class<TDocument> tDocumentClass)

Get a document by its ID. Retrieves the document with the specified ID from an index.

Parameters:

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

See Also:

• Documentation on elastic.co

get

public <TDocument>
CompletableFuture<GetResponse<TDocument>> get(GetRequest request,
 Type tDocumentType)

Get a document by its ID. Retrieves the document with the specified ID from an index.

See Also:

• Documentation on elastic.co

get

public final <TDocument>
CompletableFuture<GetResponse<TDocument>> get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn,
 Type tDocumentType)

Get a document by its ID. Retrieves the document with the specified ID from an index.

Parameters:

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

See Also:

• Documentation on elastic.co

getScript

public CompletableFuture<GetScriptResponse> getScript(GetScriptRequest request)

Get a script or search template. Retrieves a stored script or search template.

See Also:

• Documentation on elastic.co

getScript

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

Get a script or search template. Retrieves a stored script or search template.

Parameters:

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

See Also:

• Documentation on elastic.co

getScriptContext

public CompletableFuture<GetScriptContextResponse> getScriptContext()

Get script contexts.

Get a list of supported script contexts and their methods.

See Also:

• Documentation on elastic.co

getScriptLanguages

public CompletableFuture<GetScriptLanguagesResponse> getScriptLanguages()

Get script languages.

Get a list of available script types, languages, and contexts.

See Also:

• Documentation on elastic.co

getSource

public <TDocument>
CompletableFuture<GetSourceResponse<TDocument>> getSource(GetSourceRequest request,
 Class<TDocument> tDocumentClass)

Get a document's source. Returns the source of a document.

See Also:

• Documentation on elastic.co

getSource

public final <TDocument>
CompletableFuture<GetSourceResponse<TDocument>> getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn,
 Class<TDocument> tDocumentClass)

Get a document's source. Returns the source of a document.

Parameters:

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

See Also:

• Documentation on elastic.co

getSource

public <TDocument>
CompletableFuture<GetSourceResponse<TDocument>> getSource(GetSourceRequest request,
 Type tDocumentType)

Get a document's source. Returns the source of a document.

See Also:

• Documentation on elastic.co

getSource

public final <TDocument>
CompletableFuture<GetSourceResponse<TDocument>> getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn,
 Type tDocumentType)

Get a document's source. Returns the source of a document.

Parameters:

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

See Also:

• Documentation on elastic.co

healthReport

public CompletableFuture<HealthReportResponse> healthReport(HealthReportRequest request)

Returns the health of the cluster.

See Also:

• Documentation on elastic.co

healthReport

public final CompletableFuture<HealthReportResponse> healthReport(Function<HealthReportRequest.Builder,ObjectBuilder<HealthReportRequest>> fn)

Returns the health of the cluster.

Parameters:

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

See Also:

• Documentation on elastic.co

healthReport

public CompletableFuture<HealthReportResponse> healthReport()

Returns the health of the cluster.

See Also:

• Documentation on elastic.co

index

public <TDocument> CompletableFuture<IndexResponse> index(IndexRequest<TDocument> request)

Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

See Also:

• Documentation on elastic.co

index

public final <TDocument>
CompletableFuture<IndexResponse> index(Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)

Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

Parameters:

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

See Also:

• Documentation on elastic.co

info

public CompletableFuture<InfoResponse> info()

Get cluster info. Returns basic information about the cluster.

See Also:

• Documentation on elastic.co

knnSearch

public <TDocument>
CompletableFuture<KnnSearchResponse<TDocument>> knnSearch(KnnSearchRequest request,
 Class<TDocument> tDocumentClass)

Run a knn search.

NOTE: The kNN search API has been replaced by the knn option in the search API.

Perform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents. Given a query vector, the API finds the k closest vectors and returns those documents as search hits.

Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed. This means the results returned are not always the true k closest neighbors.

The kNN search API supports restricting the search using a filter. The search will return the top k documents that also match the filter query.

See Also:

• Documentation on elastic.co

knnSearch

public final <TDocument>
CompletableFuture<KnnSearchResponse<TDocument>> knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn,
 Class<TDocument> tDocumentClass)

Run a knn search.

NOTE: The kNN search API has been replaced by the knn option in the search API.

Perform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents. Given a query vector, the API finds the k closest vectors and returns those documents as search hits.

Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed. This means the results returned are not always the true k closest neighbors.

The kNN search API supports restricting the search using a filter. The search will return the top k documents that also match the filter query.

Parameters:

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

See Also:

• Documentation on elastic.co

knnSearch

public <TDocument>
CompletableFuture<KnnSearchResponse<TDocument>> knnSearch(KnnSearchRequest request,
 Type tDocumentType)

Run a knn search.

NOTE: The kNN search API has been replaced by the knn option in the search API.

Perform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents. Given a query vector, the API finds the k closest vectors and returns those documents as search hits.

Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed. This means the results returned are not always the true k closest neighbors.

The kNN search API supports restricting the search using a filter. The search will return the top k documents that also match the filter query.

See Also:

• Documentation on elastic.co

knnSearch

public final <TDocument>
CompletableFuture<KnnSearchResponse<TDocument>> knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn,
 Type tDocumentType)

Run a knn search.

NOTE: The kNN search API has been replaced by the knn option in the search API.

Perform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents. Given a query vector, the API finds the k closest vectors and returns those documents as search hits.

Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed. This means the results returned are not always the true k closest neighbors.

The kNN search API supports restricting the search using a filter. The search will return the top k documents that also match the filter query.

Parameters:

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

See Also:

• Documentation on elastic.co

mget

public <TDocument>
CompletableFuture<MgetResponse<TDocument>> mget(MgetRequest request,
 Class<TDocument> tDocumentClass)

Get multiple documents.

Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

See Also:

• Documentation on elastic.co

mget

public final <TDocument>
CompletableFuture<MgetResponse<TDocument>> mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn,
 Class<TDocument> tDocumentClass)

Get multiple documents.

Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

Parameters:

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

See Also:

• Documentation on elastic.co

mget

public <TDocument>
CompletableFuture<MgetResponse<TDocument>> mget(MgetRequest request,
 Type tDocumentType)

Get multiple documents.

Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

See Also:

• Documentation on elastic.co

mget

public final <TDocument>
CompletableFuture<MgetResponse<TDocument>> mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn,
 Type tDocumentType)

Get multiple documents.

Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

Parameters:

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

See Also:

• Documentation on elastic.co

msearch

public <TDocument>
CompletableFuture<MsearchResponse<TDocument>> msearch(MsearchRequest request,
 Class<TDocument> tDocumentClass)

Run multiple searches.

The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows:

 header\n
 body\n
 header\n
 body\n
 
 

This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.

IMPORTANT: The final line of data must end with a newline character \n. Each newline character may be preceded by a carriage return \r. When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.

See Also:

• Documentation on elastic.co

msearch

public final <TDocument>
CompletableFuture<MsearchResponse<TDocument>> msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn,
 Class<TDocument> tDocumentClass)

Run multiple searches.

The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows:

 header\n
 body\n
 header\n
 body\n
 
 

This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.

IMPORTANT: The final line of data must end with a newline character \n. Each newline character may be preceded by a carriage return \r. When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.

Parameters:

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

See Also:

• Documentation on elastic.co

msearch

public <TDocument>
CompletableFuture<MsearchResponse<TDocument>> msearch(MsearchRequest request,
 Type tDocumentType)

Run multiple searches.

The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows:

 header\n
 body\n
 header\n
 body\n
 
 

This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.

IMPORTANT: The final line of data must end with a newline character \n. Each newline character may be preceded by a carriage return \r. When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.

See Also:

• Documentation on elastic.co

msearch

public final <TDocument>
CompletableFuture<MsearchResponse<TDocument>> msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn,
 Type tDocumentType)

Run multiple searches.

The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows:

 header\n
 body\n
 header\n
 body\n
 
 

This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.

IMPORTANT: The final line of data must end with a newline character \n. Each newline character may be preceded by a carriage return \r. When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.

Parameters:

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

See Also:

• Documentation on elastic.co

msearchTemplate

public <TDocument>
CompletableFuture<MsearchTemplateResponse<TDocument>> msearchTemplate(MsearchTemplateRequest request,
 Class<TDocument> tDocumentClass)

Run multiple templated searches.

See Also:

• Documentation on elastic.co

msearchTemplate

public final <TDocument>
CompletableFuture<MsearchTemplateResponse<TDocument>> msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn,
 Class<TDocument> tDocumentClass)

Run multiple templated searches.

Parameters:

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

See Also:

• Documentation on elastic.co

msearchTemplate

public <TDocument>
CompletableFuture<MsearchTemplateResponse<TDocument>> msearchTemplate(MsearchTemplateRequest request,
 Type tDocumentType)

Run multiple templated searches.

See Also:

• Documentation on elastic.co

msearchTemplate

public final <TDocument>
CompletableFuture<MsearchTemplateResponse<TDocument>> msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn,
 Type tDocumentType)

Run multiple templated searches.

Parameters:

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

See Also:

• Documentation on elastic.co

mtermvectors

public CompletableFuture<MtermvectorsResponse> mtermvectors(MtermvectorsRequest request)

Get multiple term vectors.

You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a docs array with all the fetched termvectors. Each element has the structure provided by the termvectors API.

See Also:

• Documentation on elastic.co

mtermvectors

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

Get multiple term vectors.

You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a docs array with all the fetched termvectors. Each element has the structure provided by the termvectors API.

Parameters:

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

See Also:

• Documentation on elastic.co

mtermvectors

public CompletableFuture<MtermvectorsResponse> mtermvectors()

Get multiple term vectors.

You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a docs array with all the fetched termvectors. Each element has the structure provided by the termvectors API.

See Also:

• Documentation on elastic.co

openPointInTime

public CompletableFuture<OpenPointInTimeResponse> openPointInTime(OpenPointInTimeRequest request)

Open a point in time.

A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between search_after requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time.

A point in time must be opened explicitly before being used in search requests. The keep_alive parameter tells Elasticsearch how long it should persist.

See Also:

• Documentation on elastic.co

openPointInTime

public final CompletableFuture<OpenPointInTimeResponse> openPointInTime(Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)

Open a point in time.

A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between search_after requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time.

A point in time must be opened explicitly before being used in search requests. The keep_alive parameter tells Elasticsearch how long it should persist.

Parameters:

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

See Also:

• Documentation on elastic.co

ping

public CompletableFuture<BooleanResponse> ping()

Ping the cluster. Returns whether the cluster is running.

See Also:

• Documentation on elastic.co

putScript

public CompletableFuture<PutScriptResponse> putScript(PutScriptRequest request)

Create or update a script or search template. Creates or updates a stored script or search template.

See Also:

• Documentation on elastic.co

putScript

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

Create or update a script or search template. Creates or updates a stored script or search template.

Parameters:

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

See Also:

• Documentation on elastic.co

rankEval

public CompletableFuture<RankEvalResponse> rankEval(RankEvalRequest request)

Evaluate ranked search results.

Evaluate the quality of ranked search results over a set of typical search queries.

See Also:

• Documentation on elastic.co

rankEval

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

Evaluate ranked search results.

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

See Also:

• Documentation on elastic.co

reindex

public CompletableFuture<ReindexResponse> reindex(ReindexRequest request)

Reindex documents. Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.

See Also:

• Documentation on elastic.co

reindex

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

Reindex documents. Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.

Parameters:

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

See Also:

• Documentation on elastic.co

reindexRethrottle

public CompletableFuture<ReindexRethrottleResponse> reindexRethrottle(ReindexRethrottleRequest request)

Throttle a reindex operation.

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

See Also:

• Documentation on elastic.co

reindexRethrottle

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

Throttle a reindex operation.

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

Parameters:

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

See Also:

• Documentation on elastic.co

renderSearchTemplate

public CompletableFuture<RenderSearchTemplateResponse> renderSearchTemplate(RenderSearchTemplateRequest request)

Render a search template.

Render a search template as a search request body.

See Also:

• Documentation on elastic.co

renderSearchTemplate

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

Render a search template.

Render a search template as a search request body.

Parameters:

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

See Also:

• Documentation on elastic.co

renderSearchTemplate

public CompletableFuture<RenderSearchTemplateResponse> renderSearchTemplate()

Render a search template.

Render a search template as a search request body.

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

public <TResult>
CompletableFuture<ScriptsPainlessExecuteResponse<TResult>> scriptsPainlessExecute(ScriptsPainlessExecuteRequest request,
 Class<TResult> tResultClass)

Run a script. Runs a script and returns a result.

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

public final <TResult>
CompletableFuture<ScriptsPainlessExecuteResponse<TResult>> scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn,
 Class<TResult> tResultClass)

Run a script. Runs a script and returns a result.

Parameters:

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

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

public <TResult>
CompletableFuture<ScriptsPainlessExecuteResponse<TResult>> scriptsPainlessExecute(ScriptsPainlessExecuteRequest request,
 Type tResultType)

Run a script. Runs a script and returns a result.

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

public final <TResult>
CompletableFuture<ScriptsPainlessExecuteResponse<TResult>> scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn,
 Type tResultType)

Run a script. Runs a script and returns a result.

Parameters:

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

See Also:

• Documentation on elastic.co

scroll

public <TDocument>
CompletableFuture<ScrollResponse<TDocument>> scroll(ScrollRequest request,
 Class<TDocument> tDocumentClass)

Run a scrolling search.

IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT).

The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. The scroll parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the _scroll_id response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.

You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.

IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.

See Also:

• Documentation on elastic.co

scroll

public final <TDocument>
CompletableFuture<ScrollResponse<TDocument>> scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn,
 Class<TDocument> tDocumentClass)

Run a scrolling search.

IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT).

The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. The scroll parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the _scroll_id response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.

You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.

IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.

Parameters:

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

See Also:

• Documentation on elastic.co

scroll

public <TDocument>
CompletableFuture<ScrollResponse<TDocument>> scroll(ScrollRequest request,
 Type tDocumentType)

Run a scrolling search.

IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT).

The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. The scroll parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the _scroll_id response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.

You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.

IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.

See Also:

• Documentation on elastic.co

scroll

public final <TDocument>
CompletableFuture<ScrollResponse<TDocument>> scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn,
 Type tDocumentType)

Run a scrolling search.

IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT).

The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. The scroll parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the _scroll_id response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.

You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.

IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.

Parameters:

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

See Also:

• Documentation on elastic.co

search

public <TDocument>
CompletableFuture<SearchResponse<TDocument>> search(SearchRequest request,
 Class<TDocument> tDocumentClass)

Run a search.

Get search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both are specified, only the query parameter is used.

See Also:

• Documentation on elastic.co

search

public final <TDocument>
CompletableFuture<SearchResponse<TDocument>> search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn,
 Class<TDocument> tDocumentClass)

Run a search.

Get search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both are specified, only the query parameter is used.

Parameters:

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

See Also:

• Documentation on elastic.co

search

public <TDocument>
CompletableFuture<SearchResponse<TDocument>> search(SearchRequest request,
 Type tDocumentType)

Run a search.

Get search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both are specified, only the query parameter is used.

See Also:

• Documentation on elastic.co

search

public final <TDocument>
CompletableFuture<SearchResponse<TDocument>> search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn,
 Type tDocumentType)

Run a search.

Get search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both are specified, only the query parameter is used.

Parameters:

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

See Also:

• Documentation on elastic.co

searchMvt

public CompletableFuture<BinaryResponse> searchMvt(SearchMvtRequest request)

Search a vector tile.

Search a vector tile for geospatial values.

See Also:

• Documentation on elastic.co

searchMvt

public final CompletableFuture<BinaryResponse> searchMvt(Function<SearchMvtRequest.Builder,ObjectBuilder<SearchMvtRequest>> fn)

Search a vector tile.

Search a vector tile for geospatial values.

Parameters:

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

See Also:

• Documentation on elastic.co

searchShards

public CompletableFuture<SearchShardsResponse> searchShards(SearchShardsRequest request)

Get the search shards.

Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.

See Also:

• Documentation on elastic.co

searchShards

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

Get the search shards.

Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.

Parameters:

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

See Also:

• Documentation on elastic.co

searchShards

public CompletableFuture<SearchShardsResponse> searchShards()

Get the search shards.

Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.

See Also:

• Documentation on elastic.co

searchTemplate

public <TDocument>
CompletableFuture<SearchTemplateResponse<TDocument>> searchTemplate(SearchTemplateRequest request,
 Class<TDocument> tDocumentClass)

Run a search with a search template.

See Also:

• Documentation on elastic.co

searchTemplate

public final <TDocument>
CompletableFuture<SearchTemplateResponse<TDocument>> searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn,
 Class<TDocument> tDocumentClass)

Run a search with a search template.

Parameters:

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

See Also:

• Documentation on elastic.co

searchTemplate

public <TDocument>
CompletableFuture<SearchTemplateResponse<TDocument>> searchTemplate(SearchTemplateRequest request,
 Type tDocumentType)

Run a search with a search template.

See Also:

• Documentation on elastic.co

searchTemplate

public final <TDocument>
CompletableFuture<SearchTemplateResponse<TDocument>> searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn,
 Type tDocumentType)

Run a search with a search template.

Parameters:

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

See Also:

• Documentation on elastic.co

termsEnum

public CompletableFuture<TermsEnumResponse> termsEnum(TermsEnumRequest request)

Get terms in an index.

Discover terms that match a partial string in an index. This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios.

If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. This can occur due to a few reasons, such as a request timeout or a node error.

NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.

See Also:

• Documentation on elastic.co

termsEnum

public final CompletableFuture<TermsEnumResponse> termsEnum(Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)

Get terms in an index.

Discover terms that match a partial string in an index. This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios.

If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. This can occur due to a few reasons, such as a request timeout or a node error.

NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.

Parameters:

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

See Also:

• Documentation on elastic.co

termvectors

public <TDocument>
CompletableFuture<TermvectorsResponse> termvectors(TermvectorsRequest<TDocument> request)

Get term vector information.

Get information and statistics about terms in the fields of a particular document.

See Also:

• Documentation on elastic.co

termvectors

public final <TDocument>
CompletableFuture<TermvectorsResponse> termvectors(Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)

Get term vector information.

Get information and statistics about terms in the fields of a particular document.

Parameters:

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

See Also:

• Documentation on elastic.co

update

public <TDocument,
TPartialDocument>
CompletableFuture<UpdateResponse<TDocument>> update(UpdateRequest<TDocument,TPartialDocument> request,
 Class<TDocument> tDocumentClass)

Update a document. Updates a document by running a script or passing a partial document.

See Also:

• Documentation on elastic.co

update

public final <TDocument,
TPartialDocument>
CompletableFuture<UpdateResponse<TDocument>> update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn,
 Class<TDocument> tDocumentClass)

Update a document. Updates a document by running a script or passing a partial document.

Parameters:

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

See Also:

• Documentation on elastic.co

update

public <TDocument,
TPartialDocument>
CompletableFuture<UpdateResponse<TDocument>> update(UpdateRequest<TDocument,TPartialDocument> request,
 Type tDocumentType)

Update a document. Updates a document by running a script or passing a partial document.

See Also:

• Documentation on elastic.co

update

public final <TDocument,
TPartialDocument>
CompletableFuture<UpdateResponse<TDocument>> update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn,
 Type tDocumentType)

Update a document. Updates a document by running a script or passing a partial document.

Parameters:

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

See Also:

• Documentation on elastic.co

updateByQuery

public CompletableFuture<UpdateByQueryResponse> updateByQuery(UpdateByQueryRequest request)

Update documents. Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.

See Also:

• Documentation on elastic.co

updateByQuery

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

Update documents. Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.

Parameters:

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

See Also:

• Documentation on elastic.co

updateByQueryRethrottle

public CompletableFuture<UpdateByQueryRethrottleResponse> updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)

Throttle an update by query operation.

Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

See Also:

• Documentation on elastic.co

updateByQueryRethrottle

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

Throttle an update by query operation.

Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

Parameters:

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

See Also:

• Documentation on elastic.co