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 ElasticsearchAsyncSearchClientasyncSearch()ElasticsearchAutoscalingClientautoscaling()BulkResponsebulk()Allows to perform multiple index/update/delete operations in a single request.BulkResponsebulk(BulkRequest request)Allows to perform multiple index/update/delete operations in a single request.BulkResponsebulk(java.util.function.Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)Allows to perform multiple index/update/delete operations in a single request.ElasticsearchCatClientcat()ElasticsearchCcrClientccr()ClearScrollResponseclearScroll()Explicitly clears the search context for a scroll.ClearScrollResponseclearScroll(ClearScrollRequest request)Explicitly clears the search context for a scroll.ClearScrollResponseclearScroll(java.util.function.Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)Explicitly clears the search context for a scroll.ClosePointInTimeResponseclosePointInTime(ClosePointInTimeRequest request)Close a point in timeClosePointInTimeResponseclosePointInTime(java.util.function.Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn)Close a point in timeElasticsearchClusterClientcluster()CountResponsecount()Returns number of documents matching a query.CountResponsecount(CountRequest request)Returns number of documents matching a query.CountResponsecount(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)Returns number of documents matching a query.<TDocument>
CreateResponsecreate(CreateRequest<TDocument> request)Creates a new document in the index.<TDocument>
CreateResponsecreate(java.util.function.Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)Creates a new document in the index.ElasticsearchDanglingIndicesClientdanglingIndices()DeleteResponsedelete(DeleteRequest request)Removes a document from the index.DeleteResponsedelete(java.util.function.Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)Removes a document from the index.DeleteByQueryResponsedeleteByQuery(DeleteByQueryRequest request)Deletes documents matching the provided query.DeleteByQueryResponsedeleteByQuery(java.util.function.Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)Deletes documents matching the provided query.DeleteByQueryRethrottleResponsedeleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)Changes the number of requests per second for a particular Delete By Query operation.DeleteByQueryRethrottleResponsedeleteByQueryRethrottle(java.util.function.Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn)Changes the number of requests per second for a particular Delete By Query operation.DeleteScriptResponsedeleteScript(DeleteScriptRequest request)Deletes a script.DeleteScriptResponsedeleteScript(java.util.function.Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)Deletes a script.ElasticsearchEnrichClientenrich()ElasticsearchEqlClienteql()BooleanResponseexists(ExistsRequest request)Returns information about whether a document exists in an index.BooleanResponseexists(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)Returns information about whether a document exists in an index.BooleanResponseexistsSource(ExistsSourceRequest request)Returns information about whether a document source exists in an index.BooleanResponseexistsSource(java.util.function.Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)Returns information about whether a document source exists in an index.<TDocument>
ExplainResponse<TDocument>explain(ExplainRequest request, java.lang.Class<TDocument> tDocumentClass)Returns information about why a specific matches (or doesn't match) a query.<TDocument>
ExplainResponse<TDocument>explain(java.util.function.Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Returns information about why a specific matches (or doesn't match) a query.ElasticsearchFeaturesClientfeatures()FieldCapsResponsefieldCaps(FieldCapsRequest request)Returns the information about the capabilities of fields among multiple indices.FieldCapsResponsefieldCaps(java.util.function.Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)Returns the information about the capabilities of fields among multiple indices.<TDocument>
GetResponse<TDocument>get(GetRequest request, java.lang.Class<TDocument> tDocumentClass)Returns a document.<TDocument>
GetResponse<TDocument>get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Returns a document.GetScriptResponsegetScript(GetScriptRequest request)Returns a script.GetScriptResponsegetScript(java.util.function.Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)Returns a script.GetScriptContextResponsegetScriptContext()Returns all script contexts.GetScriptLanguagesResponsegetScriptLanguages()Returns available script types, languages and contexts<TDocument>
GetSourceResponse<TDocument>getSource(GetSourceRequest request, java.lang.Class<TDocument> tDocumentClass)Returns the source of a document.<TDocument>
GetSourceResponse<TDocument>getSource(java.util.function.Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Returns the source of a document.ElasticsearchGraphClientgraph()ElasticsearchIlmClientilm()<TDocument>
IndexResponseindex(IndexRequest<TDocument> request)Creates or updates a document in an index.<TDocument>
IndexResponseindex(java.util.function.Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)Creates or updates a document in an index.ElasticsearchIndicesClientindices()InfoResponseinfo()Returns basic information about the cluster.ElasticsearchIngestClientingest()ElasticsearchLicenseClientlicense()ElasticsearchLogstashClientlogstash()<TDocument>
MgetResponse<TDocument>mget(MgetRequest request, java.lang.Class<TDocument> tDocumentClass)Allows to get multiple documents in one request.<TDocument>
MgetResponse<TDocument>mget(java.util.function.Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Allows to get multiple documents in one request.ElasticsearchMigrationClientmigration()ElasticsearchMlClientml()ElasticsearchMonitoringClientmonitoring()<TDocument>
MsearchResponse<TDocument>msearch(MsearchRequest request, java.lang.Class<TDocument> tDocumentClass)Allows to execute several search operations in one request.<TDocument>
MsearchResponse<TDocument>msearch(java.util.function.Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Allows to execute several search operations in one request.<TDocument>
MsearchTemplateResponse<TDocument>msearchTemplate(MsearchTemplateRequest request, java.lang.Class<TDocument> tDocumentClass)Allows to execute several search template operations in one request.<TDocument>
MsearchTemplateResponse<TDocument>msearchTemplate(java.util.function.Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Allows to execute several search template operations in one request.MtermvectorsResponsemtermvectors()Returns multiple termvectors in one request.MtermvectorsResponsemtermvectors(MtermvectorsRequest request)Returns multiple termvectors in one request.MtermvectorsResponsemtermvectors(java.util.function.Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)Returns multiple termvectors in one request.ElasticsearchNodesClientnodes()OpenPointInTimeResponseopenPointInTime(OpenPointInTimeRequest request)Open a point in time that can be used in subsequent searchesOpenPointInTimeResponseopenPointInTime(java.util.function.Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn)Open a point in time that can be used in subsequent searchesBooleanResponseping()Returns whether the cluster is running.PutScriptResponseputScript(PutScriptRequest request)Creates or updates a script.PutScriptResponseputScript(java.util.function.Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)Creates or updates a script.RankEvalResponserankEval(RankEvalRequest request)Allows to evaluate the quality of ranked search results over a set of typical search queriesRankEvalResponserankEval(java.util.function.Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)Allows to evaluate the quality of ranked search results over a set of typical search queriesReindexResponsereindex(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.ReindexResponsereindex(java.util.function.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.ReindexRethrottleResponsereindexRethrottle(ReindexRethrottleRequest request)Changes the number of requests per second for a particular Reindex operation.ReindexRethrottleResponsereindexRethrottle(java.util.function.Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)Changes the number of requests per second for a particular Reindex operation.RenderSearchTemplateResponserenderSearchTemplate()Allows to use the Mustache language to pre-render a search definition.RenderSearchTemplateResponserenderSearchTemplate(RenderSearchTemplateRequest request)Allows to use the Mustache language to pre-render a search definition.RenderSearchTemplateResponserenderSearchTemplate(java.util.function.Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)Allows to use the Mustache language to pre-render a search definition.ElasticsearchRollupClientrollup()<TResult> ScriptsPainlessExecuteResponse<TResult>scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, java.lang.Class<TResult> tResultClass)Allows an arbitrary script to be executed and a result to be returned<TResult> ScriptsPainlessExecuteResponse<TResult>scriptsPainlessExecute(java.util.function.Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, java.lang.Class<TResult> tResultClass)Allows an arbitrary script to be executed and a result to be returned<TDocument>
ScrollResponse<TDocument>scroll(ScrollRequest request, java.lang.Class<TDocument> tDocumentClass)Allows to retrieve a large numbers of results from a single search request.<TDocument>
ScrollResponse<TDocument>scroll(java.util.function.Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Allows to retrieve a large numbers of results from a single search request.<TDocument>
SearchResponse<TDocument>search(SearchRequest request, java.lang.Class<TDocument> tDocumentClass)Returns results matching a query.<TDocument>
SearchResponse<TDocument>search(java.util.function.Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Returns results matching a query.ElasticsearchSearchableSnapshotsClientsearchableSnapshots()SearchShardsResponsesearchShards()Returns information about the indices and shards that a search request would be executed against.SearchShardsResponsesearchShards(SearchShardsRequest request)Returns information about the indices and shards that a search request would be executed against.SearchShardsResponsesearchShards(java.util.function.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, java.lang.Class<TDocument> tDocumentClass)Allows to use the Mustache language to pre-render a search definition.<TDocument>
SearchTemplateResponse<TDocument>searchTemplate(java.util.function.Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, java.lang.Class<TDocument> tDocumentClass)Allows to use the Mustache language to pre-render a search definition.ElasticsearchSecurityClientsecurity()ElasticsearchShutdownClientshutdown()ElasticsearchSlmClientslm()ElasticsearchSnapshotClientsnapshot()ElasticsearchSqlClientsql()ElasticsearchSslClientssl()ElasticsearchTasksClienttasks()TermsEnumResponsetermsEnum(TermsEnumRequest request)The terms enum API can be used to discover terms in the index that begin with the provided string.TermsEnumResponsetermsEnum(java.util.function.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>
TermvectorsResponsetermvectors(TermvectorsRequest<TDocument> request)Returns information and statistics about terms in the fields of a particular document.<TDocument>
TermvectorsResponsetermvectors(java.util.function.Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)Returns information and statistics about terms in the fields of a particular document.ElasticsearchTransformClienttransform()<TDocument, TPartialDocument>
UpdateResponse<TDocument>update(UpdateRequest<TDocument,TPartialDocument> request, java.lang.Class<TDocument> tDocumentClass)Updates a document with a script or partial document.<TDocument, TPartialDocument>
UpdateResponse<TDocument>update(java.util.function.Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, java.lang.Class<TDocument> tDocumentClass)Updates a document with a script or partial document.UpdateByQueryResponseupdateByQuery(UpdateByQueryRequest request)Performs an update on every document in the index without changing the source, for example to pick up a mapping change.UpdateByQueryResponseupdateByQuery(java.util.function.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.UpdateByQueryRethrottleResponseupdateByQueryRethrottle(UpdateByQueryRethrottleRequest request)Changes the number of requests per second for a particular Update By Query operation.UpdateByQueryRethrottleResponseupdateByQueryRethrottle(java.util.function.Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)Changes the number of requests per second for a particular Update By Query operation.ElasticsearchWatcherClientwatcher()ElasticsearchClientwithTransportOptions(TransportOptions transportOptions)Creates a new client with some request optionsElasticsearchXpackClientxpack()Methods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializerMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
ElasticsearchClient
-
ElasticsearchClient
public ElasticsearchClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
Description copied from class:ApiClientCreates a new client with some request options- Specified by:
withTransportOptionsin classApiClient<ElasticsearchTransport,ElasticsearchClient>
-
asyncSearch
-
autoscaling
-
cat
-
ccr
-
cluster
-
danglingIndices
-
enrich
-
eql
-
features
-
graph
-
ilm
-
indices
-
ingest
-
license
-
logstash
-
migration
-
ml
-
monitoring
-
nodes
-
rollup
-
searchableSnapshots
-
security
-
shutdown
-
slm
-
snapshot
-
sql
-
ssl
-
tasks
-
transform
-
watcher
-
xpack
-
bulk
Allows to perform multiple index/update/delete operations in a single request.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
bulk
public final BulkResponse bulk(java.util.function.Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn) throws java.io.IOException, ElasticsearchExceptionAllows to perform multiple index/update/delete operations in a single request.- Parameters:
fn- a function that initializes a builder to create theBulkRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
bulk
Allows to perform multiple index/update/delete operations in a single request.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
clearScroll
public ClearScrollResponse clearScroll(ClearScrollRequest request) throws java.io.IOException, ElasticsearchExceptionExplicitly clears the search context for a scroll.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
clearScroll
public final ClearScrollResponse clearScroll(java.util.function.Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn) throws java.io.IOException, ElasticsearchExceptionExplicitly clears the search context for a scroll.- Parameters:
fn- a function that initializes a builder to create theClearScrollRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
clearScroll
Explicitly clears the search context for a scroll.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
closePointInTime
public ClosePointInTimeResponse closePointInTime(ClosePointInTimeRequest request) throws java.io.IOException, ElasticsearchExceptionClose a point in time- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
closePointInTime
public final ClosePointInTimeResponse closePointInTime(java.util.function.Function<ClosePointInTimeRequest.Builder,ObjectBuilder<ClosePointInTimeRequest>> fn) throws java.io.IOException, ElasticsearchExceptionClose a point in time- Parameters:
fn- a function that initializes a builder to create theClosePointInTimeRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
count
public CountResponse count(CountRequest request) throws java.io.IOException, ElasticsearchExceptionReturns number of documents matching a query.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
count
public final CountResponse count(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns number of documents matching a query.- Parameters:
fn- a function that initializes a builder to create theCountRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
count
Returns number of documents matching a query.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
create
public <TDocument> CreateResponse create(CreateRequest<TDocument> request) throws java.io.IOException, ElasticsearchExceptionCreates a new document in the index.Returns a 409 response when a document with a same ID already exists in the index.
- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
create
public final <TDocument> CreateResponse create(java.util.function.Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn) throws java.io.IOException, ElasticsearchExceptionCreates 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 theCreateRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
delete
public DeleteResponse delete(DeleteRequest request) throws java.io.IOException, ElasticsearchExceptionRemoves a document from the index.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
delete
public final DeleteResponse delete(java.util.function.Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn) throws java.io.IOException, ElasticsearchExceptionRemoves a document from the index.- Parameters:
fn- a function that initializes a builder to create theDeleteRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
deleteByQuery
public DeleteByQueryResponse deleteByQuery(DeleteByQueryRequest request) throws java.io.IOException, ElasticsearchExceptionDeletes documents matching the provided query.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
deleteByQuery
public final DeleteByQueryResponse deleteByQuery(java.util.function.Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn) throws java.io.IOException, ElasticsearchExceptionDeletes documents matching the provided query.- Parameters:
fn- a function that initializes a builder to create theDeleteByQueryRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
deleteByQueryRethrottle
public DeleteByQueryRethrottleResponse deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request) throws java.io.IOException, ElasticsearchExceptionChanges the number of requests per second for a particular Delete By Query operation.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
deleteByQueryRethrottle
public final DeleteByQueryRethrottleResponse deleteByQueryRethrottle(java.util.function.Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn) throws java.io.IOException, ElasticsearchExceptionChanges the number of requests per second for a particular Delete By Query operation.- Parameters:
fn- a function that initializes a builder to create theDeleteByQueryRethrottleRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
deleteScript
public DeleteScriptResponse deleteScript(DeleteScriptRequest request) throws java.io.IOException, ElasticsearchExceptionDeletes a script.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
deleteScript
public final DeleteScriptResponse deleteScript(java.util.function.Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn) throws java.io.IOException, ElasticsearchExceptionDeletes a script.- Parameters:
fn- a function that initializes a builder to create theDeleteScriptRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
exists
public BooleanResponse exists(ExistsRequest request) throws java.io.IOException, ElasticsearchExceptionReturns information about whether a document exists in an index.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
exists
public final BooleanResponse exists(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information about whether a document exists in an index.- Parameters:
fn- a function that initializes a builder to create theExistsRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
existsSource
public BooleanResponse existsSource(ExistsSourceRequest request) throws java.io.IOException, ElasticsearchExceptionReturns information about whether a document source exists in an index.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
existsSource
public final BooleanResponse existsSource(java.util.function.Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information about whether a document source exists in an index.- Parameters:
fn- a function that initializes a builder to create theExistsSourceRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
explain
public <TDocument> ExplainResponse<TDocument> explain(ExplainRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionReturns information about why a specific matches (or doesn't match) a query.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
explain
public final <TDocument> ExplainResponse<TDocument> explain(java.util.function.Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionReturns information about why a specific matches (or doesn't match) a query.- Parameters:
fn- a function that initializes a builder to create theExplainRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
fieldCaps
public FieldCapsResponse fieldCaps(FieldCapsRequest request) throws java.io.IOException, ElasticsearchExceptionReturns the information about the capabilities of fields among multiple indices.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
fieldCaps
public final FieldCapsResponse fieldCaps(java.util.function.Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns the information about the capabilities of fields among multiple indices.- Parameters:
fn- a function that initializes a builder to create theFieldCapsRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
get
public <TDocument> GetResponse<TDocument> get(GetRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionReturns a document.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
get
public final <TDocument> GetResponse<TDocument> get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionReturns a document.- Parameters:
fn- a function that initializes a builder to create theGetRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
getScript
public GetScriptResponse getScript(GetScriptRequest request) throws java.io.IOException, ElasticsearchExceptionReturns a script.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
getScript
public final GetScriptResponse getScript(java.util.function.Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns a script.- Parameters:
fn- a function that initializes a builder to create theGetScriptRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
getScriptContext
public GetScriptContextResponse getScriptContext() throws java.io.IOException, ElasticsearchExceptionReturns all script contexts.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
getScriptLanguages
public GetScriptLanguagesResponse getScriptLanguages() throws java.io.IOException, ElasticsearchExceptionReturns available script types, languages and contexts- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
getSource
public <TDocument> GetSourceResponse<TDocument> getSource(GetSourceRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionReturns the source of a document.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
getSource
public final <TDocument> GetSourceResponse<TDocument> getSource(java.util.function.Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionReturns the source of a document.- Parameters:
fn- a function that initializes a builder to create theGetSourceRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
index
public <TDocument> IndexResponse index(IndexRequest<TDocument> request) throws java.io.IOException, ElasticsearchExceptionCreates or updates a document in an index.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
index
public final <TDocument> IndexResponse index(java.util.function.Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn) throws java.io.IOException, ElasticsearchExceptionCreates or updates a document in an index.- Parameters:
fn- a function that initializes a builder to create theIndexRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
info
Returns basic information about the cluster.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
mget
public <TDocument> MgetResponse<TDocument> mget(MgetRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to get multiple documents in one request.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
mget
public final <TDocument> MgetResponse<TDocument> mget(java.util.function.Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to get multiple documents in one request.- Parameters:
fn- a function that initializes a builder to create theMgetRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
msearch
public <TDocument> MsearchResponse<TDocument> msearch(MsearchRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to execute several search operations in one request.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
msearch
public final <TDocument> MsearchResponse<TDocument> msearch(java.util.function.Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to execute several search operations in one request.- Parameters:
fn- a function that initializes a builder to create theMsearchRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
msearchTemplate
public <TDocument> MsearchTemplateResponse<TDocument> msearchTemplate(MsearchTemplateRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to execute several search template operations in one request.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
msearchTemplate
public final <TDocument> MsearchTemplateResponse<TDocument> msearchTemplate(java.util.function.Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to execute several search template operations in one request.- Parameters:
fn- a function that initializes a builder to create theMsearchTemplateRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
mtermvectors
public MtermvectorsResponse mtermvectors(MtermvectorsRequest request) throws java.io.IOException, ElasticsearchExceptionReturns multiple termvectors in one request.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
mtermvectors
public final MtermvectorsResponse mtermvectors(java.util.function.Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns multiple termvectors in one request.- Parameters:
fn- a function that initializes a builder to create theMtermvectorsRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
mtermvectors
Returns multiple termvectors in one request.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
openPointInTime
public OpenPointInTimeResponse openPointInTime(OpenPointInTimeRequest request) throws java.io.IOException, ElasticsearchExceptionOpen a point in time that can be used in subsequent searches- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
openPointInTime
public final OpenPointInTimeResponse openPointInTime(java.util.function.Function<OpenPointInTimeRequest.Builder,ObjectBuilder<OpenPointInTimeRequest>> fn) throws java.io.IOException, ElasticsearchExceptionOpen a point in time that can be used in subsequent searches- Parameters:
fn- a function that initializes a builder to create theOpenPointInTimeRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
ping
Returns whether the cluster is running.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
putScript
public PutScriptResponse putScript(PutScriptRequest request) throws java.io.IOException, ElasticsearchExceptionCreates or updates a script.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
putScript
public final PutScriptResponse putScript(java.util.function.Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn) throws java.io.IOException, ElasticsearchExceptionCreates or updates a script.- Parameters:
fn- a function that initializes a builder to create thePutScriptRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
rankEval
public RankEvalResponse rankEval(RankEvalRequest request) throws java.io.IOException, ElasticsearchExceptionAllows to evaluate the quality of ranked search results over a set of typical search queries- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
rankEval
public final RankEvalResponse rankEval(java.util.function.Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn) throws java.io.IOException, ElasticsearchExceptionAllows 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 theRankEvalRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
reindex
public ReindexResponse reindex(ReindexRequest request) throws java.io.IOException, ElasticsearchExceptionAllows 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:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
reindex
public final ReindexResponse reindex(java.util.function.Function<ReindexRequest.Builder,ObjectBuilder<ReindexRequest>> fn) throws java.io.IOException, ElasticsearchExceptionAllows 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 theReindexRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
reindexRethrottle
public ReindexRethrottleResponse reindexRethrottle(ReindexRethrottleRequest request) throws java.io.IOException, ElasticsearchExceptionChanges the number of requests per second for a particular Reindex operation.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
reindexRethrottle
public final ReindexRethrottleResponse reindexRethrottle(java.util.function.Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn) throws java.io.IOException, ElasticsearchExceptionChanges the number of requests per second for a particular Reindex operation.- Parameters:
fn- a function that initializes a builder to create theReindexRethrottleRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
renderSearchTemplate
public RenderSearchTemplateResponse renderSearchTemplate(RenderSearchTemplateRequest request) throws java.io.IOException, ElasticsearchExceptionAllows to use the Mustache language to pre-render a search definition.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
renderSearchTemplate
public final RenderSearchTemplateResponse renderSearchTemplate(java.util.function.Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn) throws java.io.IOException, ElasticsearchExceptionAllows to use the Mustache language to pre-render a search definition.- Parameters:
fn- a function that initializes a builder to create theRenderSearchTemplateRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
renderSearchTemplate
public RenderSearchTemplateResponse renderSearchTemplate() throws java.io.IOException, ElasticsearchExceptionAllows to use the Mustache language to pre-render a search definition.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
scriptsPainlessExecute
public <TResult> ScriptsPainlessExecuteResponse<TResult> scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, java.lang.Class<TResult> tResultClass) throws java.io.IOException, ElasticsearchExceptionAllows an arbitrary script to be executed and a result to be returned- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
scriptsPainlessExecute
public final <TResult> ScriptsPainlessExecuteResponse<TResult> scriptsPainlessExecute(java.util.function.Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, java.lang.Class<TResult> tResultClass) throws java.io.IOException, ElasticsearchExceptionAllows an arbitrary script to be executed and a result to be returned- Parameters:
fn- a function that initializes a builder to create theScriptsPainlessExecuteRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
scroll
public <TDocument> ScrollResponse<TDocument> scroll(ScrollRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to retrieve a large numbers of results from a single search request.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
scroll
public final <TDocument> ScrollResponse<TDocument> scroll(java.util.function.Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to retrieve a large numbers of results from a single search request.- Parameters:
fn- a function that initializes a builder to create theScrollRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
search
public <TDocument> SearchResponse<TDocument> search(SearchRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionReturns results matching a query.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
search
public final <TDocument> SearchResponse<TDocument> search(java.util.function.Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionReturns results matching a query.- Parameters:
fn- a function that initializes a builder to create theSearchRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
searchShards
public SearchShardsResponse searchShards(SearchShardsRequest request) throws java.io.IOException, ElasticsearchExceptionReturns information about the indices and shards that a search request would be executed against.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
searchShards
public final SearchShardsResponse searchShards(java.util.function.Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information about the indices and shards that a search request would be executed against.- Parameters:
fn- a function that initializes a builder to create theSearchShardsRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
searchShards
Returns information about the indices and shards that a search request would be executed against.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
searchTemplate
public <TDocument> SearchTemplateResponse<TDocument> searchTemplate(SearchTemplateRequest request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to use the Mustache language to pre-render a search definition.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
searchTemplate
public final <TDocument> SearchTemplateResponse<TDocument> searchTemplate(java.util.function.Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionAllows to use the Mustache language to pre-render a search definition.- Parameters:
fn- a function that initializes a builder to create theSearchTemplateRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
termsEnum
public TermsEnumResponse termsEnum(TermsEnumRequest request) throws java.io.IOException, ElasticsearchExceptionThe 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:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
termsEnum
public final TermsEnumResponse termsEnum(java.util.function.Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn) throws java.io.IOException, ElasticsearchExceptionThe 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 theTermsEnumRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
termvectors
public <TDocument> TermvectorsResponse termvectors(TermvectorsRequest<TDocument> request) throws java.io.IOException, ElasticsearchExceptionReturns information and statistics about terms in the fields of a particular document.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
termvectors
public final <TDocument> TermvectorsResponse termvectors(java.util.function.Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information and statistics about terms in the fields of a particular document.- Parameters:
fn- a function that initializes a builder to create theTermvectorsRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
update
public <TDocument, TPartialDocument> UpdateResponse<TDocument> update(UpdateRequest<TDocument,TPartialDocument> request, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionUpdates a document with a script or partial document.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
update
public final <TDocument, TPartialDocument> UpdateResponse<TDocument> update(java.util.function.Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, java.lang.Class<TDocument> tDocumentClass) throws java.io.IOException, ElasticsearchExceptionUpdates a document with a script or partial document.- Parameters:
fn- a function that initializes a builder to create theUpdateRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
updateByQuery
public UpdateByQueryResponse updateByQuery(UpdateByQueryRequest request) throws java.io.IOException, ElasticsearchExceptionPerforms an update on every document in the index without changing the source, for example to pick up a mapping change.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
updateByQuery
public final UpdateByQueryResponse updateByQuery(java.util.function.Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn) throws java.io.IOException, ElasticsearchExceptionPerforms 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 theUpdateByQueryRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
updateByQueryRethrottle
public UpdateByQueryRethrottleResponse updateByQueryRethrottle(UpdateByQueryRethrottleRequest request) throws java.io.IOException, ElasticsearchExceptionChanges the number of requests per second for a particular Update By Query operation.- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-
updateByQueryRethrottle
public final UpdateByQueryRethrottleResponse updateByQueryRethrottle(java.util.function.Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn) throws java.io.IOException, ElasticsearchExceptionChanges the number of requests per second for a particular Update By Query operation.- Parameters:
fn- a function that initializes a builder to create theUpdateByQueryRethrottleRequest- Throws:
java.io.IOExceptionElasticsearchException- See Also:
- Documentation on elastic.co
-