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()	Allows to perform multiple index/update/delete operations in a single request.
BulkResponse	bulk(BulkRequest request)	Allows to perform multiple index/update/delete operations in a single request.
final BulkResponse	bulk(Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)	Allows to perform multiple index/update/delete operations in a single request.
ElasticsearchCatClient	cat()
ElasticsearchCcrClient	ccr()
ClearScrollResponse	clearScroll()	Explicitly clears the search context for a scroll.
ClearScrollResponse	clearScroll(ClearScrollRequest request)	Explicitly clears the search context for a scroll.
final ClearScrollResponse	clearScroll(Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)	Explicitly clears the search context for a scroll.
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()
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)	Creates a new document in the index.
final <TDocument> CreateResponse	create(Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)	Creates a new document in the index.
ElasticsearchDanglingIndicesClient	danglingIndices()
DeleteResponse	delete(DeleteRequest request)	Removes a document from the index.
final DeleteResponse	delete(Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)	Removes a document from the index.
DeleteByQueryResponse	deleteByQuery(DeleteByQueryRequest request)	Deletes documents matching the provided query.
final DeleteByQueryResponse	deleteByQuery(Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)	Deletes documents matching the provided 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 script.
final DeleteScriptResponse	deleteScript(Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)	Deletes a script.
ElasticsearchEnrichClient	enrich()
ElasticsearchEqlClient	eql()
BooleanResponse	exists(ExistsRequest request)	Returns information about whether a document exists in an index.
final BooleanResponse	exists(Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Returns information about whether a document exists in an index.
BooleanResponse	existsSource(ExistsSourceRequest request)	Returns information about whether a document source exists in an index.
final BooleanResponse	existsSource(Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)	Returns information about whether a document source exists in an index.
<TDocument> ExplainResponse<TDocument>	explain(ExplainRequest request, Class<TDocument> tDocumentClass)	Returns information about why a specific 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 matches (or doesn't match) a query.
ElasticsearchFeaturesClient	features()
FieldCapsResponse	fieldCaps()	Returns the information about the capabilities of fields among multiple indices.
FieldCapsResponse	fieldCaps(FieldCapsRequest request)	Returns the information about the capabilities of fields among multiple indices.
final FieldCapsResponse	fieldCaps(Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)	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.
final <TDocument> GetResponse<TDocument>	get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, Class<TDocument> tDocumentClass)	Returns a document.
GetScriptResponse	getScript(GetScriptRequest request)	Returns a script.
final GetScriptResponse	getScript(Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)	Returns a script.
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.
final <TDocument> GetSourceResponse<TDocument>	getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, Class<TDocument> tDocumentClass)	Returns the source of a document.
ElasticsearchGraphClient	graph()
ElasticsearchIlmClient	ilm()
<TDocument> IndexResponse	index(IndexRequest<TDocument> request)	Creates or updates a document in an index.
final <TDocument> IndexResponse	index(Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)	Creates or updates a document in an index.
ElasticsearchIndicesClient	indices()
InfoResponse	info()	Returns basic information about the cluster.
ElasticsearchIngestClient	ingest()
<TDocument> KnnSearchResponse<TDocument>	knnSearch(KnnSearchRequest request, Class<TDocument> tDocumentClass)	Performs a kNN search.
final <TDocument> KnnSearchResponse<TDocument>	knnSearch(Function<KnnSearchRequest.Builder,ObjectBuilder<KnnSearchRequest>> fn, Class<TDocument> tDocumentClass)	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.
final <TDocument> MgetResponse<TDocument>	mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, Class<TDocument> tDocumentClass)	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.
final <TDocument> MsearchResponse<TDocument>	msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, Class<TDocument> tDocumentClass)	Allows to execute several search operations in one request.
<TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(MsearchTemplateRequest request, Class<TDocument> tDocumentClass)	Allows to execute several search template operations in one request.
final <TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Allows to execute several search template operations in one 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)	Open a point in time that can be used in subsequent searches
final OpenPointInTimeResponse	openPointInTime(Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)	Open a point in time that can be used in subsequent searches
BooleanResponse	ping()	Returns whether the cluster is running.
PutScriptResponse	putScript(PutScriptRequest request)	Creates or updates a script.
final PutScriptResponse	putScript(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)	Creates or updates a script.
RankEvalResponse	rankEval(RankEvalRequest request)	Allows to evaluate the quality of ranked search results over a set of typical search queries
final RankEvalResponse	rankEval(Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)	Allows 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)	Changes the number of requests per second for a particular Reindex operation.
final ReindexRethrottleResponse	reindexRethrottle(Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)	Changes the number of requests per second for a particular Reindex operation.
RenderSearchTemplateResponse	renderSearchTemplate()	Allows to use the Mustache language to pre-render a search definition.
RenderSearchTemplateResponse	renderSearchTemplate(RenderSearchTemplateRequest request)	Allows to use the Mustache language to pre-render a search definition.
final RenderSearchTemplateResponse	renderSearchTemplate(Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)	Allows to use the Mustache language to pre-render a search definition.
ElasticsearchRollupClient	rollup()
<TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, Class<TResult> tResultClass)	Allows an arbitrary script to be executed and a result to be returned
final <TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, Class<TResult> tResultClass)	Allows an arbitrary script to be executed and a result to be returned
<TDocument> ScrollResponse<TDocument>	scroll(ScrollRequest request, 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, Class<TDocument> tDocumentClass)	Allows to retrieve a large numbers of results from a single search request.
<TDocument> SearchResponse<TDocument>	search(SearchRequest request, Class<TDocument> tDocumentClass)	Returns results matching a query.
final <TDocument> SearchResponse<TDocument>	search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, Class<TDocument> tDocumentClass)	Returns results matching a query.
ElasticsearchSearchableSnapshotsClient	searchableSnapshots()
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)	Allows to use the Mustache language to pre-render a search definition.
final <TDocument> SearchTemplateResponse<TDocument>	searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Allows to use the Mustache language to pre-render a search definition.
ElasticsearchSecurityClient	security()
ElasticsearchShutdownClient	shutdown()
ElasticsearchSlmClient	slm()
ElasticsearchSnapshotClient	snapshot()
ElasticsearchSqlClient	sql()
ElasticsearchSslClient	ssl()
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.
ElasticsearchTransformClient	transform()
<TDocument, TPartialDocument> UpdateResponse<TDocument>	update(UpdateRequest<TDocument,TPartialDocument> request, 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, Class<TDocument> tDocumentClass)	Updates a document with a script or partial document.
UpdateByQueryResponse	updateByQuery(UpdateByQueryRequest request)	Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
final UpdateByQueryResponse	updateByQuery(Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn)	Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
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()

