Package co.elastic.clients.elasticsearch

Class ElasticsearchClient

java.lang.Object

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

co.elastic.clients.elasticsearch.ElasticsearchClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchClient
extends ApiClient<ElasticsearchTransport,ElasticsearchClient>

Client for the namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ElasticsearchAsyncSearchClient	asyncSearch()
ElasticsearchAutoscalingClient	autoscaling()
BulkResponse	bulk()	Bulk index or delete documents.
BulkResponse	bulk(BulkRequest request)	Bulk index or delete documents.
final BulkResponse	bulk(Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)	Bulk index or delete documents.
ElasticsearchCatClient	cat()
ElasticsearchCcrClient	ccr()
ClearScrollResponse	clearScroll()	Clear a scrolling search.
ClearScrollResponse	clearScroll(ClearScrollRequest request)	Clear a scrolling search.
final ClearScrollResponse	clearScroll(Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)	Clear a scrolling search.
ClosePointInTimeResponse	closePointInTime(ClosePointInTimeRequest request)	Close a point in time.
final ClosePointInTimeResponse	closePointInTime(Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn)	Close a point in time.
ElasticsearchClusterClient	cluster()
ElasticsearchConnectorClient	connector()
CountResponse	count()	Returns number of documents matching a query.
CountResponse	count(CountRequest request)	Returns number of documents matching a query.
final CountResponse	count(Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Returns number of documents matching a query.
<TDocument> CreateResponse	create(CreateRequest<TDocument> request)	Index a document.
final <TDocument> CreateResponse	create(Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)	Index a document.
ElasticsearchDanglingIndicesClient	danglingIndices()
DeleteResponse	delete(DeleteRequest request)	Delete a document.
final DeleteResponse	delete(Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)	Delete a document.
DeleteByQueryResponse	deleteByQuery(DeleteByQueryRequest request)	Delete documents.
final DeleteByQueryResponse	deleteByQuery(Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)	Delete documents.
DeleteByQueryRethrottleResponse	deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)	Throttle a delete by query operation.
final DeleteByQueryRethrottleResponse	deleteByQueryRethrottle(Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn)	Throttle a delete by query operation.
DeleteScriptResponse	deleteScript(DeleteScriptRequest request)	Delete a script or search template.
final DeleteScriptResponse	deleteScript(Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)	Delete a script or search template.
ElasticsearchEnrichClient	enrich()
ElasticsearchEqlClient	eql()
ElasticsearchEsqlClient	esql()
BooleanResponse	exists(ExistsRequest request)	Check a document.
final BooleanResponse	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Check a document.
BooleanResponse	existsSource(ExistsSourceRequest request)	Check for a document source.
final BooleanResponse	existsSource(Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)	Check for a document source.
<TDocument> ExplainResponse<TDocument>	explain(ExplainRequest request, Class<TDocument> tDocumentClass)	Explain a document match result.
<TDocument> ExplainResponse<TDocument>	explain(ExplainRequest request, Type tDocumentType)	Explain a document match result.
final <TDocument> ExplainResponse<TDocument>	explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, Class<TDocument> tDocumentClass)	Explain a document match result.
final <TDocument> ExplainResponse<TDocument>	explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, Type tDocumentType)	Explain a document match result.
ElasticsearchFeaturesClient	features()
FieldCapsResponse	fieldCaps()	Get the field capabilities.
FieldCapsResponse	fieldCaps(FieldCapsRequest request)	Get the field capabilities.
final FieldCapsResponse	fieldCaps(Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)	Get the field capabilities.
ElasticsearchFleetClient	fleet()
<TDocument> GetResponse<TDocument>	get(GetRequest request, Class<TDocument> tDocumentClass)	Get a document by its ID.
<TDocument> GetResponse<TDocument>	get(GetRequest request, Type tDocumentType)	Get a document by its ID.
final <TDocument> GetResponse<TDocument>	get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, Class<TDocument> tDocumentClass)	Get a document by its ID.
final <TDocument> GetResponse<TDocument>	get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, Type tDocumentType)	Get a document by its ID.
GetScriptResponse	getScript(GetScriptRequest request)	Get a script or search template.
final GetScriptResponse	getScript(Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)	Get a script or search template.
GetScriptContextResponse	getScriptContext()	Get script contexts.
GetScriptLanguagesResponse	getScriptLanguages()	Get script languages.
<TDocument> GetSourceResponse<TDocument>	getSource(GetSourceRequest request, Class<TDocument> tDocumentClass)	Get a document's source.
<TDocument> GetSourceResponse<TDocument>	getSource(GetSourceRequest request, Type tDocumentType)	Get a document's source.
final <TDocument> GetSourceResponse<TDocument>	getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, Class<TDocument> tDocumentClass)	Get a document's source.
final <TDocument> GetSourceResponse<TDocument>	getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, Type tDocumentType)	Get a document's source.
ElasticsearchGraphClient	graph()
HealthReportResponse	healthReport()	Returns the health of the cluster.
HealthReportResponse	healthReport(HealthReportRequest request)	Returns the health of the cluster.
final HealthReportResponse	healthReport(Function<HealthReportRequest.Builder,ObjectBuilder<HealthReportRequest>> fn)	Returns the health of the cluster.
ElasticsearchIlmClient	ilm()
<TDocument> IndexResponse	index(IndexRequest<TDocument> request)	Index a document.
final <TDocument> IndexResponse	index(Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)	Index a document.
ElasticsearchIndicesClient	indices()
ElasticsearchInferenceClient	inference()
InfoResponse	info()	Get cluster info.
ElasticsearchIngestClient	ingest()
<TDocument> KnnSearchResponse<TDocument>	knnSearch(KnnSearchRequest request, Class<TDocument> tDocumentClass)	Run a knn search.
<TDocument> KnnSearchResponse<TDocument>	knnSearch(KnnSearchRequest request, Type tDocumentType)	Run a knn search.
final <TDocument> KnnSearchResponse<TDocument>	knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn, Class<TDocument> tDocumentClass)	Run a knn search.
final <TDocument> KnnSearchResponse<TDocument>	knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn, Type tDocumentType)	Run a knn search.
ElasticsearchLicenseClient	license()
ElasticsearchLogstashClient	logstash()
<TDocument> MgetResponse<TDocument>	mget(MgetRequest request, Class<TDocument> tDocumentClass)	Get multiple documents.
<TDocument> MgetResponse<TDocument>	mget(MgetRequest request, Type tDocumentType)	Get multiple documents.
final <TDocument> MgetResponse<TDocument>	mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, Class<TDocument> tDocumentClass)	Get multiple documents.
final <TDocument> MgetResponse<TDocument>	mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, Type tDocumentType)	Get multiple documents.
ElasticsearchMigrationClient	migration()
ElasticsearchMlClient	ml()
ElasticsearchMonitoringClient	monitoring()
<TDocument> MsearchResponse<TDocument>	msearch(MsearchRequest request, Class<TDocument> tDocumentClass)	Run multiple searches.
<TDocument> MsearchResponse<TDocument>	msearch(MsearchRequest request, Type tDocumentType)	Run multiple searches.
final <TDocument> MsearchResponse<TDocument>	msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, Class<TDocument> tDocumentClass)	Run multiple searches.
final <TDocument> MsearchResponse<TDocument>	msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, Type tDocumentType)	Run multiple searches.
<TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(MsearchTemplateRequest request, Class<TDocument> tDocumentClass)	Run multiple templated searches.
<TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(MsearchTemplateRequest request, Type tDocumentType)	Run multiple templated searches.
final <TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Run multiple templated searches.
final <TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, Type tDocumentType)	Run multiple templated searches.
MtermvectorsResponse	mtermvectors()	Get multiple term vectors.
MtermvectorsResponse	mtermvectors(MtermvectorsRequest request)	Get multiple term vectors.
final MtermvectorsResponse	mtermvectors(Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)	Get multiple term vectors.
ElasticsearchNodesClient	nodes()
OpenPointInTimeResponse	openPointInTime(OpenPointInTimeRequest request)	Open a point in time.
final OpenPointInTimeResponse	openPointInTime(Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)	Open a point in time.
BooleanResponse	ping()	Ping the cluster.
PutScriptResponse	putScript(PutScriptRequest request)	Create or update a script or search template.
final PutScriptResponse	putScript(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)	Create or update a script or search template.
ElasticsearchQueryRulesClient	queryRules()
RankEvalResponse	rankEval(RankEvalRequest request)	Evaluate ranked search results.
final RankEvalResponse	rankEval(Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)	Evaluate ranked search results.
ReindexResponse	reindex(ReindexRequest request)	Reindex documents.
final ReindexResponse	reindex(Function<ReindexRequest.Builder,ObjectBuilder<ReindexRequest>> fn)	Reindex documents.
ReindexRethrottleResponse	reindexRethrottle(ReindexRethrottleRequest request)	Throttle a reindex operation.
final ReindexRethrottleResponse	reindexRethrottle(Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)	Throttle a reindex operation.
RenderSearchTemplateResponse	renderSearchTemplate()	Render a search template.
RenderSearchTemplateResponse	renderSearchTemplate(RenderSearchTemplateRequest request)	Render a search template.
final RenderSearchTemplateResponse	renderSearchTemplate(Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)	Render a search template.
ElasticsearchRollupClient	rollup()
<TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, Class<TResult> tResultClass)	Run a script.
<TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, Type tResultType)	Run a script.
final <TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, Class<TResult> tResultClass)	Run a script.
final <TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, Type tResultType)	Run a script.
<TDocument> ScrollResponse<TDocument>	scroll(ScrollRequest request, Class<TDocument> tDocumentClass)	Run a scrolling search.
<TDocument> ScrollResponse<TDocument>	scroll(ScrollRequest request, Type tDocumentType)	Run a scrolling search.
final <TDocument> ScrollResponse<TDocument>	scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, Class<TDocument> tDocumentClass)	Run a scrolling search.
final <TDocument> ScrollResponse<TDocument>	scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, Type tDocumentType)	Run a scrolling search.
<TDocument> SearchResponse<TDocument>	search(SearchRequest request, Class<TDocument> tDocumentClass)	Run a search.
<TDocument> SearchResponse<TDocument>	search(SearchRequest request, Type tDocumentType)	Run a search.
final <TDocument> SearchResponse<TDocument>	search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, Class<TDocument> tDocumentClass)	Run a search.
final <TDocument> SearchResponse<TDocument>	search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, Type tDocumentType)	Run a search.
ElasticsearchSearchableSnapshotsClient	searchableSnapshots()
ElasticsearchSearchApplicationClient	searchApplication()
BinaryResponse	searchMvt(SearchMvtRequest request)	Search a vector tile.
final BinaryResponse	searchMvt(Function<SearchMvtRequest.Builder,ObjectBuilder<SearchMvtRequest>> fn)	Search a vector tile.
SearchShardsResponse	searchShards()	Get the search shards.
SearchShardsResponse	searchShards(SearchShardsRequest request)	Get the search shards.
final SearchShardsResponse	searchShards(Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)	Get the search shards.
<TDocument> SearchTemplateResponse<TDocument>	searchTemplate(SearchTemplateRequest request, Class<TDocument> tDocumentClass)	Run a search with a search template.
<TDocument> SearchTemplateResponse<TDocument>	searchTemplate(SearchTemplateRequest request, Type tDocumentType)	Run a search with a search template.
final <TDocument> SearchTemplateResponse<TDocument>	searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Run a search with a search template.
final <TDocument> SearchTemplateResponse<TDocument>	searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, Type tDocumentType)	Run a search with a search template.
ElasticsearchSecurityClient	security()
ElasticsearchShutdownClient	shutdown()
ElasticsearchSlmClient	slm()
ElasticsearchSnapshotClient	snapshot()
ElasticsearchSqlClient	sql()
ElasticsearchSslClient	ssl()
ElasticsearchSynonymsClient	synonyms()
ElasticsearchTasksClient	tasks()
TermsEnumResponse	termsEnum(TermsEnumRequest request)	Get terms in an index.
final TermsEnumResponse	termsEnum(Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)	Get terms in an index.
<TDocument> TermvectorsResponse	termvectors(TermvectorsRequest<TDocument> request)	Get term vector information.
final <TDocument> TermvectorsResponse	termvectors(Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)	Get term vector information.
ElasticsearchTextStructureClient	textStructure()
ElasticsearchTransformClient	transform()
<TDocument, TPartialDocument> UpdateResponse<TDocument>	update(UpdateRequest<TDocument,TPartialDocument> request, Class<TDocument> tDocumentClass)	Update a document.
<TDocument, TPartialDocument> UpdateResponse<TDocument>	update(UpdateRequest<TDocument,TPartialDocument> request, Type tDocumentType)	Update a document.
final <TDocument, TPartialDocument> UpdateResponse<TDocument>	update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, Class<TDocument> tDocumentClass)	Update a document.
final <TDocument, TPartialDocument> UpdateResponse<TDocument>	update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, Type tDocumentType)	Update a document.
UpdateByQueryResponse	updateByQuery(UpdateByQueryRequest request)	Update documents.
final UpdateByQueryResponse	updateByQuery(Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn)	Update documents.
UpdateByQueryRethrottleResponse	updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)	Throttle an update by query operation.
final UpdateByQueryRethrottleResponse	updateByQueryRethrottle(Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)	Throttle an update by query operation.
ElasticsearchWatcherClient	watcher()
ElasticsearchClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options
ElasticsearchXpackClient	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

