java.lang.Object
- org.elasticsearch.client.RestHighLevelClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public class RestHighLevelClient
extends java.lang.Object
implements java.io.Closeable
```
High level REST client that wraps an instance of the low level RestClient and allows to build requests and read responses. The RestClient instance is internally built based on the provided RestClientBuilder and it gets closed automatically when closing the RestHighLevelClient instance that wraps it.
In case an already existing instance of a low-level REST client needs to be provided, this class can be subclassed and the RestHighLevelClient(RestClient, CheckedConsumer, List) constructor can be used.
This class can also be sub-classed to expose additional client methods that make use of endpoints added to Elasticsearch through plugins, or to add support for custom response sections, again added to Elasticsearch through plugins.
The majority of the methods in this class come in two flavors, a blocking and an asynchronous version (e.g. search(SearchRequest, RequestOptions) and searchAsync(SearchRequest, RequestOptions, ActionListener), where the later takes an implementation of an ActionListener as an argument that needs to implement methods that handle successful responses and failure scenarios. Most of the blocking calls can throw an IOException or an unchecked ElasticsearchException in the following cases:
- an IOException is usually thrown in case of failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the Elasticsearch server
- an ElasticsearchException is usually thrown in case where the server returns a 4xx or 5xx error code. The high-level client then tries to parse the response body error details into a generic ElasticsearchException and suppresses the original ResponseException

Constructor Summary

Constructors
Modifier	Constructor	Description
	`RestHighLevelClient(RestClientBuilder restClientBuilder)`	Creates a `RestHighLevelClient` given the low level `RestClientBuilder` that allows to build the `RestClient` to be used to perform requests.
`protected`	`RestHighLevelClient(RestClientBuilder restClientBuilder, java.util.List<NamedXContentRegistry.Entry> namedXContentEntries)`	Creates a `RestHighLevelClient` given the low level `RestClientBuilder` that allows to build the `RestClient` to be used to perform requests and parsers for custom response sections added to Elasticsearch through plugins.
`protected`	`RestHighLevelClient(RestClient restClient, CheckedConsumer<RestClient,java.io.IOException> doClose, java.util.List<NamedXContentRegistry.Entry> namedXContentEntries)`	Creates a `RestHighLevelClient` given the low level `RestClient` that it should use to perform requests and a list of entries that allow to parse custom response sections added to Elasticsearch through plugins.

Method Summary

Modifier and Type	Method	Description
`BulkResponse`	`bulk(BulkRequest bulkRequest, RequestOptions options)`	Executes a bulk request using the Bulk API.
`void`	`bulkAsync(BulkRequest bulkRequest, RequestOptions options, ActionListener<BulkResponse> listener)`	Asynchronously executes a bulk request using the Bulk API.
`CcrClient`	`ccr()`	Provides methods for accessing the Elastic Licensed CCR APIs that are shipped with the Elastic Stack distribution of Elasticsearch.
`ClearScrollResponse`	`clearScroll(ClearScrollRequest clearScrollRequest, RequestOptions options)`	Clears one or more scroll ids using the Clear Scroll API.
`void`	`clearScrollAsync(ClearScrollRequest clearScrollRequest, RequestOptions options, ActionListener<ClearScrollResponse> listener)`	Asynchronously clears one or more scroll ids using the Clear Scroll API.
`void`	`close()`
`ClusterClient`	`cluster()`	Provides a `ClusterClient` which can be used to access the Cluster API.
`protected static boolean`	`convertExistsResponse(Response response)`
`CountResponse`	`count(CountRequest countRequest, RequestOptions options)`	Executes a count request using the Count API.
`void`	`countAsync(CountRequest countRequest, RequestOptions options, ActionListener<CountResponse> listener)`	Asynchronously executes a count request using the Count API.
`DeleteResponse`	`delete(DeleteRequest deleteRequest, RequestOptions options)`	Deletes a document by id using the Delete API.
`void`	`deleteAsync(DeleteRequest deleteRequest, RequestOptions options, ActionListener<DeleteResponse> listener)`	Asynchronously deletes a document by id using the Delete API.
`BulkByScrollResponse`	`deleteByQuery(DeleteByQueryRequest deleteByQueryRequest, RequestOptions options)`	Executes a delete by query request.
`void`	`deleteByQueryAsync(DeleteByQueryRequest deleteByQueryRequest, RequestOptions options, ActionListener<BulkByScrollResponse> listener)`	Asynchronously executes a delete by query request.
`ListTasksResponse`	`deleteByQueryRethrottle(RethrottleRequest rethrottleRequest, RequestOptions options)`	Executes a delete by query rethrottle request.
`void`	`deleteByQueryRethrottleAsync(RethrottleRequest rethrottleRequest, RequestOptions options, ActionListener<ListTasksResponse> listener)`	Asynchronously execute an delete by query rethrottle request.
`AcknowledgedResponse`	`deleteScript(DeleteStoredScriptRequest request, RequestOptions options)`	Delete stored script by id.
`void`	`deleteScriptAsync(DeleteStoredScriptRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously delete stored script by id.
`boolean`	`exists(GetRequest getRequest, RequestOptions options)`	Checks for the existence of a document.
`void`	`existsAsync(GetRequest getRequest, RequestOptions options, ActionListener<java.lang.Boolean> listener)`	Asynchronously checks for the existence of a document.
`boolean`	`existsSource(GetRequest getRequest, RequestOptions options)`	Checks for the existence of a document with a "_source" field.
`void`	`existsSourceAsync(GetRequest getRequest, RequestOptions options, ActionListener<java.lang.Boolean> listener)`	Asynchronously checks for the existence of a document with a "_source" field.
`ExplainResponse`	`explain(ExplainRequest explainRequest, RequestOptions options)`	Executes a request using the Explain API.
`void`	`explainAsync(ExplainRequest explainRequest, RequestOptions options, ActionListener<ExplainResponse> listener)`	Asynchronously executes a request using the Explain API.
`FieldCapabilitiesResponse`	`fieldCaps(FieldCapabilitiesRequest fieldCapabilitiesRequest, RequestOptions options)`	Executes a request using the Field Capabilities API.
`void`	`fieldCapsAsync(FieldCapabilitiesRequest fieldCapabilitiesRequest, RequestOptions options, ActionListener<FieldCapabilitiesResponse> listener)`	Asynchronously executes a request using the Field Capabilities API.
`GetResponse`	`get(GetRequest getRequest, RequestOptions options)`	Retrieves a document by id using the Get API.
`void`	`getAsync(GetRequest getRequest, RequestOptions options, ActionListener<GetResponse> listener)`	Asynchronously retrieves a document by id using the Get API.
`RestClient`	`getLowLevelClient()`	Returns the low-level client that the current high-level client instance is using to perform requests
`GetStoredScriptResponse`	`getScript(GetStoredScriptRequest request, RequestOptions options)`	Get stored script by id.
`void`	`getScriptAsync(GetStoredScriptRequest request, RequestOptions options, ActionListener<GetStoredScriptResponse> listener)`	Asynchronously get stored script by id.
`GraphClient`	`graph()`	Provides methods for accessing the Elastic Licensed Graph explore API that is shipped with the default distribution of Elasticsearch.
`IndexResponse`	`index(IndexRequest indexRequest, RequestOptions options)`	Index a document using the Index API.
`void`	`indexAsync(IndexRequest indexRequest, RequestOptions options, ActionListener<IndexResponse> listener)`	Asynchronously index a document using the Index API.
`IndexLifecycleClient`	`indexLifecycle()`	A wrapper for the `RestHighLevelClient` that provides methods for accessing the Elastic Index Lifecycle APIs.
`IndicesClient`	`indices()`	Provides an `IndicesClient` which can be used to access the Indices API.
`MainResponse`	`info(RequestOptions options)`	Get the cluster info otherwise provided when sending an HTTP request to '/'
`IngestClient`	`ingest()`	Provides a `IngestClient` which can be used to access the Ingest API.
`LicenseClient`	`license()`	Provides methods for accessing the Elastic Licensed Licensing APIs that are shipped with the default distribution of Elasticsearch.
`MachineLearningClient`	`machineLearning()`	Provides methods for accessing the Elastic Licensed Machine Learning APIs that are shipped with the Elastic Stack distribution of Elasticsearch.
`MultiGetResponse`	`mget(MultiGetRequest multiGetRequest, RequestOptions options)`	Retrieves multiple documents by id using the Multi Get API.
`void`	`mgetAsync(MultiGetRequest multiGetRequest, RequestOptions options, ActionListener<MultiGetResponse> listener)`	Asynchronously retrieves multiple documents by id using the Multi Get API.
`MigrationClient`	`migration()`	Provides methods for accessing the Elastic Licensed Migration APIs that are shipped with the default distribution of Elasticsearch.
`MultiSearchResponse`	`msearch(MultiSearchRequest multiSearchRequest, RequestOptions options)`	Executes a multi search using the msearch API.
`void`	`msearchAsync(MultiSearchRequest searchRequest, RequestOptions options, ActionListener<MultiSearchResponse> listener)`	Asynchronously executes a multi search using the msearch API.
`MultiSearchTemplateResponse`	`msearchTemplate(MultiSearchTemplateRequest multiSearchTemplateRequest, RequestOptions options)`	Executes a request using the Multi Search Template API.
`void`	`msearchTemplateAsync(MultiSearchTemplateRequest multiSearchTemplateRequest, RequestOptions options, ActionListener<MultiSearchTemplateResponse> listener)`	Asynchronously executes a request using the Multi Search Template API See Multi Search Template API on elastic.co.
`MultiTermVectorsResponse`	`mtermvectors(MultiTermVectorsRequest request, RequestOptions options)`	Calls the Multi Term Vectors API See Multi Term Vectors API on elastic.co
`void`	`mtermvectorsAsync(MultiTermVectorsRequest request, RequestOptions options, ActionListener<MultiTermVectorsResponse> listener)`	Asynchronously calls the Multi Term Vectors API See Multi Term Vectors API on elastic.co
`MultiGetResponse`	`multiGet(MultiGetRequest multiGetRequest, RequestOptions options)`	Deprecated. use `mget(MultiGetRequest, RequestOptions)` instead
`void`	`multiGetAsync(MultiGetRequest multiGetRequest, RequestOptions options, ActionListener<MultiGetResponse> listener)`	Deprecated. use `mgetAsync(MultiGetRequest, RequestOptions, ActionListener)` instead
`MultiSearchResponse`	`multiSearch(MultiSearchRequest multiSearchRequest, RequestOptions options)`	Deprecated. use `msearch(MultiSearchRequest, RequestOptions)` instead
`void`	`multiSearchAsync(MultiSearchRequest searchRequest, RequestOptions options, ActionListener<MultiSearchResponse> listener)`	Deprecated. use `msearchAsync(MultiSearchRequest, RequestOptions, ActionListener)` instead
`protected <Resp> Resp`	`parseEntity(org.apache.http.HttpEntity entity, CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser)`
`protected ElasticsearchStatusException`	`parseResponseException(ResponseException responseException)`	Converts a `ResponseException` obtained from the low level REST client into an `ElasticsearchException`.
`protected <Req extends ActionRequest,Resp> Resp`	`performRequest(Req request, CheckedFunction<Req,Request,java.io.IOException> requestConverter, RequestOptions options, CheckedFunction<Response,Resp,java.io.IOException> responseConverter, java.util.Set<java.lang.Integer> ignores)`	Deprecated. If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions.
`protected <Req extends ActionRequest,Resp> Resp`	`performRequestAndParseEntity(Req request, CheckedFunction<Req,Request,java.io.IOException> requestConverter, RequestOptions options, CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser, java.util.Set<java.lang.Integer> ignores)`	Deprecated. If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions.
`protected <Req extends Validatable,Resp> java.util.Optional<Resp>`	`performRequestAndParseOptionalEntity(Req request, CheckedFunction<Req,Request,java.io.IOException> requestConverter, RequestOptions options, CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser)`	Defines a helper method for requests that can 404 and in which case will return an empty Optional otherwise tries to parse the response body
`protected <Req extends ActionRequest,Resp> void`	`performRequestAsync(Req request, CheckedFunction<Req,Request,java.io.IOException> requestConverter, RequestOptions options, CheckedFunction<Response,Resp,java.io.IOException> responseConverter, ActionListener<Resp> listener, java.util.Set<java.lang.Integer> ignores)`	Deprecated. If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions.
`protected <Req extends ActionRequest,Resp> void`	`performRequestAsyncAndParseEntity(Req request, CheckedFunction<Req,Request,java.io.IOException> requestConverter, RequestOptions options, CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser, ActionListener<Resp> listener, java.util.Set<java.lang.Integer> ignores)`	Deprecated. If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions.
`protected <Req extends Validatable,Resp> void`	`performRequestAsyncAndParseOptionalEntity(Req request, CheckedFunction<Req,Request,java.io.IOException> requestConverter, RequestOptions options, CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser, ActionListener<java.util.Optional<Resp>> listener)`	Asynchronous request which returns empty `Optional`s in the case of 404s or parses entity into an Optional
`boolean`	`ping(RequestOptions options)`	Pings the remote Elasticsearch cluster and returns true if the ping succeeded, false otherwise
`AcknowledgedResponse`	`putScript(PutStoredScriptRequest putStoredScriptRequest, RequestOptions options)`	Puts an stored script using the Scripting API.
`void`	`putScriptAsync(PutStoredScriptRequest putStoredScriptRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)`	Asynchronously puts an stored script using the Scripting API.
`RankEvalResponse`	`rankEval(RankEvalRequest rankEvalRequest, RequestOptions options)`	Executes a request using the Ranking Evaluation API.
`void`	`rankEvalAsync(RankEvalRequest rankEvalRequest, RequestOptions options, ActionListener<RankEvalResponse> listener)`	Asynchronously executes a request using the Ranking Evaluation API.
`BulkByScrollResponse`	`reindex(ReindexRequest reindexRequest, RequestOptions options)`	Executes a reindex request.
`void`	`reindexAsync(ReindexRequest reindexRequest, RequestOptions options, ActionListener<BulkByScrollResponse> listener)`	Asynchronously executes a reindex request.
`ListTasksResponse`	`reindexRethrottle(RethrottleRequest rethrottleRequest, RequestOptions options)`	Executes a reindex rethrottling request.
`void`	`reindexRethrottleAsync(RethrottleRequest rethrottleRequest, RequestOptions options, ActionListener<ListTasksResponse> listener)`	Executes a reindex rethrottling request.
`RollupClient`	`rollup()`	Provides methods for accessing the Elastic Licensed Rollup APIs that are shipped with the default distribution of Elasticsearch.
`SearchResponse`	`scroll(SearchScrollRequest searchScrollRequest, RequestOptions options)`	Executes a search using the Search Scroll API.
`void`	`scrollAsync(SearchScrollRequest searchScrollRequest, RequestOptions options, ActionListener<SearchResponse> listener)`	Asynchronously executes a search using the Search Scroll API.
`SearchResponse`	`search(SearchRequest searchRequest, RequestOptions options)`	Executes a search request using the Search API.
`void`	`searchAsync(SearchRequest searchRequest, RequestOptions options, ActionListener<SearchResponse> listener)`	Asynchronously executes a search using the Search API.
`SearchResponse`	`searchScroll(SearchScrollRequest searchScrollRequest, RequestOptions options)`	Deprecated. use `scroll(SearchScrollRequest, RequestOptions)` instead
`void`	`searchScrollAsync(SearchScrollRequest searchScrollRequest, RequestOptions options, ActionListener<SearchResponse> listener)`	Deprecated. use `scrollAsync(SearchScrollRequest, RequestOptions, ActionListener)` instead
`SearchTemplateResponse`	`searchTemplate(SearchTemplateRequest searchTemplateRequest, RequestOptions options)`	Executes a request using the Search Template API.
`void`	`searchTemplateAsync(SearchTemplateRequest searchTemplateRequest, RequestOptions options, ActionListener<SearchTemplateResponse> listener)`	Asynchronously executes a request using the Search Template API.
`SecurityClient`	`security()`	Provides methods for accessing the Elastic Licensed Security APIs that are shipped with the Elastic Stack distribution of Elasticsearch.
`SnapshotClient`	`snapshot()`	Provides a `SnapshotClient` which can be used to access the Snapshot API.
`TaskSubmissionResponse`	`submitReindexTask(ReindexRequest reindexRequest, RequestOptions options)`	Submits a reindex task.
`TasksClient`	`tasks()`	Provides a `TasksClient` which can be used to access the Tasks API.
`TermVectorsResponse`	`termvectors(TermVectorsRequest request, RequestOptions options)`	Calls the Term Vectors API See Term Vectors API on elastic.co
`void`	`termvectorsAsync(TermVectorsRequest request, RequestOptions options, ActionListener<TermVectorsResponse> listener)`	Asynchronously calls the Term Vectors API See Term Vectors API on elastic.co
`UpdateResponse`	`update(UpdateRequest updateRequest, RequestOptions options)`	Updates a document using the Update API.
`void`	`updateAsync(UpdateRequest updateRequest, RequestOptions options, ActionListener<UpdateResponse> listener)`	Asynchronously updates a document using the Update API.
`BulkByScrollResponse`	`updateByQuery(UpdateByQueryRequest updateByQueryRequest, RequestOptions options)`	Executes a update by query request.
`void`	`updateByQueryAsync(UpdateByQueryRequest updateByQueryRequest, RequestOptions options, ActionListener<BulkByScrollResponse> listener)`	Asynchronously executes an update by query request.
`ListTasksResponse`	`updateByQueryRethrottle(RethrottleRequest rethrottleRequest, RequestOptions options)`	Executes a update by query rethrottle request.
`void`	`updateByQueryRethrottleAsync(RethrottleRequest rethrottleRequest, RequestOptions options, ActionListener<ListTasksResponse> listener)`	Asynchronously execute an update by query rethrottle request.
`WatcherClient`	`watcher()`	Provides methods for accessing the Elastic Licensed Watcher APIs that are shipped with the default distribution of Elasticsearch.
`XPackClient`	`xpack()`	Provides methods for accessing the Elastic Licensed X-Pack Info and Usage APIs that are shipped with the default distribution of Elasticsearch.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RestHighLevelClient
```
public RestHighLevelClient(RestClientBuilder restClientBuilder)
```
  Creates a RestHighLevelClient given the low level RestClientBuilder that allows to build the RestClient to be used to perform requests.
- RestHighLevelClient
```
protected RestHighLevelClient(RestClientBuilder restClientBuilder,
                              java.util.List<NamedXContentRegistry.Entry> namedXContentEntries)
```
  Creates a RestHighLevelClient given the low level RestClientBuilder that allows to build the RestClient to be used to perform requests and parsers for custom response sections added to Elasticsearch through plugins.
- RestHighLevelClient
```
protected RestHighLevelClient(RestClient restClient,
                              CheckedConsumer<RestClient,java.io.IOException> doClose,
                              java.util.List<NamedXContentRegistry.Entry> namedXContentEntries)
```
  Creates a RestHighLevelClient given the low level RestClient that it should use to perform requests and a list of entries that allow to parse custom response sections added to Elasticsearch through plugins. This constructor can be called by subclasses in case an externally created low-level REST client needs to be provided. The consumer argument allows to control what needs to be done when the close() method is called. Also subclasses can provide parsers for custom response sections added to Elasticsearch through plugins.

Method Detail

getLowLevelClient
```
public final RestClient getLowLevelClient()
```
Returns the low-level client that the current high-level client instance is using to perform requests

close
```
public final void close()
                 throws java.io.IOException
```
Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

indices
```
public final IndicesClient indices()
```
Provides an IndicesClient which can be used to access the Indices API. See Indices API on elastic.co

cluster
```
public final ClusterClient cluster()
```
Provides a ClusterClient which can be used to access the Cluster API. See Cluster API on elastic.co

ingest
```
public final IngestClient ingest()
```
Provides a IngestClient which can be used to access the Ingest API. See Ingest API on elastic.co

snapshot
```
public final SnapshotClient snapshot()
```
Provides a SnapshotClient which can be used to access the Snapshot API. See Snapshot API on elastic.co

rollup
```
public RollupClient rollup()
```
Provides methods for accessing the Elastic Licensed Rollup APIs that are shipped with the default distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the Watcher APIs on elastic.co for more information.

ccr
```
public final CcrClient ccr()
```
Provides methods for accessing the Elastic Licensed CCR APIs that are shipped with the Elastic Stack distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the CCR APIs on elastic.co for more information.

Returns:

the client wrapper for making CCR API calls

tasks
```
public final TasksClient tasks()
```
Provides a TasksClient which can be used to access the Tasks API. See Task Management API on elastic.co

xpack
```
public final XPackClient xpack()
```
Provides methods for accessing the Elastic Licensed X-Pack Info and Usage APIs that are shipped with the default distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the Info APIs on elastic.co for more information.

watcher
```
public WatcherClient watcher()
```
Provides methods for accessing the Elastic Licensed Watcher APIs that are shipped with the default distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the Watcher APIs on elastic.co for more information.

graph
```
public GraphClient graph()
```
Provides methods for accessing the Elastic Licensed Graph explore API that is shipped with the default distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the Graph API on elastic.co for more information.

license
```
public LicenseClient license()
```
Provides methods for accessing the Elastic Licensed Licensing APIs that are shipped with the default distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the Licensing APIs on elastic.co for more information.

indexLifecycle
```
public IndexLifecycleClient indexLifecycle()
```
A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic Index Lifecycle APIs.
See the X-Pack APIs on elastic.co for more information.

migration
```
public MigrationClient migration()
```
Provides methods for accessing the Elastic Licensed Migration APIs that are shipped with the default distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the Migration APIs on elastic.co for more information.

machineLearning
```
public MachineLearningClient machineLearning()
```
Provides methods for accessing the Elastic Licensed Machine Learning APIs that are shipped with the Elastic Stack distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the Machine Learning APIs on elastic.co for more information.

Returns:

the client wrapper for making Machine Learning API calls

security
```
public SecurityClient security()
```
Provides methods for accessing the Elastic Licensed Security APIs that are shipped with the Elastic Stack distribution of Elasticsearch. All of these APIs will 404 if run against the OSS distribution of Elasticsearch.
See the Security APIs on elastic.co for more information.

Returns:

the client wrapper for making Security API calls

bulk
```
public final BulkResponse bulk(BulkRequest bulkRequest,
                               RequestOptions options)
                        throws java.io.IOException
```
Executes a bulk request using the Bulk API. See Bulk API on elastic.co

Parameters:

bulkRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

bulkAsync
```
public final void bulkAsync(BulkRequest bulkRequest,
                            RequestOptions options,
                            ActionListener<BulkResponse> listener)
```
Asynchronously executes a bulk request using the Bulk API. See Bulk API on elastic.co

Parameters:

bulkRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

reindex

public final BulkByScrollResponse reindex(ReindexRequest reindexRequest,
                                          RequestOptions options)
                                   throws java.io.IOException

Executes a reindex request. See Reindex API on elastic.co

Parameters:: reindexRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

submitReindexTask

public final TaskSubmissionResponse submitReindexTask(ReindexRequest reindexRequest,
                                                      RequestOptions options)
                                               throws java.io.IOException

Submits a reindex task. See Reindex API on elastic.co

Parameters:: reindexRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the submission response
Throws:: java.io.IOException

reindexAsync
```
public final void reindexAsync(ReindexRequest reindexRequest,
                               RequestOptions options,
                               ActionListener<BulkByScrollResponse> listener)
```
Asynchronously executes a reindex request. See Reindex API on elastic.co

Parameters:

reindexRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

updateByQuery

public final BulkByScrollResponse updateByQuery(UpdateByQueryRequest updateByQueryRequest,
                                                RequestOptions options)
                                         throws java.io.IOException

Executes a update by query request. See Update By Query API on elastic.co

Parameters:: updateByQueryRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

updateByQueryAsync
```
public final void updateByQueryAsync(UpdateByQueryRequest updateByQueryRequest,
                                     RequestOptions options,
                                     ActionListener<BulkByScrollResponse> listener)
```
Asynchronously executes an update by query request. See Update By Query API on elastic.co

Parameters:

updateByQueryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

deleteByQuery

public final BulkByScrollResponse deleteByQuery(DeleteByQueryRequest deleteByQueryRequest,
                                                RequestOptions options)
                                         throws java.io.IOException

Executes a delete by query request. See Delete By Query API on elastic.co

Parameters:: deleteByQueryRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

deleteByQueryAsync
```
public final void deleteByQueryAsync(DeleteByQueryRequest deleteByQueryRequest,
                                     RequestOptions options,
                                     ActionListener<BulkByScrollResponse> listener)
```
Asynchronously executes a delete by query request. See Delete By Query API on elastic.co

Parameters:

deleteByQueryRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

deleteByQueryRethrottle

public final ListTasksResponse deleteByQueryRethrottle(RethrottleRequest rethrottleRequest,
                                                       RequestOptions options)
                                                throws java.io.IOException

Executes a delete by query rethrottle request. See Delete By Query API on elastic.co

Parameters:: rethrottleRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

deleteByQueryRethrottleAsync

public final void deleteByQueryRethrottleAsync(RethrottleRequest rethrottleRequest,
                                               RequestOptions options,
                                               ActionListener<ListTasksResponse> listener)

Asynchronously execute an delete by query rethrottle request. See Delete By Query API on elastic.co

Parameters:: rethrottleRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized; listener - the listener to be notified upon request completion

updateByQueryRethrottle

public final ListTasksResponse updateByQueryRethrottle(RethrottleRequest rethrottleRequest,
                                                       RequestOptions options)
                                                throws java.io.IOException

Executes a update by query rethrottle request. See Update By Query API on elastic.co

Parameters:: rethrottleRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

updateByQueryRethrottleAsync

public final void updateByQueryRethrottleAsync(RethrottleRequest rethrottleRequest,
                                               RequestOptions options,
                                               ActionListener<ListTasksResponse> listener)

Asynchronously execute an update by query rethrottle request. See Update By Query API on elastic.co

Parameters:: rethrottleRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized; listener - the listener to be notified upon request completion

reindexRethrottle
```
public final ListTasksResponse reindexRethrottle(RethrottleRequest rethrottleRequest,
                                                 RequestOptions options)
                                          throws java.io.IOException
```
Executes a reindex rethrottling request. See the Reindex rethrottling API on elastic.co

Parameters:

rethrottleRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

reindexRethrottleAsync

public final void reindexRethrottleAsync(RethrottleRequest rethrottleRequest,
                                         RequestOptions options,
                                         ActionListener<ListTasksResponse> listener)

Executes a reindex rethrottling request. See the Reindex rethrottling API on elastic.co

Parameters:: rethrottleRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized; listener - the listener to be notified upon request completion

ping
```
public final boolean ping(RequestOptions options)
                   throws java.io.IOException
```
Pings the remote Elasticsearch cluster and returns true if the ping succeeded, false otherwise

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

true if the ping succeeded, false otherwise

Throws:

java.io.IOException

info
```
public final MainResponse info(RequestOptions options)
                        throws java.io.IOException
```
Get the cluster info otherwise provided when sending an HTTP request to '/'

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

get
```
public final GetResponse get(GetRequest getRequest,
                             RequestOptions options)
                      throws java.io.IOException
```
Retrieves a document by id using the Get API. See Get API on elastic.co

Parameters:

getRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

getAsync
```
public final void getAsync(GetRequest getRequest,
                           RequestOptions options,
                           ActionListener<GetResponse> listener)
```
Asynchronously retrieves a document by id using the Get API. See Get API on elastic.co

Parameters:

getRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

multiGet
```
@Deprecated
public final MultiGetResponse multiGet(MultiGetRequest multiGetRequest,
                                       RequestOptions options)
                                throws java.io.IOException
```
Deprecated.
use mget(MultiGetRequest, RequestOptions) instead

Retrieves multiple documents by id using the Multi Get API. See Multi Get API on elastic.co

Parameters:

multiGetRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

mget
```
public final MultiGetResponse mget(MultiGetRequest multiGetRequest,
                                   RequestOptions options)
                            throws java.io.IOException
```
Retrieves multiple documents by id using the Multi Get API. See Multi Get API on elastic.co

Parameters:

multiGetRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

multiGetAsync
```
@Deprecated
public final void multiGetAsync(MultiGetRequest multiGetRequest,
                                RequestOptions options,
                                ActionListener<MultiGetResponse> listener)
```
Deprecated.
use mgetAsync(MultiGetRequest, RequestOptions, ActionListener) instead

Asynchronously retrieves multiple documents by id using the Multi Get API. See Multi Get API on elastic.co

Parameters:

multiGetRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

mgetAsync
```
public final void mgetAsync(MultiGetRequest multiGetRequest,
                            RequestOptions options,
                            ActionListener<MultiGetResponse> listener)
```
Asynchronously retrieves multiple documents by id using the Multi Get API. See Multi Get API on elastic.co

Parameters:

multiGetRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

exists
```
public final boolean exists(GetRequest getRequest,
                            RequestOptions options)
                     throws java.io.IOException
```
Checks for the existence of a document. Returns true if it exists, false otherwise. See Get API on elastic.co

Parameters:

getRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

true if the document exists, false otherwise

Throws:

java.io.IOException

existsAsync
```
public final void existsAsync(GetRequest getRequest,
                              RequestOptions options,
                              ActionListener<java.lang.Boolean> listener)
```
Asynchronously checks for the existence of a document. Returns true if it exists, false otherwise. See Get API on elastic.co

Parameters:

getRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

existsSource
```
public boolean existsSource(GetRequest getRequest,
                            RequestOptions options)
                     throws java.io.IOException
```
Checks for the existence of a document with a "_source" field. Returns true if it exists, false otherwise. See Source exists API on elastic.co

Parameters:

getRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

true if the document and _source field exists, false otherwise

Throws:

java.io.IOException

existsSourceAsync
```
public final void existsSourceAsync(GetRequest getRequest,
                                    RequestOptions options,
                                    ActionListener<java.lang.Boolean> listener)
```
Asynchronously checks for the existence of a document with a "_source" field. Returns true if it exists, false otherwise. See Source exists API on elastic.co

Parameters:

getRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

index
```
public final IndexResponse index(IndexRequest indexRequest,
                                 RequestOptions options)
                          throws java.io.IOException
```
Index a document using the Index API. See Index API on elastic.co

Parameters:

indexRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

indexAsync
```
public final void indexAsync(IndexRequest indexRequest,
                             RequestOptions options,
                             ActionListener<IndexResponse> listener)
```
Asynchronously index a document using the Index API. See Index API on elastic.co

Parameters:

indexRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

count
```
public final CountResponse count(CountRequest countRequest,
                                 RequestOptions options)
                          throws java.io.IOException
```
Executes a count request using the Count API. See Count API on elastic.co

Parameters:

countRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

countAsync
```
public final void countAsync(CountRequest countRequest,
                             RequestOptions options,
                             ActionListener<CountResponse> listener)
```
Asynchronously executes a count request using the Count API. See Count API on elastic.co

Parameters:

countRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

update
```
public final UpdateResponse update(UpdateRequest updateRequest,
                                   RequestOptions options)
                            throws java.io.IOException
```
Updates a document using the Update API. See Update API on elastic.co

Parameters:

updateRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

updateAsync
```
public final void updateAsync(UpdateRequest updateRequest,
                              RequestOptions options,
                              ActionListener<UpdateResponse> listener)
```
Asynchronously updates a document using the Update API. See Update API on elastic.co

Parameters:

updateRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

delete
```
public final DeleteResponse delete(DeleteRequest deleteRequest,
                                   RequestOptions options)
                            throws java.io.IOException
```
Deletes a document by id using the Delete API. See Delete API on elastic.co

Parameters:

deleteRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

deleteAsync
```
public final void deleteAsync(DeleteRequest deleteRequest,
                              RequestOptions options,
                              ActionListener<DeleteResponse> listener)
```
Asynchronously deletes a document by id using the Delete API. See Delete API on elastic.co

Parameters:

deleteRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

search
```
public final SearchResponse search(SearchRequest searchRequest,
                                   RequestOptions options)
                            throws java.io.IOException
```
Executes a search request using the Search API. See Search API on elastic.co

Parameters:

searchRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

searchAsync
```
public final void searchAsync(SearchRequest searchRequest,
                              RequestOptions options,
                              ActionListener<SearchResponse> listener)
```
Asynchronously executes a search using the Search API. See Search API on elastic.co

Parameters:

searchRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

multiSearch
```
@Deprecated
public final MultiSearchResponse multiSearch(MultiSearchRequest multiSearchRequest,
                                             RequestOptions options)
                                      throws java.io.IOException
```
Deprecated.
use msearch(MultiSearchRequest, RequestOptions) instead

Executes a multi search using the msearch API. See Multi search API on elastic.co

Parameters:

multiSearchRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

msearch
```
public final MultiSearchResponse msearch(MultiSearchRequest multiSearchRequest,
                                         RequestOptions options)
                                  throws java.io.IOException
```
Executes a multi search using the msearch API. See Multi search API on elastic.co

Parameters:

multiSearchRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

multiSearchAsync
```
@Deprecated
public final void multiSearchAsync(MultiSearchRequest searchRequest,
                                   RequestOptions options,
                                   ActionListener<MultiSearchResponse> listener)
```
Deprecated.
use msearchAsync(MultiSearchRequest, RequestOptions, ActionListener) instead

Asynchronously executes a multi search using the msearch API. See Multi search API on elastic.co

Parameters:

searchRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

msearchAsync
```
public final void msearchAsync(MultiSearchRequest searchRequest,
                               RequestOptions options,
                               ActionListener<MultiSearchResponse> listener)
```
Asynchronously executes a multi search using the msearch API. See Multi search API on elastic.co

Parameters:

searchRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

searchScroll
```
@Deprecated
public final SearchResponse searchScroll(SearchScrollRequest searchScrollRequest,
                                         RequestOptions options)
                                  throws java.io.IOException
```
Deprecated.
use scroll(SearchScrollRequest, RequestOptions) instead

Executes a search using the Search Scroll API. See Search Scroll API on elastic.co

Parameters:

searchScrollRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

scroll
```
public final SearchResponse scroll(SearchScrollRequest searchScrollRequest,
                                   RequestOptions options)
                            throws java.io.IOException
```
Executes a search using the Search Scroll API. See Search Scroll API on elastic.co

Parameters:

searchScrollRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

searchScrollAsync
```
@Deprecated
public final void searchScrollAsync(SearchScrollRequest searchScrollRequest,
                                    RequestOptions options,
                                    ActionListener<SearchResponse> listener)
```
Deprecated.
use scrollAsync(SearchScrollRequest, RequestOptions, ActionListener) instead

Asynchronously executes a search using the Search Scroll API. See Search Scroll API on elastic.co

Parameters:

searchScrollRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

scrollAsync
```
public final void scrollAsync(SearchScrollRequest searchScrollRequest,
                              RequestOptions options,
                              ActionListener<SearchResponse> listener)
```
Asynchronously executes a search using the Search Scroll API. See Search Scroll API on elastic.co

Parameters:

searchScrollRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

clearScroll
```
public final ClearScrollResponse clearScroll(ClearScrollRequest clearScrollRequest,
                                             RequestOptions options)
                                      throws java.io.IOException
```
Clears one or more scroll ids using the Clear Scroll API. See Clear Scroll API on elastic.co

Parameters:

clearScrollRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

clearScrollAsync
```
public final void clearScrollAsync(ClearScrollRequest clearScrollRequest,
                                   RequestOptions options,
                                   ActionListener<ClearScrollResponse> listener)
```
Asynchronously clears one or more scroll ids using the Clear Scroll API. See Clear Scroll API on elastic.co

Parameters:

clearScrollRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

searchTemplate

public final SearchTemplateResponse searchTemplate(SearchTemplateRequest searchTemplateRequest,
                                                   RequestOptions options)
                                            throws java.io.IOException

Executes a request using the Search Template API. See Search Template API on elastic.co.

Parameters:: searchTemplateRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

searchTemplateAsync

public final void searchTemplateAsync(SearchTemplateRequest searchTemplateRequest,
                                      RequestOptions options,
                                      ActionListener<SearchTemplateResponse> listener)

Asynchronously executes a request using the Search Template API. See Search Template API on elastic.co.

explain
```
public final ExplainResponse explain(ExplainRequest explainRequest,
                                     RequestOptions options)
                              throws java.io.IOException
```
Executes a request using the Explain API. See Explain API on elastic.co

Parameters:

explainRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

explainAsync
```
public final void explainAsync(ExplainRequest explainRequest,
                               RequestOptions options,
                               ActionListener<ExplainResponse> listener)
```
Asynchronously executes a request using the Explain API. See Explain API on elastic.co

Parameters:

explainRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

termvectors

public final TermVectorsResponse termvectors(TermVectorsRequest request,
                                             RequestOptions options)
                                      throws java.io.IOException

Calls the Term Vectors API See Term Vectors API on elastic.co

Parameters:: request - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Throws:: java.io.IOException

termvectorsAsync
```
public final void termvectorsAsync(TermVectorsRequest request,
                                   RequestOptions options,
                                   ActionListener<TermVectorsResponse> listener)
```
Asynchronously calls the Term Vectors API See Term Vectors API on elastic.co

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

mtermvectors

public final MultiTermVectorsResponse mtermvectors(MultiTermVectorsRequest request,
                                                   RequestOptions options)
                                            throws java.io.IOException

Calls the Multi Term Vectors API See Multi Term Vectors API on elastic.co

Parameters:: request - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Throws:: java.io.IOException

mtermvectorsAsync
```
public final void mtermvectorsAsync(MultiTermVectorsRequest request,
                                    RequestOptions options,
                                    ActionListener<MultiTermVectorsResponse> listener)
```
Asynchronously calls the Multi Term Vectors API See Multi Term Vectors API on elastic.co

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

rankEval
```
public final RankEvalResponse rankEval(RankEvalRequest rankEvalRequest,
                                       RequestOptions options)
                                throws java.io.IOException
```
Executes a request using the Ranking Evaluation API. See Ranking Evaluation API on elastic.co

Parameters:

rankEvalRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

msearchTemplate

public final MultiSearchTemplateResponse msearchTemplate(MultiSearchTemplateRequest multiSearchTemplateRequest,
                                                         RequestOptions options)
                                                  throws java.io.IOException

Executes a request using the Multi Search Template API. See Multi Search Template API on elastic.co.

Throws:: java.io.IOException

msearchTemplateAsync

public final void msearchTemplateAsync(MultiSearchTemplateRequest multiSearchTemplateRequest,
                                       RequestOptions options,
                                       ActionListener<MultiSearchTemplateResponse> listener)

Asynchronously executes a request using the Multi Search Template API See Multi Search Template API on elastic.co.

rankEvalAsync
```
public final void rankEvalAsync(RankEvalRequest rankEvalRequest,
                                RequestOptions options,
                                ActionListener<RankEvalResponse> listener)
```
Asynchronously executes a request using the Ranking Evaluation API. See Ranking Evaluation API on elastic.co

Parameters:

rankEvalRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

fieldCaps

public final FieldCapabilitiesResponse fieldCaps(FieldCapabilitiesRequest fieldCapabilitiesRequest,
                                                 RequestOptions options)
                                          throws java.io.IOException

Executes a request using the Field Capabilities API. See Field Capabilities API on elastic.co.

Parameters:: fieldCapabilitiesRequest - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

getScript

public GetStoredScriptResponse getScript(GetStoredScriptRequest request,
                                         RequestOptions options)
                                  throws java.io.IOException

Get stored script by id. See How to use scripts on elastic.co

Parameters:: request - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

getScriptAsync
```
public void getScriptAsync(GetStoredScriptRequest request,
                           RequestOptions options,
                           ActionListener<GetStoredScriptResponse> listener)
```
Asynchronously get stored script by id. See How to use scripts on elastic.co

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

deleteScript

public AcknowledgedResponse deleteScript(DeleteStoredScriptRequest request,
                                         RequestOptions options)
                                  throws java.io.IOException

Delete stored script by id. See How to use scripts on elastic.co

Parameters:: request - the request; options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
Returns:: the response
Throws:: java.io.IOException

deleteScriptAsync
```
public void deleteScriptAsync(DeleteStoredScriptRequest request,
                              RequestOptions options,
                              ActionListener<AcknowledgedResponse> listener)
```
Asynchronously delete stored script by id. See How to use scripts on elastic.co

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

putScript
```
public AcknowledgedResponse putScript(PutStoredScriptRequest putStoredScriptRequest,
                                      RequestOptions options)
                               throws java.io.IOException
```
Puts an stored script using the Scripting API. See Scripting API on elastic.co

Parameters:

putStoredScriptRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException

putScriptAsync
```
public void putScriptAsync(PutStoredScriptRequest putStoredScriptRequest,
                           RequestOptions options,
                           ActionListener<AcknowledgedResponse> listener)
```
Asynchronously puts an stored script using the Scripting API. See Scripting API on elastic.co

Parameters:

putStoredScriptRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

fieldCapsAsync
```
public final void fieldCapsAsync(FieldCapabilitiesRequest fieldCapabilitiesRequest,
                                 RequestOptions options,
                                 ActionListener<FieldCapabilitiesResponse> listener)
```
Asynchronously executes a request using the Field Capabilities API. See Field Capabilities API on elastic.co.

Parameters:

fieldCapabilitiesRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

performRequestAndParseEntity

@Deprecated
protected final <Req extends ActionRequest,Resp> Resp performRequestAndParseEntity(Req request,
                                                                                         CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                                         RequestOptions options,
                                                                                         CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser,
                                                                                         java.util.Set<java.lang.Integer> ignores)
                                                                                  throws java.io.IOException

Deprecated.

If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions. The Validation layer has been added to the ReST client, and requests should extend Validatable instead of ActionRequest.

Throws:: java.io.IOException

performRequestAndParseEntity

protected final <Req extends Validatable,Resp> Resp performRequestAndParseEntity(Req request,
                                                                                       CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                                       RequestOptions options,
                                                                                       CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser,
                                                                                       java.util.Set<java.lang.Integer> ignores)
                                                                                throws java.io.IOException

Defines a helper method for performing a request and then parsing the returned entity using the provided entityParser.

Throws:: java.io.IOException

performRequest

@Deprecated
protected final <Req extends ActionRequest,Resp> Resp performRequest(Req request,
                                                                           CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                           RequestOptions options,
                                                                           CheckedFunction<Response,Resp,java.io.IOException> responseConverter,
                                                                           java.util.Set<java.lang.Integer> ignores)
                                                                    throws java.io.IOException

Deprecated.

If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions. The Validation layer has been added to the ReST client, and requests should extend Validatable instead of ActionRequest.

Throws:: java.io.IOException

performRequest

protected final <Req extends Validatable,Resp> Resp performRequest(Req request,
                                                                         CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                         RequestOptions options,
                                                                         CheckedFunction<Response,Resp,java.io.IOException> responseConverter,
                                                                         java.util.Set<java.lang.Integer> ignores)
                                                                  throws java.io.IOException

Defines a helper method for performing a request.

Throws:: java.io.IOException

performRequestAndParseOptionalEntity

protected final <Req extends Validatable,Resp> java.util.Optional<Resp> performRequestAndParseOptionalEntity(Req request,
                                                                                                                   CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                                                                   RequestOptions options,
                                                                                                                   CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser)
                                                                                                            throws java.io.IOException

Defines a helper method for requests that can 404 and in which case will return an empty Optional otherwise tries to parse the response body

Throws:: java.io.IOException

performRequestAsyncAndParseEntity

@Deprecated
protected final <Req extends ActionRequest,Resp> void performRequestAsyncAndParseEntity(Req request,
                                                                                              CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                                              RequestOptions options,
                                                                                              CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser,
                                                                                              ActionListener<Resp> listener,
                                                                                              java.util.Set<java.lang.Integer> ignores)

Deprecated.

If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions. The Validation layer has been added to the ReST client, and requests should extend Validatable instead of ActionRequest.

performRequestAsyncAndParseEntity

protected final <Req extends Validatable,Resp> void performRequestAsyncAndParseEntity(Req request,
                                                                                            CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                                            RequestOptions options,
                                                                                            CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser,
                                                                                            ActionListener<Resp> listener,
                                                                                            java.util.Set<java.lang.Integer> ignores)

Defines a helper method for asynchronously performing a request.

performRequestAsync

@Deprecated
protected final <Req extends ActionRequest,Resp> void performRequestAsync(Req request,
                                                                                CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                                RequestOptions options,
                                                                                CheckedFunction<Response,Resp,java.io.IOException> responseConverter,
                                                                                ActionListener<Resp> listener,
                                                                                java.util.Set<java.lang.Integer> ignores)

Deprecated.

If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions. The Validation layer has been added to the ReST client, and requests should extend Validatable instead of ActionRequest.

performRequestAsync

protected final <Req extends Validatable,Resp> void performRequestAsync(Req request,
                                                                              CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                              RequestOptions options,
                                                                              CheckedFunction<Response,Resp,java.io.IOException> responseConverter,
                                                                              ActionListener<Resp> listener,
                                                                              java.util.Set<java.lang.Integer> ignores)

Defines a helper method for asynchronously performing a request.

performRequestAsyncAndParseOptionalEntity

protected final <Req extends Validatable,Resp> void performRequestAsyncAndParseOptionalEntity(Req request,
                                                                                                    CheckedFunction<Req,Request,java.io.IOException> requestConverter,
                                                                                                    RequestOptions options,
                                                                                                    CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser,
                                                                                                    ActionListener<java.util.Optional<Resp>> listener)

Asynchronous request which returns empty Optionals in the case of 404s or parses entity into an Optional

parseResponseException
```
protected final ElasticsearchStatusException parseResponseException(ResponseException responseException)
```
Converts a ResponseException obtained from the low level REST client into an ElasticsearchException. If a response body was returned, tries to parse it as an error returned from Elasticsearch. If no response body was returned or anything goes wrong while parsing the error, returns a new ElasticsearchStatusException that wraps the original ResponseException. The potential exception obtained while parsing is added to the returned exception as a suppressed exception. This method is guaranteed to not throw any exception eventually thrown while parsing.

parseEntity

protected final <Resp> Resp parseEntity(org.apache.http.HttpEntity entity,
                                        CheckedFunction<XContentParser,Resp,java.io.IOException> entityParser)
                                 throws java.io.IOException

Throws:: java.io.IOException

convertExistsResponse

protected static boolean convertExistsResponse(Response response)

Class RestHighLevelClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestHighLevelClient

RestHighLevelClient

RestHighLevelClient

Method Detail

getLowLevelClient

close

indices

cluster

ingest

snapshot

rollup

ccr

tasks

xpack

watcher

graph

license

indexLifecycle

migration

machineLearning

security

bulk

bulkAsync

reindex

submitReindexTask

reindexAsync

updateByQuery

updateByQueryAsync

deleteByQuery

deleteByQueryAsync

deleteByQueryRethrottle

deleteByQueryRethrottleAsync

updateByQueryRethrottle

updateByQueryRethrottleAsync

reindexRethrottle

reindexRethrottleAsync

ping

info

get

getAsync

multiGet

mget

multiGetAsync

mgetAsync

exists

existsAsync

existsSource

existsSourceAsync

index

indexAsync

count

countAsync

update

updateAsync

delete

deleteAsync

search

searchAsync

multiSearch

msearch

multiSearchAsync

msearchAsync

searchScroll

scroll

searchScrollAsync

scrollAsync

clearScroll

clearScrollAsync

searchTemplate

searchTemplateAsync

explain

explainAsync

termvectors

termvectorsAsync

mtermvectors