danglingIndices

public ElasticsearchDanglingIndicesClient danglingIndices()

enrich

public ElasticsearchEnrichClient enrich()

eql

public ElasticsearchEqlClient eql()

features

public ElasticsearchFeaturesClient features()

fleet

public ElasticsearchFleetClient fleet()

graph

public ElasticsearchGraphClient graph()

ilm

public ElasticsearchIlmClient ilm()

indices

public ElasticsearchIndicesClient indices()

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()

rollup

public ElasticsearchRollupClient rollup()

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()

tasks

public ElasticsearchTasksClient tasks()

transform

public ElasticsearchTransformClient transform()

watcher

public ElasticsearchWatcherClient watcher()

xpack

public ElasticsearchXpackClient xpack()

bulk

public BulkResponse bulk(BulkRequest request)
                  throws IOException,
ElasticsearchException

Allows to perform multiple index/update/delete operations in a single request.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

bulk

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

Allows to perform multiple index/update/delete operations in a single request.

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

Allows to perform multiple index/update/delete operations in a single request.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearScroll

public ClearScrollResponse clearScroll(ClearScrollRequest request)
                                throws IOException,
ElasticsearchException

Explicitly clears the search context for a scroll.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearScroll

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

Explicitly clears the search context for a scroll.

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

Explicitly clears the search context for a scroll.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

closePointInTime

public ClosePointInTimeResponse closePointInTime(ClosePointInTimeRequest request)
                                          throws IOException,
ElasticsearchException

Close 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

Close 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

Creates a new document in the index.

Returns a 409 response when a document with a same ID already exists in the index.

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

Creates a new document in the index.

Returns a 409 response when a document with a same ID already exists in the index.

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 document from the 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 document from the 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 matching the provided 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 matching the provided 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 script.

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 script.

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

Returns information about whether a document exists in an index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

exists

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

Returns information about whether a document exists in an index.

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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsSource

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

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

Parameters:

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

Throws:

IOException

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 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 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

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

fieldCaps

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

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

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

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

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

getScript

public GetScriptResponse getScript(GetScriptRequest request)
                            throws IOException,
ElasticsearchException

Returns a script.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getScript

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

Returns a script.

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

index

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

Creates or updates a document in an index.

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

Creates or updates a document in an index.

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

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

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

msearchTemplate

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

Allows to execute several search template operations in one 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

Allows to execute several search template operations in one 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

Open a point in time that can be used in subsequent searches

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 that can be used in subsequent searches

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 script.

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 script.

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

Allows 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

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

Parameters:

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

Throws:

IOException

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

Changes 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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

renderSearchTemplate

public RenderSearchTemplateResponse renderSearchTemplate(RenderSearchTemplateRequest request)
                                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

renderSearchTemplate

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

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

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

renderSearchTemplate

public RenderSearchTemplateResponse renderSearchTemplate()
                                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

scriptsPainlessExecute

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

Allows an arbitrary script to be executed and a result to be returned

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

Allows an arbitrary script to be executed and a result to be returned

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

search

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

Returns results matching a query.

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 results matching a query.

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

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

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

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

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

updateByQuery

public UpdateByQueryResponse updateByQuery(UpdateByQueryRequest request)
                                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateByQuery

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

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

Parameters:

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

Throws:

IOException

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