Package co.elastic.clients.elasticsearch

Class ElasticsearchClient

java.lang.Object

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

co.elastic.clients.elasticsearch.ElasticsearchClient

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()	Performs multiple indexing or delete operations in a single API call.
BulkResponse	bulk(BulkRequest request)	Performs multiple indexing or delete operations in a single API call.
final BulkResponse	bulk(Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)	Performs multiple indexing or delete operations in a single API call.
ElasticsearchCatClient	cat()
ElasticsearchCcrClient	ccr()
ClearScrollResponse	clearScroll()	Clears the search context and results for a scrolling search.
ClearScrollResponse	clearScroll(ClearScrollRequest request)	Clears the search context and results for a scrolling search.
final ClearScrollResponse	clearScroll(Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)	Clears the search context and results for a scrolling search.
ClosePointInTimeResponse	closePointInTime(ClosePointInTimeRequest request)	Closes a point-in-time.
final ClosePointInTimeResponse	closePointInTime(Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn)	Closes 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)	Adds a JSON document to the specified data stream or index and makes it searchable.
final <TDocument> CreateResponse	create(Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)	Adds a JSON document to the specified data stream or index and makes it searchable.
ElasticsearchDanglingIndicesClient	danglingIndices()
DeleteResponse	delete(DeleteRequest request)	Removes a JSON document from the specified index.
final DeleteResponse	delete(Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)	Removes a JSON document from the specified index.
DeleteByQueryResponse	deleteByQuery(DeleteByQueryRequest request)	Deletes documents that match the specified query.
final DeleteByQueryResponse	deleteByQuery(Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)	Deletes documents that match the specified query.
DeleteByQueryRethrottleResponse	deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)	Changes the number of requests per second for a particular Delete By Query operation.
final DeleteByQueryRethrottleResponse	deleteByQueryRethrottle(Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn)	Changes the number of requests per second for a particular Delete By Query operation.
DeleteScriptResponse	deleteScript(DeleteScriptRequest request)	Deletes a stored script or search template.
final DeleteScriptResponse	deleteScript(Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)	Deletes a stored script or search template.
ElasticsearchEnrichClient	enrich()
ElasticsearchEqlClient	eql()
ElasticsearchEsqlClient	esql()
BooleanResponse	exists(ExistsRequest request)	Checks if a document in an index exists.
final BooleanResponse	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Checks if a document in an index exists.
BooleanResponse	existsSource(ExistsSourceRequest request)	Checks if a document's _source is stored.
final BooleanResponse	existsSource(Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)	Checks if a document's _source is stored.
<TDocument> ExplainResponse<TDocument>	explain(ExplainRequest request, Class<TDocument> tDocumentClass)	Returns information about why a specific document matches (or doesn’t match) a query.
<TDocument> ExplainResponse<TDocument>	explain(ExplainRequest request, Type tDocumentType)	Returns information about why a specific document matches (or doesn’t match) a query.
final <TDocument> ExplainResponse<TDocument>	explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, Class<TDocument> tDocumentClass)	Returns information about why a specific document matches (or doesn’t match) a query.
final <TDocument> ExplainResponse<TDocument>	explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, Type tDocumentType)	Returns information about why a specific document matches (or doesn’t match) a query.
ElasticsearchFeaturesClient	features()
FieldCapsResponse	fieldCaps()	The field capabilities API returns the information about the capabilities of fields among multiple indices.
FieldCapsResponse	fieldCaps(FieldCapsRequest request)	The field capabilities API returns the information about the capabilities of fields among multiple indices.
final FieldCapsResponse	fieldCaps(Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)	The field capabilities API returns the information about the capabilities of fields among multiple indices.
ElasticsearchFleetClient	fleet()
<TDocument> GetResponse<TDocument>	get(GetRequest request, Class<TDocument> tDocumentClass)	Returns a document.
<TDocument> GetResponse<TDocument>	get(GetRequest request, Type tDocumentType)	Returns a document.
final <TDocument> GetResponse<TDocument>	get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, Class<TDocument> tDocumentClass)	Returns a document.
final <TDocument> GetResponse<TDocument>	get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, Type tDocumentType)	Returns a document.
GetScriptResponse	getScript(GetScriptRequest request)	Retrieves a stored script or search template.
final GetScriptResponse	getScript(Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)	Retrieves a stored script or search template.
GetScriptContextResponse	getScriptContext()	Returns all script contexts.
GetScriptLanguagesResponse	getScriptLanguages()	Returns available script types, languages and contexts
<TDocument> GetSourceResponse<TDocument>	getSource(GetSourceRequest request, Class<TDocument> tDocumentClass)	Returns the source of a document.
<TDocument> GetSourceResponse<TDocument>	getSource(GetSourceRequest request, Type tDocumentType)	Returns the source of a document.
final <TDocument> GetSourceResponse<TDocument>	getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, Class<TDocument> tDocumentClass)	Returns the source of a document.
final <TDocument> GetSourceResponse<TDocument>	getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, Type tDocumentType)	Returns the source of a document.
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)	Adds a JSON document to the specified data stream or index and makes it searchable.
final <TDocument> IndexResponse	index(Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)	Adds a JSON document to the specified data stream or index and makes it searchable.
ElasticsearchIndicesClient	indices()
ElasticsearchInferenceClient	inference()
InfoResponse	info()	Returns basic information about the cluster.
ElasticsearchIngestClient	ingest()
<TDocument> KnnSearchResponse<TDocument>	knnSearch(KnnSearchRequest request, Class<TDocument> tDocumentClass)	Performs a kNN search.
<TDocument> KnnSearchResponse<TDocument>	knnSearch(KnnSearchRequest request, Type tDocumentType)	Performs a kNN search.
final <TDocument> KnnSearchResponse<TDocument>	knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn, Class<TDocument> tDocumentClass)	Performs a kNN search.
final <TDocument> KnnSearchResponse<TDocument>	knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn, Type tDocumentType)	Performs a kNN search.
ElasticsearchLicenseClient	license()
ElasticsearchLogstashClient	logstash()
<TDocument> MgetResponse<TDocument>	mget(MgetRequest request, Class<TDocument> tDocumentClass)	Allows to get multiple documents in one request.
<TDocument> MgetResponse<TDocument>	mget(MgetRequest request, Type tDocumentType)	Allows to get multiple documents in one request.
final <TDocument> MgetResponse<TDocument>	mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, Class<TDocument> tDocumentClass)	Allows to get multiple documents in one request.
final <TDocument> MgetResponse<TDocument>	mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, Type tDocumentType)	Allows to get multiple documents in one request.
ElasticsearchMigrationClient	migration()
ElasticsearchMlClient	ml()
ElasticsearchMonitoringClient	monitoring()
<TDocument> MsearchResponse<TDocument>	msearch(MsearchRequest request, Class<TDocument> tDocumentClass)	Allows to execute several search operations in one request.
<TDocument> MsearchResponse<TDocument>	msearch(MsearchRequest request, Type tDocumentType)	Allows to execute several search operations in one request.
final <TDocument> MsearchResponse<TDocument>	msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, Class<TDocument> tDocumentClass)	Allows to execute several search operations in one request.
final <TDocument> MsearchResponse<TDocument>	msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, Type tDocumentType)	Allows to execute several search operations in one request.
<TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(MsearchTemplateRequest request, Class<TDocument> tDocumentClass)	Runs multiple templated searches with a single request.
<TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(MsearchTemplateRequest request, Type tDocumentType)	Runs multiple templated searches with a single request.
final <TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Runs multiple templated searches with a single request.
final <TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, Type tDocumentType)	Runs multiple templated searches with a single request.
MtermvectorsResponse	mtermvectors()	Returns multiple termvectors in one request.
MtermvectorsResponse	mtermvectors(MtermvectorsRequest request)	Returns multiple termvectors in one request.
final MtermvectorsResponse	mtermvectors(Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)	Returns multiple termvectors in one request.
ElasticsearchNodesClient	nodes()
OpenPointInTimeResponse	openPointInTime(OpenPointInTimeRequest request)	A search request by default executes against the most recent visible data of the target indices, which is called point in time.
final OpenPointInTimeResponse	openPointInTime(Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)	A search request by default executes against the most recent visible data of the target indices, which is called point in time.
BooleanResponse	ping()	Returns whether the cluster is running.
PutScriptResponse	putScript(PutScriptRequest request)	Creates or updates a stored script or search template.
final PutScriptResponse	putScript(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)	Creates or updates a stored script or search template.
ElasticsearchQueryRulesClient	queryRules()
RankEvalResponse	rankEval(RankEvalRequest request)	Enables you to evaluate the quality of ranked search results over a set of typical search queries.
final RankEvalResponse	rankEval(Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)	Enables you to evaluate the quality of ranked search results over a set of typical search queries.
ReindexResponse	reindex(ReindexRequest request)	Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
final ReindexResponse	reindex(Function<ReindexRequest.Builder,ObjectBuilder<ReindexRequest>> fn)	Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
ReindexRethrottleResponse	reindexRethrottle(ReindexRethrottleRequest request)	Copies documents from a source to a destination.
final ReindexRethrottleResponse	reindexRethrottle(Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)	Copies documents from a source to a destination.
RenderSearchTemplateResponse	renderSearchTemplate()	Renders a search template as a search request body.
RenderSearchTemplateResponse	renderSearchTemplate(RenderSearchTemplateRequest request)	Renders a search template as a search request body.
final RenderSearchTemplateResponse	renderSearchTemplate(Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)	Renders a search template as a search request body.
ElasticsearchRollupClient	rollup()
<TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, Class<TResult> tResultClass)	Runs a script and returns a result.
<TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, Type tResultType)	Runs a script and returns a result.
final <TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, Class<TResult> tResultClass)	Runs a script and returns a result.
final <TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, Type tResultType)	Runs a script and returns a result.
<TDocument> ScrollResponse<TDocument>	scroll(ScrollRequest request, Class<TDocument> tDocumentClass)	Allows to retrieve a large numbers of results from a single search request.
<TDocument> ScrollResponse<TDocument>	scroll(ScrollRequest request, Type tDocumentType)	Allows to retrieve a large numbers of results from a single search request.
final <TDocument> ScrollResponse<TDocument>	scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, Class<TDocument> tDocumentClass)	Allows to retrieve a large numbers of results from a single search request.
final <TDocument> ScrollResponse<TDocument>	scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, Type tDocumentType)	Allows to retrieve a large numbers of results from a single search request.
<TDocument> SearchResponse<TDocument>	search(SearchRequest request, Class<TDocument> tDocumentClass)	Returns search hits that match the query defined in the request.
<TDocument> SearchResponse<TDocument>	search(SearchRequest request, Type tDocumentType)	Returns search hits that match the query defined in the request.
final <TDocument> SearchResponse<TDocument>	search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, Class<TDocument> tDocumentClass)	Returns search hits that match the query defined in the request.
final <TDocument> SearchResponse<TDocument>	search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, Type tDocumentType)	Returns search hits that match the query defined in the request.
ElasticsearchSearchableSnapshotsClient	searchableSnapshots()
ElasticsearchSearchApplicationClient	searchApplication()
BinaryResponse	searchMvt(SearchMvtRequest request)	Searches a vector tile for geospatial values.
final BinaryResponse	searchMvt(Function<SearchMvtRequest.Builder,ObjectBuilder<SearchMvtRequest>> fn)	Searches a vector tile for geospatial values.
SearchShardsResponse	searchShards()	Returns information about the indices and shards that a search request would be executed against.
SearchShardsResponse	searchShards(SearchShardsRequest request)	Returns information about the indices and shards that a search request would be executed against.
final SearchShardsResponse	searchShards(Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)	Returns information about the indices and shards that a search request would be executed against.
<TDocument> SearchTemplateResponse<TDocument>	searchTemplate(SearchTemplateRequest request, Class<TDocument> tDocumentClass)	Runs a search with a search template.
<TDocument> SearchTemplateResponse<TDocument>	searchTemplate(SearchTemplateRequest request, Type tDocumentType)	Runs a search with a search template.
final <TDocument> SearchTemplateResponse<TDocument>	searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Runs a search with a search template.
final <TDocument> SearchTemplateResponse<TDocument>	searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, Type tDocumentType)	Runs 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)	The terms enum API can be used to discover terms in the index that begin with the provided string.
final TermsEnumResponse	termsEnum(Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)	The terms enum API can be used to discover terms in the index that begin with the provided string.
<TDocument> TermvectorsResponse	termvectors(TermvectorsRequest<TDocument> request)	Returns information and statistics about terms in the fields of a particular document.
final <TDocument> TermvectorsResponse	termvectors(Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)	Returns information and statistics about terms in the fields of a particular document.
ElasticsearchTextStructureClient	textStructure()
ElasticsearchTransformClient	transform()
<TDocument, TPartialDocument> UpdateResponse<TDocument>	update(UpdateRequest<TDocument,TPartialDocument> request, Class<TDocument> tDocumentClass)	Updates a document with a script or partial document.
<TDocument, TPartialDocument> UpdateResponse<TDocument>	update(UpdateRequest<TDocument,TPartialDocument> request, Type tDocumentType)	Updates a document with a script or partial document.
final <TDocument, TPartialDocument> UpdateResponse<TDocument>	update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, Class<TDocument> tDocumentClass)	Updates a document with a script or partial document.
final <TDocument, TPartialDocument> UpdateResponse<TDocument>	update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, Type tDocumentType)	Updates a document with a script or partial document.
UpdateByQueryResponse	updateByQuery(UpdateByQueryRequest request)	Updates documents that match the specified query.
final UpdateByQueryResponse	updateByQuery(Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn)	Updates documents that match the specified query.
UpdateByQueryRethrottleResponse	updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)	Changes the number of requests per second for a particular Update By Query operation.
final UpdateByQueryRethrottleResponse	updateByQueryRethrottle(Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)	Changes the number of requests per second for a particular 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, 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

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

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

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