ElasticsearchClient

public ElasticsearchClient(ElasticsearchTransport transport)

ElasticsearchClient

public ElasticsearchClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchClient>

asyncSearch

public ElasticsearchAsyncSearchClient asyncSearch()

autoscaling

public ElasticsearchAutoscalingClient autoscaling()

cat

public ElasticsearchCatClient cat()

ccr

public ElasticsearchCcrClient ccr()

cluster

public ElasticsearchClusterClient cluster()

connector

public ElasticsearchConnectorClient connector()

danglingIndices

public ElasticsearchDanglingIndicesClient danglingIndices()

enrich

public ElasticsearchEnrichClient enrich()

eql

public ElasticsearchEqlClient eql()

esql

public ElasticsearchEsqlClient esql()

features

public ElasticsearchFeaturesClient features()

fleet

public ElasticsearchFleetClient fleet()

graph

public ElasticsearchGraphClient graph()

ilm

public ElasticsearchIlmClient ilm()

indices

public ElasticsearchIndicesClient indices()

inference

public ElasticsearchInferenceClient inference()

ingest

public ElasticsearchIngestClient ingest()

license

public ElasticsearchLicenseClient license()

logstash

public ElasticsearchLogstashClient logstash()

migration

public ElasticsearchMigrationClient migration()