Clears 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

Clears 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

Clears 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

Closes a point-in-time.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

closePointInTime

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

Closes a point-in-time.

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

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

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

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

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

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

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteByQueryRethrottle

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteScript

public DeleteScriptResponse deleteScript(DeleteScriptRequest request)
                                  throws IOException,
ElasticsearchException

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

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

Checks if a document in an index exists.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

exists

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

Checks if a document in an index 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

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

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

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

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

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

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

The field capabilities API returns the information about the capabilities of fields among multiple indices. The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned 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

The field capabilities API returns the information about the capabilities of fields among multiple indices. The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned 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

The field capabilities API returns the information about the capabilities of fields among multiple indices. The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned 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

Returns a document.

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

Returns a document.

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

Returns a document.

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

Returns a document.

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

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

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

Returns all script contexts.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getScriptLanguages

public GetScriptLanguagesResponse getScriptLanguages()
                                              throws IOException,
ElasticsearchException

Returns 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

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

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

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

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

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

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

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

Performs a kNN search.

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

Performs a kNN search.

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

Performs a kNN search.

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

Performs a kNN search.

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

Allows to get multiple documents in one request.

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

Allows to get multiple documents in one request.

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

Allows to get multiple documents in one request.

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

Allows to get multiple documents in one request.

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

Allows to execute several search operations in one request.

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

Allows to execute several search operations in one request.

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

Allows to execute several search operations in one request.

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

Allows to execute several search operations in one request.

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

Runs multiple templated searches with a single request.

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

Runs multiple templated searches with a single request.

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

Runs multiple templated searches with a single request.

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

Runs multiple templated searches with a single request.

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

Returns multiple termvectors in one request.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

mtermvectors

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

Returns multiple termvectors in one request.

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

Returns multiple termvectors in one request.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

openPointInTime

public OpenPointInTimeResponse openPointInTime(OpenPointInTimeRequest request)
                                        throws IOException,
ElasticsearchException

A search request by default executes 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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

openPointInTime

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

A search request by default executes 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.

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

Returns whether the cluster is running.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putScript

public PutScriptResponse putScript(PutScriptRequest request)
                            throws IOException,
ElasticsearchException

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

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

Enables you to 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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reindex

public ReindexResponse reindex(ReindexRequest request)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reindex

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reindexRethrottle

public ReindexRethrottleResponse reindexRethrottle(ReindexRethrottleRequest request)
                                            throws IOException,
ElasticsearchException

Copies documents from a source to a destination.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reindexRethrottle

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

Copies documents from a source to a destination.

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

Renders 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

Renders 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

Renders 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

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

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

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

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

Allows to retrieve a large numbers of results from a single search request.

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

Allows to retrieve a large numbers of results from a single search request.

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

Allows to retrieve a large numbers of results from a single search request.

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

Allows to retrieve a large numbers of results from a single search request.

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

Returns 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

Returns 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

Returns 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

Returns 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

Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchMvt

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

Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchShards

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

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

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

searchTemplate

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

Runs 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

Runs 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

Runs 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

Runs 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

The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

termsEnum

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

The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.

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

Returns 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

Returns 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

Updates a document with a script or 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

Updates a document with a script or 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

Updates a document with a script or 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

Updates a document with a script or 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

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

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateByQueryRethrottle

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co