ml

public ElasticsearchMlClient ml()

monitoring

public ElasticsearchMonitoringClient monitoring()

nodes

public ElasticsearchNodesClient nodes()

queryRules

public ElasticsearchQueryRulesClient queryRules()

rollup

public ElasticsearchRollupClient rollup()

searchApplication

public ElasticsearchSearchApplicationClient searchApplication()

searchableSnapshots

public ElasticsearchSearchableSnapshotsClient searchableSnapshots()

security

public ElasticsearchSecurityClient security()

shutdown

public ElasticsearchShutdownClient shutdown()

slm

public ElasticsearchSlmClient slm()

snapshot

public ElasticsearchSnapshotClient snapshot()

sql

public ElasticsearchSqlClient sql()

ssl

public ElasticsearchSslClient ssl()

synonyms

public ElasticsearchSynonymsClient synonyms()

tasks

public ElasticsearchTasksClient tasks()

textStructure

public ElasticsearchTextStructureClient textStructure()

transform

public ElasticsearchTransformClient transform()

watcher

public ElasticsearchWatcherClient watcher()

xpack

public ElasticsearchXpackClient xpack()

bulk

public BulkResponse bulk(BulkRequest request)
                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

bulk

public final BulkResponse bulk(Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

bulk

public BulkResponse bulk()
                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearScroll

public ClearScrollResponse clearScroll(ClearScrollRequest request)
                                throws IOException,
ElasticsearchException

Clear a scrolling search.

Clear the search context and results for a scrolling search.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearScroll

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearScroll

public ClearScrollResponse clearScroll()
                                throws IOException,
ElasticsearchException

Clear a scrolling search.

Clear the search context and results for a scrolling search.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

closePointInTime

public ClosePointInTimeResponse closePointInTime(ClosePointInTimeRequest request)
                                          throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

closePointInTime

public final ClosePointInTimeResponse closePointInTime(Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn)
                                                throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

public CountResponse count(CountRequest request)
                    throws IOException,
ElasticsearchException

Returns number of documents matching a query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

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

Returns number of documents matching a query.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

count

public CountResponse count()
                    throws IOException,
ElasticsearchException

Returns number of documents matching a query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

create

public <TDocument> CreateResponse create(CreateRequest<TDocument> request)
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

create

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public DeleteResponse delete(DeleteRequest request)
                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteByQuery

public DeleteByQueryResponse deleteByQuery(DeleteByQueryRequest request)
                                    throws IOException,
ElasticsearchException

Delete documents. Deletes documents that match the specified query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteByQuery

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

Delete documents. Deletes documents that match the specified query.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteByQueryRethrottle

public DeleteByQueryRethrottleResponse deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)
                                                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteByQueryRethrottle

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteScript

public DeleteScriptResponse deleteScript(DeleteScriptRequest request)
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteScript

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

exists

public BooleanResponse exists(ExistsRequest request)
                       throws IOException,
ElasticsearchException

Check a document. Checks if a specified document exists.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

exists

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

Check a document. Checks if a specified document exists.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsSource

public BooleanResponse existsSource(ExistsSourceRequest request)
                             throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsSource

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explain

public <TDocument> ExplainResponse<TDocument> explain(ExplainRequest request,
 Class<TDocument> tDocumentClass)
                                               throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explain

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explain

public <TDocument> ExplainResponse<TDocument> explain(ExplainRequest request,
 Type tDocumentType)
                                               throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

explain

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fieldCaps

public FieldCapsResponse fieldCaps(FieldCapsRequest request)
                            throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fieldCaps

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fieldCaps

public FieldCapsResponse fieldCaps()
                            throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public <TDocument> GetResponse<TDocument> get(GetRequest request,
 Class<TDocument> tDocumentClass)
                                       throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public <TDocument> GetResponse<TDocument> get(GetRequest request,
 Type tDocumentType)
                                       throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getScript

public GetScriptResponse getScript(GetScriptRequest request)
                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getScript

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getScriptContext

public GetScriptContextResponse getScriptContext()
                                          throws IOException,
ElasticsearchException

Get script contexts.

Get a list of supported script contexts and their methods.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getScriptLanguages

public GetScriptLanguagesResponse getScriptLanguages()
                                              throws IOException,
ElasticsearchException

Get script languages.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSource

public <TDocument> GetSourceResponse<TDocument> getSource(GetSourceRequest request,
 Class<TDocument> tDocumentClass)
                                                   throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSource

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSource

public <TDocument> GetSourceResponse<TDocument> getSource(GetSourceRequest request,
 Type tDocumentType)
                                                   throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSource

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

healthReport

public HealthReportResponse healthReport(HealthReportRequest request)
                                  throws IOException,
ElasticsearchException

Returns the health of the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

healthReport

public final HealthReportResponse healthReport(Function<HealthReportRequest.Builder,ObjectBuilder<HealthReportRequest>> fn)
                                        throws IOException,
ElasticsearchException

Returns the health of the cluster.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

healthReport

public HealthReportResponse healthReport()
                                  throws IOException,
ElasticsearchException

Returns the health of the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

index

public <TDocument> IndexResponse index(IndexRequest<TDocument> request)
                                throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

index

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

public InfoResponse info()
                  throws IOException,
ElasticsearchException

Get cluster info. Returns basic information about the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

knnSearch

public <TDocument> KnnSearchResponse<TDocument> knnSearch(KnnSearchRequest request,
 Class<TDocument> tDocumentClass)
                                                   throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

knnSearch

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

knnSearch

public <TDocument> KnnSearchResponse<TDocument> knnSearch(KnnSearchRequest request,
 Type tDocumentType)
                                                   throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

knnSearch

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mget

public <TDocument> MgetResponse<TDocument> mget(MgetRequest request,
 Class<TDocument> tDocumentClass)
                                         throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mget

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mget

public <TDocument> MgetResponse<TDocument> mget(MgetRequest request,
 Type tDocumentType)
                                         throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mget

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

msearch

public <TDocument> MsearchResponse<TDocument> msearch(MsearchRequest request,
 Class<TDocument> tDocumentClass)
                                               throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

msearch

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

msearch

public <TDocument> MsearchResponse<TDocument> msearch(MsearchRequest request,
 Type tDocumentType)
                                               throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

msearch

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

msearchTemplate

public <TDocument>
MsearchTemplateResponse<TDocument> msearchTemplate(MsearchTemplateRequest request,
 Class<TDocument> tDocumentClass)
                                            throws IOException,
ElasticsearchException

Run multiple templated searches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

msearchTemplate

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

Run multiple templated searches.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

msearchTemplate

public <TDocument>
MsearchTemplateResponse<TDocument> msearchTemplate(MsearchTemplateRequest request,
 Type tDocumentType)
                                            throws IOException,
ElasticsearchException

Run multiple templated searches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

msearchTemplate

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

Run multiple templated searches.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mtermvectors

public MtermvectorsResponse mtermvectors(MtermvectorsRequest request)
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mtermvectors

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mtermvectors

public MtermvectorsResponse mtermvectors()
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

openPointInTime

public OpenPointInTimeResponse openPointInTime(OpenPointInTimeRequest request)
                                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

openPointInTime

public final OpenPointInTimeResponse openPointInTime(Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)
                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

ping

public BooleanResponse ping()
                     throws IOException,
ElasticsearchException

Ping the cluster. Returns whether the cluster is running.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putScript

public PutScriptResponse putScript(PutScriptRequest request)
                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putScript

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rankEval

public RankEvalResponse rankEval(RankEvalRequest request)
                          throws IOException,
ElasticsearchException

Evaluate ranked search results.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

rankEval

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reindex

public ReindexResponse reindex(ReindexRequest request)
                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reindex

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reindexRethrottle

public ReindexRethrottleResponse reindexRethrottle(ReindexRethrottleRequest request)
                                            throws IOException,
ElasticsearchException

Throttle a reindex operation.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reindexRethrottle

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

renderSearchTemplate

public RenderSearchTemplateResponse renderSearchTemplate(RenderSearchTemplateRequest request)
                                                  throws IOException,
ElasticsearchException

Render a search template.

Render a search template as a search request body.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

renderSearchTemplate

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

renderSearchTemplate

public RenderSearchTemplateResponse renderSearchTemplate()
                                                  throws IOException,
ElasticsearchException

Render a search template.

Render a search template as a search request body.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

public <TResult>
ScriptsPainlessExecuteResponse<TResult> scriptsPainlessExecute(ScriptsPainlessExecuteRequest request,
 Class<TResult> tResultClass)
                                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

public <TResult>
ScriptsPainlessExecuteResponse<TResult> scriptsPainlessExecute(ScriptsPainlessExecuteRequest request,
 Type tResultType)
                                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scroll

public <TDocument> ScrollResponse<TDocument> scroll(ScrollRequest request,
 Class<TDocument> tDocumentClass)
                                             throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scroll

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scroll

public <TDocument> ScrollResponse<TDocument> scroll(ScrollRequest request,
 Type tDocumentType)
                                             throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scroll

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

public <TDocument> SearchResponse<TDocument> search(SearchRequest request,
 Class<TDocument> tDocumentClass)
                                             throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

public <TDocument> SearchResponse<TDocument> search(SearchRequest request,
 Type tDocumentType)
                                             throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

search

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchMvt

public BinaryResponse searchMvt(SearchMvtRequest request)
                         throws IOException,
ElasticsearchException

Search a vector tile.

Search a vector tile for geospatial values.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchMvt

public final BinaryResponse searchMvt(Function<SearchMvtRequest.Builder,ObjectBuilder<SearchMvtRequest>> fn)
                               throws IOException,
ElasticsearchException

Search a vector tile.

Search a vector tile for geospatial values.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchShards

public SearchShardsResponse searchShards(SearchShardsRequest request)
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchShards

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchShards

public SearchShardsResponse searchShards()
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchTemplate

public <TDocument>
SearchTemplateResponse<TDocument> searchTemplate(SearchTemplateRequest request,
 Class<TDocument> tDocumentClass)
                                          throws IOException,
ElasticsearchException

Run a search with a search template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchTemplate

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

Run a search with a search template.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchTemplate

public <TDocument>
SearchTemplateResponse<TDocument> searchTemplate(SearchTemplateRequest request,
 Type tDocumentType)
                                          throws IOException,
ElasticsearchException

Run a search with a search template.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchTemplate

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

Run a search with a search template.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

termsEnum

public TermsEnumResponse termsEnum(TermsEnumRequest request)
                            throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

termsEnum

public final TermsEnumResponse termsEnum(Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)
                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

termvectors

public <TDocument> TermvectorsResponse termvectors(TermvectorsRequest<TDocument> request)
                                            throws IOException,
ElasticsearchException

Get term vector information.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

termvectors

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

update

public <TDocument,
TPartialDocument>
UpdateResponse<TDocument> update(UpdateRequest<TDocument,TPartialDocument> request,
 Class<TDocument> tDocumentClass)
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

update

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

update

public <TDocument,
TPartialDocument>
UpdateResponse<TDocument> update(UpdateRequest<TDocument,TPartialDocument> request,
 Type tDocumentType)
                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

update

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateByQuery

public UpdateByQueryResponse updateByQuery(UpdateByQueryRequest request)
                                    throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateByQuery

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateByQueryRethrottle

public UpdateByQueryRethrottleResponse updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)
                                                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateByQueryRethrottle

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co