Package org.elasticsearch.client

Class RestHighLevelClient

java.lang.Object
org.elasticsearch.client.RestHighLevelClient
All Implemented Interfaces:
Closeable, AutoCloseable
@Deprecated public class RestHighLevelClient extends Object implements Closeable
Deprecated.
The High Level Rest Client is deprecated in favor of the Elasticsearch Java API Client
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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    API_VERSIONING_ENV_VARIABLE
    Deprecated.
    Environment variable determining whether to send the 7.x compatibility header

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    RestHighLevelClient(org.elasticsearch.client.RestClientBuilder restClientBuilder)
    Deprecated.
    Creates a RestHighLevelClient given the low level RestClientBuilder that allows to build the RestClient to be used to perform requests.
    protected
    RestHighLevelClient(org.elasticsearch.client.RestClientBuilder restClientBuilder, List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry> namedXContentEntries)
    Deprecated.
    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(org.elasticsearch.client.RestClient restClient, org.elasticsearch.core.CheckedConsumer<org.elasticsearch.client.RestClient,IOException> doClose, List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry> namedXContentEntries)
    Deprecated.
    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.
    protected
    RestHighLevelClient(org.elasticsearch.client.RestClient restClient, org.elasticsearch.core.CheckedConsumer<org.elasticsearch.client.RestClient,IOException> doClose, List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry> namedXContentEntries, Boolean useAPICompatibility)
    Deprecated.
    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
    AsyncSearchClient
    asyncSearch()
    Deprecated.
    A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic Index Async Search APIs.
    final org.elasticsearch.action.bulk.BulkResponse
    bulk(org.elasticsearch.action.bulk.BulkRequest bulkRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a bulk request using the Bulk API.
    final org.elasticsearch.client.Cancellable
    bulkAsync(org.elasticsearch.action.bulk.BulkRequest bulkRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.bulk.BulkResponse> listener)
    Deprecated.
    Asynchronously executes a bulk request using the Bulk API.
    final CcrClient
    ccr()
    Deprecated.
    Provides methods for accessing the Elastic Licensed CCR APIs that are shipped with the Elastic Stack distribution of Elasticsearch.
    final org.elasticsearch.action.search.ClearScrollResponse
    clearScroll(org.elasticsearch.action.search.ClearScrollRequest clearScrollRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Clears one or more scroll ids using the Clear Scroll API.
    final org.elasticsearch.client.Cancellable
    clearScrollAsync(org.elasticsearch.action.search.ClearScrollRequest clearScrollRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.ClearScrollResponse> listener)
    Deprecated.
    Asynchronously clears one or more scroll ids using the Clear Scroll API.
    final void
    close()
    Deprecated.
     
    final org.elasticsearch.action.search.ClosePointInTimeResponse
    closePointInTime(org.elasticsearch.action.search.ClosePointInTimeRequest closeRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Close a point in time that is opened with openPointInTime(OpenPointInTimeRequest, RequestOptions) or openPointInTimeAsync(OpenPointInTimeRequest, RequestOptions, ActionListener).
    final org.elasticsearch.client.Cancellable
    closePointInTimeAsync(org.elasticsearch.action.search.ClosePointInTimeRequest closeRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.ClosePointInTimeResponse> listener)
    Deprecated.
    Asynchronously close a point in time that is opened with openPointInTime(OpenPointInTimeRequest, RequestOptions) or openPointInTimeAsync(OpenPointInTimeRequest, RequestOptions, ActionListener).
    final ClusterClient
    cluster()
    Deprecated.
    Provides a ClusterClient which can be used to access the Cluster API.
    protected static boolean
    convertExistsResponse(org.elasticsearch.client.Response response)
    Deprecated.
     
    final CountResponse
    count(CountRequest countRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a count request using the Count API.
    final org.elasticsearch.client.Cancellable
    countAsync(CountRequest countRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<CountResponse> listener)
    Deprecated.
    Asynchronously executes a count request using the Count API.
    final org.elasticsearch.action.delete.DeleteResponse
    delete(org.elasticsearch.action.delete.DeleteRequest deleteRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Deletes a document by id using the Delete API.
    final org.elasticsearch.client.Cancellable
    deleteAsync(org.elasticsearch.action.delete.DeleteRequest deleteRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.delete.DeleteResponse> listener)
    Deprecated.
    Asynchronously deletes a document by id using the Delete API.
    final org.elasticsearch.index.reindex.BulkByScrollResponse
    deleteByQuery(org.elasticsearch.index.reindex.DeleteByQueryRequest deleteByQueryRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a delete by query request.
    final org.elasticsearch.client.Cancellable
    deleteByQueryAsync(org.elasticsearch.index.reindex.DeleteByQueryRequest deleteByQueryRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.index.reindex.BulkByScrollResponse> listener)
    Deprecated.
    Asynchronously executes a delete by query request.
    final org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse
    deleteByQueryRethrottle(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a delete by query rethrottle request.
    final org.elasticsearch.client.Cancellable
    deleteByQueryRethrottleAsync(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse> listener)
    Deprecated.
    Asynchronously execute an delete by query rethrottle request.
    org.elasticsearch.action.support.master.AcknowledgedResponse
    deleteScript(org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequest request, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Delete stored script by id.
    org.elasticsearch.client.Cancellable
    deleteScriptAsync(org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
    Deprecated.
    Asynchronously delete stored script by id.
    EnrichClient
    enrich()
    Deprecated.
     
    final EqlClient
    eql()
    Deprecated.
    Provides methods for accessing the Elastic EQL APIs that are shipped with the Elastic Stack distribution of Elasticsearch.
    final boolean
    exists(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Checks for the existence of a document.
    final org.elasticsearch.client.Cancellable
    existsAsync(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<Boolean> listener)
    Deprecated.
    Asynchronously checks for the existence of a document.
    boolean
    existsSource(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    use existsSource(GetSourceRequest, RequestOptions) instead
    boolean
    existsSource(GetSourceRequest getSourceRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Checks for the existence of a document with a "_source" field.
    final org.elasticsearch.client.Cancellable
    existsSourceAsync(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<Boolean> listener)
    Deprecated.
    use existsSourceAsync(GetSourceRequest, RequestOptions, ActionListener) instead
    final org.elasticsearch.client.Cancellable
    existsSourceAsync(GetSourceRequest getSourceRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<Boolean> listener)
    Deprecated.
    Asynchronously checks for the existence of a document with a "_source" field.
    final org.elasticsearch.action.explain.ExplainResponse
    explain(org.elasticsearch.action.explain.ExplainRequest explainRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a request using the Explain API.
    final org.elasticsearch.client.Cancellable
    explainAsync(org.elasticsearch.action.explain.ExplainRequest explainRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.explain.ExplainResponse> listener)
    Deprecated.
    Asynchronously executes a request using the Explain API.
    FeaturesClient
    features()
    Deprecated.
    A wrapper for the RestHighLevelClient that provides methods for accessing the Searchable Snapshots APIs.
    final org.elasticsearch.action.fieldcaps.FieldCapabilitiesResponse
    fieldCaps(org.elasticsearch.action.fieldcaps.FieldCapabilitiesRequest fieldCapabilitiesRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a request using the Field Capabilities API.
    final org.elasticsearch.client.Cancellable
    fieldCapsAsync(org.elasticsearch.action.fieldcaps.FieldCapabilitiesRequest fieldCapabilitiesRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.fieldcaps.FieldCapabilitiesResponse> listener)
    Deprecated.
    Asynchronously executes a request using the Field Capabilities API.
    final org.elasticsearch.action.get.GetResponse
    get(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Retrieves a document by id using the Get API.
    final org.elasticsearch.client.Cancellable
    getAsync(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.get.GetResponse> listener)
    Deprecated.
    Asynchronously retrieves a document by id using the Get API.
    final org.elasticsearch.client.RestClient
    getLowLevelClient()
    Deprecated.
    Returns the low-level client that the current high-level client instance is using to perform requests
    org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptResponse
    getScript(org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequest request, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Get stored script by id.
    org.elasticsearch.client.Cancellable
    getScriptAsync(org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptResponse> listener)
    Deprecated.
    Asynchronously get stored script by id.
    GetSourceResponse
    getSource(GetSourceRequest getSourceRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Retrieves the source field only of a document using GetSource API.
    final org.elasticsearch.client.Cancellable
    getSourceAsync(GetSourceRequest getSourceRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetSourceResponse> listener)
    Deprecated.
    Asynchronously retrieves the source field only of a document using GetSource API.
    GraphClient
    graph()
    Deprecated.
    Provides methods for accessing the Elastic Licensed Graph explore API that is shipped with the default distribution of Elasticsearch.
    final org.elasticsearch.action.index.IndexResponse
    index(org.elasticsearch.action.index.IndexRequest indexRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Index a document using the Index API.
    final org.elasticsearch.client.Cancellable
    indexAsync(org.elasticsearch.action.index.IndexRequest indexRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.index.IndexResponse> listener)
    Deprecated.
    Asynchronously index a document using the Index API.
    IndexLifecycleClient
    indexLifecycle()
    Deprecated.
    A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic Index Lifecycle APIs.
    final IndicesClient
    indices()
    Deprecated.
    Provides an IndicesClient which can be used to access the Indices API.
    final MainResponse
    info(org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Get the cluster info otherwise provided when sending an HTTP request to '/'
    final IngestClient
    ingest()
    Deprecated.
    Provides a IngestClient which can be used to access the Ingest API.
    LicenseClient
    license()
    Deprecated.
    Provides methods for accessing the Elastic Licensed Licensing APIs that are shipped with the default distribution of Elasticsearch.
    MachineLearningClient
    machineLearning()
    Deprecated.
    Provides methods for accessing the Elastic Licensed Machine Learning APIs that are shipped with the Elastic Stack distribution of Elasticsearch.
    final org.elasticsearch.action.get.MultiGetResponse
    mget(org.elasticsearch.action.get.MultiGetRequest multiGetRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Retrieves multiple documents by id using the Multi Get API.
    final org.elasticsearch.client.Cancellable
    mgetAsync(org.elasticsearch.action.get.MultiGetRequest multiGetRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.get.MultiGetResponse> listener)
    Deprecated.
    Asynchronously retrieves multiple documents by id using the Multi Get API.
    MigrationClient
    migration()
    Deprecated.
    Provides methods for accessing the Elastic Licensed Migration APIs that are shipped with the default distribution of Elasticsearch.
    final org.elasticsearch.action.search.MultiSearchResponse
    msearch(org.elasticsearch.action.search.MultiSearchRequest multiSearchRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a multi search using the msearch API.
    final org.elasticsearch.client.Cancellable
    msearchAsync(org.elasticsearch.action.search.MultiSearchRequest searchRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.MultiSearchResponse> listener)
    Deprecated.
    Asynchronously executes a multi search using the msearch API.
    final org.elasticsearch.script.mustache.MultiSearchTemplateResponse
    msearchTemplate(org.elasticsearch.script.mustache.MultiSearchTemplateRequest multiSearchTemplateRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a request using the Multi Search Template API.
    final org.elasticsearch.client.Cancellable
    msearchTemplateAsync(org.elasticsearch.script.mustache.MultiSearchTemplateRequest multiSearchTemplateRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.script.mustache.MultiSearchTemplateResponse> listener)
    Deprecated.
    Asynchronously executes a request using the Multi Search Template API See Multi Search Template API on elastic.co.
    final MultiTermVectorsResponse
    mtermvectors(MultiTermVectorsRequest request, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Calls the Multi Term Vectors API See Multi Term Vectors API on elastic.co
    final org.elasticsearch.client.Cancellable
    mtermvectorsAsync(MultiTermVectorsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<MultiTermVectorsResponse> listener)
    Deprecated.
    Asynchronously calls the Multi Term Vectors API See Multi Term Vectors API on elastic.co
    final org.elasticsearch.action.get.MultiGetResponse
    multiGet(org.elasticsearch.action.get.MultiGetRequest multiGetRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    use mget(MultiGetRequest, RequestOptions) instead
    final org.elasticsearch.client.Cancellable
    multiGetAsync(org.elasticsearch.action.get.MultiGetRequest multiGetRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.get.MultiGetResponse> listener)
    Deprecated.
    use mgetAsync(MultiGetRequest, RequestOptions, ActionListener) instead
    final org.elasticsearch.action.search.MultiSearchResponse
    multiSearch(org.elasticsearch.action.search.MultiSearchRequest multiSearchRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    use msearch(MultiSearchRequest, RequestOptions) instead
    final org.elasticsearch.client.Cancellable
    multiSearchAsync(org.elasticsearch.action.search.MultiSearchRequest searchRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.MultiSearchResponse> listener)
    Deprecated.
    use msearchAsync(MultiSearchRequest, RequestOptions, ActionListener) instead
    final org.elasticsearch.action.search.OpenPointInTimeResponse
    openPointInTime(org.elasticsearch.action.search.OpenPointInTimeRequest openRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Open a point in time before using it in search requests.
    final org.elasticsearch.client.Cancellable
    openPointInTimeAsync(org.elasticsearch.action.search.OpenPointInTimeRequest openRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.OpenPointInTimeResponse> listener)
    Deprecated.
    Asynchronously open a point in time before using it in search requests See Point in time API
    protected final <Resp> Resp
    parseEntity(org.apache.http.HttpEntity entity, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser)
    Deprecated.
     
    protected final org.elasticsearch.ElasticsearchStatusException
    parseResponseException(org.elasticsearch.client.ResponseException responseException)
    Deprecated.
    Converts a ResponseException obtained from the low level REST client into an ElasticsearchException.
    protected final <Req extends org.elasticsearch.action.ActionRequest, Resp>
    Resp
    performRequest(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.client.Response,Resp,IOException> responseConverter, Set<Integer> ignores)
    Deprecated.
    If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions.
    protected final <Req extends org.elasticsearch.action.ActionRequest, Resp>
    Resp
    performRequestAndParseEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser, Set<Integer> ignores)
    Deprecated.
    If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions.
    protected final <Req extends Validatable, Resp>
    Optional<Resp>
    performRequestAndParseOptionalEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser)
    Deprecated.
    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 final <Req extends org.elasticsearch.action.ActionRequest, Resp>
    org.elasticsearch.client.Cancellable
    performRequestAsync(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.client.Response,Resp,IOException> responseConverter, org.elasticsearch.action.ActionListener<Resp> listener, Set<Integer> ignores)
    Deprecated.
    If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions.
    protected final <Req extends org.elasticsearch.action.ActionRequest, Resp>
    org.elasticsearch.client.Cancellable
    performRequestAsyncAndParseEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser, org.elasticsearch.action.ActionListener<Resp> listener, Set<Integer> ignores)
    Deprecated.
    If creating a new HLRC ReST API call, consider creating new actions instead of reusing server actions.
    protected final <Req extends Validatable, Resp>
    org.elasticsearch.client.Cancellable
    performRequestAsyncAndParseOptionalEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser, org.elasticsearch.action.ActionListener<Optional<Resp>> listener)
    Deprecated.
    Asynchronous request which returns empty Optionals in the case of 404s or parses entity into an Optional
    final boolean
    ping(org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Pings the remote Elasticsearch cluster and returns true if the ping succeeded, false otherwise
    org.elasticsearch.action.support.master.AcknowledgedResponse
    putScript(org.elasticsearch.action.admin.cluster.storedscripts.PutStoredScriptRequest putStoredScriptRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Puts an stored script using the Scripting API.
    org.elasticsearch.client.Cancellable
    putScriptAsync(org.elasticsearch.action.admin.cluster.storedscripts.PutStoredScriptRequest putStoredScriptRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
    Deprecated.
    Asynchronously puts an stored script using the Scripting API.
    final org.elasticsearch.index.rankeval.RankEvalResponse
    rankEval(org.elasticsearch.index.rankeval.RankEvalRequest rankEvalRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a request using the Ranking Evaluation API.
    final org.elasticsearch.client.Cancellable
    rankEvalAsync(org.elasticsearch.index.rankeval.RankEvalRequest rankEvalRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.index.rankeval.RankEvalResponse> listener)
    Deprecated.
    Asynchronously executes a request using the Ranking Evaluation API.
    final org.elasticsearch.index.reindex.BulkByScrollResponse
    reindex(org.elasticsearch.index.reindex.ReindexRequest reindexRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a reindex request.
    final org.elasticsearch.client.Cancellable
    reindexAsync(org.elasticsearch.index.reindex.ReindexRequest reindexRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.index.reindex.BulkByScrollResponse> listener)
    Deprecated.
    Asynchronously executes a reindex request.
    final org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse
    reindexRethrottle(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a reindex rethrottling request.
    final org.elasticsearch.client.Cancellable
    reindexRethrottleAsync(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse> listener)
    Deprecated.
    Executes a reindex rethrottling request.
    RollupClient
    rollup()
    Deprecated.
    Provides methods for accessing the Elastic Licensed Rollup APIs that are shipped with the default distribution of Elasticsearch.
    final org.elasticsearch.action.search.SearchResponse
    scroll(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a search using the Search Scroll API.
    final org.elasticsearch.client.Cancellable
    scrollAsync(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.SearchResponse> listener)
    Deprecated.
    Asynchronously executes a search using the Search Scroll API.
    final org.elasticsearch.action.search.SearchResponse
    search(org.elasticsearch.action.search.SearchRequest searchRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a search request using the Search API.
    SearchableSnapshotsClient
    searchableSnapshots()
    Deprecated.
    A wrapper for the RestHighLevelClient that provides methods for accessing the Searchable Snapshots APIs.
    final org.elasticsearch.client.Cancellable
    searchAsync(org.elasticsearch.action.search.SearchRequest searchRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.SearchResponse> listener)
    Deprecated.
    Asynchronously executes a search using the Search API.
    final org.elasticsearch.action.search.SearchResponse
    searchScroll(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    use scroll(SearchScrollRequest, RequestOptions) instead
    final org.elasticsearch.client.Cancellable
    searchScrollAsync(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.SearchResponse> listener)
    Deprecated.
    use scrollAsync(SearchScrollRequest, RequestOptions, ActionListener) instead
    final org.elasticsearch.script.mustache.SearchTemplateResponse
    searchTemplate(org.elasticsearch.script.mustache.SearchTemplateRequest searchTemplateRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a request using the Search Template API.
    final org.elasticsearch.client.Cancellable
    searchTemplateAsync(org.elasticsearch.script.mustache.SearchTemplateRequest searchTemplateRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.script.mustache.SearchTemplateResponse> listener)
    Deprecated.
    Asynchronously executes a request using the Search Template API.
    SecurityClient
    security()
    Deprecated.
    Provides methods for accessing the Elastic Licensed Security APIs that are shipped with the Elastic Stack distribution of Elasticsearch.
    final SnapshotClient
    snapshot()
    Deprecated.
    Provides a SnapshotClient which can be used to access the Snapshot API.
    final TaskSubmissionResponse
    submitDeleteByQueryTask(org.elasticsearch.index.reindex.DeleteByQueryRequest deleteByQueryRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Submits a delete by query task See Delete By Query API on elastic.co
    final TaskSubmissionResponse
    submitReindexTask(org.elasticsearch.index.reindex.ReindexRequest reindexRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Submits a reindex task.
    final TaskSubmissionResponse
    submitUpdateByQueryTask(org.elasticsearch.index.reindex.UpdateByQueryRequest updateByQueryRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Submits a update by query task.
    final TasksClient
    tasks()
    Deprecated.
    Provides a TasksClient which can be used to access the Tasks API.
    final TermVectorsResponse
    termvectors(TermVectorsRequest request, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Calls the Term Vectors API See Term Vectors API on elastic.co
    final org.elasticsearch.client.Cancellable
    termvectorsAsync(TermVectorsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<TermVectorsResponse> listener)
    Deprecated.
    Asynchronously calls the Term Vectors API See Term Vectors API on elastic.co
    TextStructureClient
    textStructure()
    Deprecated.
    A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic Text Structure APIs.
    TransformClient
    transform()
    Deprecated.
    Provides methods for accessing the Elastic Licensed Data Frame APIs that are shipped with the Elastic Stack distribution of Elasticsearch.
    final org.elasticsearch.action.update.UpdateResponse
    update(org.elasticsearch.action.update.UpdateRequest updateRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Updates a document using the Update API.
    final org.elasticsearch.client.Cancellable
    updateAsync(org.elasticsearch.action.update.UpdateRequest updateRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.update.UpdateResponse> listener)
    Deprecated.
    Asynchronously updates a document using the Update API.
    final org.elasticsearch.index.reindex.BulkByScrollResponse
    updateByQuery(org.elasticsearch.index.reindex.UpdateByQueryRequest updateByQueryRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a update by query request.
    final org.elasticsearch.client.Cancellable
    updateByQueryAsync(org.elasticsearch.index.reindex.UpdateByQueryRequest updateByQueryRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.index.reindex.BulkByScrollResponse> listener)
    Deprecated.
    Asynchronously executes an update by query request.
    final org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse
    updateByQueryRethrottle(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options)
    Deprecated.
    Executes a update by query rethrottle request.
    final org.elasticsearch.client.Cancellable
    updateByQueryRethrottleAsync(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse> listener)
    Deprecated.
    Asynchronously execute an update by query rethrottle request.
    WatcherClient
    watcher()
    Deprecated.
    Provides methods for accessing the Elastic Licensed Watcher APIs that are shipped with the default distribution of Elasticsearch.
    final XPackClient
    xpack()
    Deprecated.
    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

  • Field Details

    • API_VERSIONING_ENV_VARIABLE

      public static final String API_VERSIONING_ENV_VARIABLE
      Deprecated.
      Environment variable determining whether to send the 7.x compatibility header
      See Also:

  • Constructor Details

    • RestHighLevelClient

      public RestHighLevelClient(org.elasticsearch.client.RestClientBuilder restClientBuilder)
      Deprecated.
      Creates a RestHighLevelClient given the low level RestClientBuilder that allows to build the RestClient to be used to perform requests.

    • RestHighLevelClient

      protected RestHighLevelClient(org.elasticsearch.client.RestClientBuilder restClientBuilder, List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry> namedXContentEntries)
      Deprecated.
      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(org.elasticsearch.client.RestClient restClient, org.elasticsearch.core.CheckedConsumer<org.elasticsearch.client.RestClient,IOException> doClose, List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry> namedXContentEntries)
      Deprecated.
      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.

    • RestHighLevelClient

      protected RestHighLevelClient(org.elasticsearch.client.RestClient restClient, org.elasticsearch.core.CheckedConsumer<org.elasticsearch.client.RestClient,IOException> doClose, List<org.elasticsearch.xcontent.NamedXContentRegistry.Entry> namedXContentEntries, Boolean useAPICompatibility)
      Deprecated.
      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 Details

    • getLowLevelClient

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

    • close

      public final void close() throws IOException
      Deprecated.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException

    • indices

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

    • cluster

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

    • ingest

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

    • snapshot

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

    • rollup

      public RollupClient rollup()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      Provides a TasksClient which can be used to access the Tasks API. See Task Management API on elastic.co

    • xpack

      public final XPackClient xpack()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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.

    • asyncSearch

      public AsyncSearchClient asyncSearch()
      Deprecated.
      A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic Index Async Search APIs.

      See the X-Pack APIs on elastic.co for more information.

    • textStructure

      public TextStructureClient textStructure()
      Deprecated.
      A wrapper for the RestHighLevelClient that provides methods for accessing the Elastic Text Structure APIs.

      See the X-Pack APIs on elastic.co for more information.

    • searchableSnapshots

      public SearchableSnapshotsClient searchableSnapshots()
      Deprecated.
      A wrapper for the RestHighLevelClient that provides methods for accessing the Searchable Snapshots APIs.

      See the Searchable Snapshots APIs on elastic.co for more information.

    • features

      public FeaturesClient features()
      Deprecated.
      A wrapper for the RestHighLevelClient that provides methods for accessing the Searchable Snapshots APIs.

      See the Searchable Snapshots APIs on elastic.co for more information.

    • migration

      public MigrationClient migration()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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

    • transform

      public TransformClient transform()
      Deprecated.
      Provides methods for accessing the Elastic Licensed Data Frame 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 Transform APIs on elastic.co for more information.

      Returns:
      the client wrapper for making Data Frame API calls

    • enrich

      public EnrichClient enrich()
      Deprecated.

    • eql

      public final EqlClient eql()
      Deprecated.
      Provides methods for accessing the Elastic EQL 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 EQL APIs on elastic.co for more information.

      Returns:
      the client wrapper for making Data Frame API calls

    • bulk

      public final org.elasticsearch.action.bulk.BulkResponse bulk(org.elasticsearch.action.bulk.BulkRequest bulkRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • bulkAsync

      public final org.elasticsearch.client.Cancellable bulkAsync(org.elasticsearch.action.bulk.BulkRequest bulkRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.bulk.BulkResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • reindex

      public final org.elasticsearch.index.reindex.BulkByScrollResponse reindex(org.elasticsearch.index.reindex.ReindexRequest reindexRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • submitReindexTask

      public final TaskSubmissionResponse submitReindexTask(org.elasticsearch.index.reindex.ReindexRequest reindexRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • reindexAsync

      public final org.elasticsearch.client.Cancellable reindexAsync(org.elasticsearch.index.reindex.ReindexRequest reindexRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.index.reindex.BulkByScrollResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • updateByQuery

      public final org.elasticsearch.index.reindex.BulkByScrollResponse updateByQuery(org.elasticsearch.index.reindex.UpdateByQueryRequest updateByQueryRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • submitUpdateByQueryTask

      public final TaskSubmissionResponse submitUpdateByQueryTask(org.elasticsearch.index.reindex.UpdateByQueryRequest updateByQueryRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      Submits a update by query task. 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 submission response
      Throws:
      IOException

    • updateByQueryAsync

      public final org.elasticsearch.client.Cancellable updateByQueryAsync(org.elasticsearch.index.reindex.UpdateByQueryRequest updateByQueryRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.index.reindex.BulkByScrollResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • deleteByQuery

      public final org.elasticsearch.index.reindex.BulkByScrollResponse deleteByQuery(org.elasticsearch.index.reindex.DeleteByQueryRequest deleteByQueryRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • submitDeleteByQueryTask

      public final TaskSubmissionResponse submitDeleteByQueryTask(org.elasticsearch.index.reindex.DeleteByQueryRequest deleteByQueryRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      Submits a delete by query task 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 submission response
      Throws:
      IOException

    • deleteByQueryAsync

      public final org.elasticsearch.client.Cancellable deleteByQueryAsync(org.elasticsearch.index.reindex.DeleteByQueryRequest deleteByQueryRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.index.reindex.BulkByScrollResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • deleteByQueryRethrottle

      public final org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse deleteByQueryRethrottle(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • deleteByQueryRethrottleAsync

      public final org.elasticsearch.client.Cancellable deleteByQueryRethrottleAsync(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • updateByQueryRethrottle

      public final org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse updateByQueryRethrottle(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • updateByQueryRethrottleAsync

      public final org.elasticsearch.client.Cancellable updateByQueryRethrottleAsync(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • reindexRethrottle

      public final org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse reindexRethrottle(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • reindexRethrottleAsync

      public final org.elasticsearch.client.Cancellable reindexRethrottleAsync(RethrottleRequest rethrottleRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • ping

      public final boolean ping(org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • info

      public final MainResponse info(org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • get

      public final org.elasticsearch.action.get.GetResponse get(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • getAsync

      public final org.elasticsearch.client.Cancellable getAsync(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.get.GetResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • multiGet

      @Deprecated public final org.elasticsearch.action.get.MultiGetResponse multiGet(org.elasticsearch.action.get.MultiGetRequest multiGetRequest, org.elasticsearch.client.RequestOptions options) throws 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:
      IOException

    • mget

      public final org.elasticsearch.action.get.MultiGetResponse mget(org.elasticsearch.action.get.MultiGetRequest multiGetRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • multiGetAsync

      @Deprecated public final org.elasticsearch.client.Cancellable multiGetAsync(org.elasticsearch.action.get.MultiGetRequest multiGetRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.get.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
      Returns:
      cancellable that may be used to cancel the request

    • mgetAsync

      public final org.elasticsearch.client.Cancellable mgetAsync(org.elasticsearch.action.get.MultiGetRequest multiGetRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.get.MultiGetResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • exists

      public final boolean exists(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • existsAsync

      public final org.elasticsearch.client.Cancellable existsAsync(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<Boolean> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • existsSource

      @Deprecated public boolean existsSource(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      use existsSource(GetSourceRequest, RequestOptions) instead
      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:
      IOException

    • existsSourceAsync

      @Deprecated public final org.elasticsearch.client.Cancellable existsSourceAsync(org.elasticsearch.action.get.GetRequest getRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<Boolean> listener)
      Deprecated.
      use existsSourceAsync(GetSourceRequest, RequestOptions, ActionListener) instead
      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
      Returns:
      cancellable that may be used to cancel the request

    • existsSource

      public boolean existsSource(GetSourceRequest getSourceRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      getSourceRequest - 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:
      IOException

    • existsSourceAsync

      public final org.elasticsearch.client.Cancellable existsSourceAsync(GetSourceRequest getSourceRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<Boolean> listener)
      Deprecated.
      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:
      getSourceRequest - 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
      Returns:
      cancellable that may be used to cancel the request

    • getSource

      public GetSourceResponse getSource(GetSourceRequest getSourceRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      Retrieves the source field only of a document using GetSource API. See Get Source API on elastic.co
      Parameters:
      getSourceRequest - the request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException

    • getSourceAsync

      public final org.elasticsearch.client.Cancellable getSourceAsync(GetSourceRequest getSourceRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetSourceResponse> listener)
      Deprecated.
      Asynchronously retrieves the source field only of a document using GetSource API. See Get Source API on elastic.co
      Parameters:
      getSourceRequest - 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
      Returns:
      cancellable that may be used to cancel the request

    • index

      public final org.elasticsearch.action.index.IndexResponse index(org.elasticsearch.action.index.IndexRequest indexRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • indexAsync

      public final org.elasticsearch.client.Cancellable indexAsync(org.elasticsearch.action.index.IndexRequest indexRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.index.IndexResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • count

      public final CountResponse count(CountRequest countRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • countAsync

      public final org.elasticsearch.client.Cancellable countAsync(CountRequest countRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<CountResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • update

      public final org.elasticsearch.action.update.UpdateResponse update(org.elasticsearch.action.update.UpdateRequest updateRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • updateAsync

      public final org.elasticsearch.client.Cancellable updateAsync(org.elasticsearch.action.update.UpdateRequest updateRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.update.UpdateResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • delete

      public final org.elasticsearch.action.delete.DeleteResponse delete(org.elasticsearch.action.delete.DeleteRequest deleteRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • deleteAsync

      public final org.elasticsearch.client.Cancellable deleteAsync(org.elasticsearch.action.delete.DeleteRequest deleteRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.delete.DeleteResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • search

      public final org.elasticsearch.action.search.SearchResponse search(org.elasticsearch.action.search.SearchRequest searchRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • searchAsync

      public final org.elasticsearch.client.Cancellable searchAsync(org.elasticsearch.action.search.SearchRequest searchRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.SearchResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • multiSearch

      @Deprecated public final org.elasticsearch.action.search.MultiSearchResponse multiSearch(org.elasticsearch.action.search.MultiSearchRequest multiSearchRequest, org.elasticsearch.client.RequestOptions options) throws 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:
      IOException

    • msearch

      public final org.elasticsearch.action.search.MultiSearchResponse msearch(org.elasticsearch.action.search.MultiSearchRequest multiSearchRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • multiSearchAsync

      @Deprecated public final org.elasticsearch.client.Cancellable multiSearchAsync(org.elasticsearch.action.search.MultiSearchRequest searchRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.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
      Returns:
      cancellable that may be used to cancel the request

    • msearchAsync

      public final org.elasticsearch.client.Cancellable msearchAsync(org.elasticsearch.action.search.MultiSearchRequest searchRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.MultiSearchResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • searchScroll

      @Deprecated public final org.elasticsearch.action.search.SearchResponse searchScroll(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions options) throws 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:
      IOException

    • scroll

      public final org.elasticsearch.action.search.SearchResponse scroll(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • searchScrollAsync

      @Deprecated public final org.elasticsearch.client.Cancellable searchScrollAsync(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.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
      Returns:
      cancellable that may be used to cancel the request

    • scrollAsync

      public final org.elasticsearch.client.Cancellable scrollAsync(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.SearchResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • clearScroll

      public final org.elasticsearch.action.search.ClearScrollResponse clearScroll(org.elasticsearch.action.search.ClearScrollRequest clearScrollRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • clearScrollAsync

      public final org.elasticsearch.client.Cancellable clearScrollAsync(org.elasticsearch.action.search.ClearScrollRequest clearScrollRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.ClearScrollResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • openPointInTime

      public final org.elasticsearch.action.search.OpenPointInTimeResponse openPointInTime(org.elasticsearch.action.search.OpenPointInTimeRequest openRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      Open a point in time before using it in search requests. See Point in time API
      Parameters:
      openRequest - the open request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response containing the point in time id
      Throws:
      IOException

    • openPointInTimeAsync

      public final org.elasticsearch.client.Cancellable openPointInTimeAsync(org.elasticsearch.action.search.OpenPointInTimeRequest openRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.OpenPointInTimeResponse> listener)
      Deprecated.
      Asynchronously open a point in time before using it in search requests See Point in time API
      Parameters:
      openRequest - the open 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
      Returns:
      a cancellable that may be used to cancel the request

    • closePointInTime

      public final org.elasticsearch.action.search.ClosePointInTimeResponse closePointInTime(org.elasticsearch.action.search.ClosePointInTimeRequest closeRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      Close a point in time that is opened with openPointInTime(OpenPointInTimeRequest, RequestOptions) or openPointInTimeAsync(OpenPointInTimeRequest, RequestOptions, ActionListener). See Close point in time API
      Parameters:
      closeRequest - the close request
      options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      the response
      Throws:
      IOException

    • closePointInTimeAsync

      public final org.elasticsearch.client.Cancellable closePointInTimeAsync(org.elasticsearch.action.search.ClosePointInTimeRequest closeRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.search.ClosePointInTimeResponse> listener)
      Deprecated.
      Asynchronously close a point in time that is opened with openPointInTime(OpenPointInTimeRequest, RequestOptions) or openPointInTimeAsync(OpenPointInTimeRequest, RequestOptions, ActionListener). See Close point in time API
      Parameters:
      closeRequest - the close 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
      Returns:
      a cancellable that may be used to cancel the request

    • searchTemplate

      public final org.elasticsearch.script.mustache.SearchTemplateResponse searchTemplate(org.elasticsearch.script.mustache.SearchTemplateRequest searchTemplateRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • searchTemplateAsync

      public final org.elasticsearch.client.Cancellable searchTemplateAsync(org.elasticsearch.script.mustache.SearchTemplateRequest searchTemplateRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.script.mustache.SearchTemplateResponse> listener)
      Deprecated.
      Asynchronously executes a request using the Search Template API. See Search Template API on elastic.co.
      Returns:
      cancellable that may be used to cancel the request

    • explain

      public final org.elasticsearch.action.explain.ExplainResponse explain(org.elasticsearch.action.explain.ExplainRequest explainRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • explainAsync

      public final org.elasticsearch.client.Cancellable explainAsync(org.elasticsearch.action.explain.ExplainRequest explainRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.explain.ExplainResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • termvectors

      public final TermVectorsResponse termvectors(TermVectorsRequest request, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • termvectorsAsync

      public final org.elasticsearch.client.Cancellable termvectorsAsync(TermVectorsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<TermVectorsResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • mtermvectors

      public final MultiTermVectorsResponse mtermvectors(MultiTermVectorsRequest request, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • mtermvectorsAsync

      public final org.elasticsearch.client.Cancellable mtermvectorsAsync(MultiTermVectorsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<MultiTermVectorsResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • rankEval

      public final org.elasticsearch.index.rankeval.RankEvalResponse rankEval(org.elasticsearch.index.rankeval.RankEvalRequest rankEvalRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • msearchTemplate

      public final org.elasticsearch.script.mustache.MultiSearchTemplateResponse msearchTemplate(org.elasticsearch.script.mustache.MultiSearchTemplateRequest multiSearchTemplateRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      Executes a request using the Multi Search Template API. See Multi Search Template API on elastic.co.
      Throws:
      IOException

    • msearchTemplateAsync

      public final org.elasticsearch.client.Cancellable msearchTemplateAsync(org.elasticsearch.script.mustache.MultiSearchTemplateRequest multiSearchTemplateRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.script.mustache.MultiSearchTemplateResponse> listener)
      Deprecated.
      Asynchronously executes a request using the Multi Search Template API See Multi Search Template API on elastic.co.
      Returns:
      cancellable that may be used to cancel the request

    • rankEvalAsync

      public final org.elasticsearch.client.Cancellable rankEvalAsync(org.elasticsearch.index.rankeval.RankEvalRequest rankEvalRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.index.rankeval.RankEvalResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • fieldCaps

      public final org.elasticsearch.action.fieldcaps.FieldCapabilitiesResponse fieldCaps(org.elasticsearch.action.fieldcaps.FieldCapabilitiesRequest fieldCapabilitiesRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • getScript

      public org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptResponse getScript(org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequest request, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • getScriptAsync

      public org.elasticsearch.client.Cancellable getScriptAsync(org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • deleteScript

      public org.elasticsearch.action.support.master.AcknowledgedResponse deleteScript(org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequest request, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • deleteScriptAsync

      public org.elasticsearch.client.Cancellable deleteScriptAsync(org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • putScript

      public org.elasticsearch.action.support.master.AcknowledgedResponse putScript(org.elasticsearch.action.admin.cluster.storedscripts.PutStoredScriptRequest putStoredScriptRequest, org.elasticsearch.client.RequestOptions options) throws IOException
      Deprecated.
      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:
      IOException

    • putScriptAsync

      public org.elasticsearch.client.Cancellable putScriptAsync(org.elasticsearch.action.admin.cluster.storedscripts.PutStoredScriptRequest putStoredScriptRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.support.master.AcknowledgedResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • fieldCapsAsync

      public final org.elasticsearch.client.Cancellable fieldCapsAsync(org.elasticsearch.action.fieldcaps.FieldCapabilitiesRequest fieldCapabilitiesRequest, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<org.elasticsearch.action.fieldcaps.FieldCapabilitiesResponse> listener)
      Deprecated.
      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
      Returns:
      cancellable that may be used to cancel the request

    • performRequestAndParseEntity

      @Deprecated protected final <Req extends org.elasticsearch.action.ActionRequest, Resp> Resp performRequestAndParseEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser, Set<Integer> ignores) throws 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:
      IOException

    • performRequestAndParseEntity

      protected final <Req extends Validatable, Resp> Resp performRequestAndParseEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser, Set<Integer> ignores) throws IOException
      Deprecated.
      Defines a helper method for performing a request and then parsing the returned entity using the provided entityParser.
      Throws:
      IOException

    • performRequest

      @Deprecated protected final <Req extends org.elasticsearch.action.ActionRequest, Resp> Resp performRequest(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.client.Response,Resp,IOException> responseConverter, Set<Integer> ignores) throws 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:
      IOException

    • performRequest

      protected final <Req extends Validatable, Resp> Resp performRequest(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.client.Response,Resp,IOException> responseConverter, Set<Integer> ignores) throws IOException
      Deprecated.
      Defines a helper method for performing a request.
      Throws:
      IOException

    • performRequestAndParseOptionalEntity

      protected final <Req extends Validatable, Resp> Optional<Resp> performRequestAndParseOptionalEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser) throws IOException
      Deprecated.
      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:
      IOException

    • performRequestAsyncAndParseEntity

      @Deprecated protected final <Req extends org.elasticsearch.action.ActionRequest, Resp> org.elasticsearch.client.Cancellable performRequestAsyncAndParseEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser, org.elasticsearch.action.ActionListener<Resp> listener, Set<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.
      Returns:
      Cancellable instance that may be used to cancel the request

    • performRequestAsyncAndParseEntity

      protected final <Req extends Validatable, Resp> org.elasticsearch.client.Cancellable performRequestAsyncAndParseEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser, org.elasticsearch.action.ActionListener<Resp> listener, Set<Integer> ignores)
      Deprecated.
      Defines a helper method for asynchronously performing a request.
      Returns:
      Cancellable instance that may be used to cancel the request

    • performRequestAsync

      @Deprecated protected final <Req extends org.elasticsearch.action.ActionRequest, Resp> org.elasticsearch.client.Cancellable performRequestAsync(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.client.Response,Resp,IOException> responseConverter, org.elasticsearch.action.ActionListener<Resp> listener, Set<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.
      Returns:
      Cancellable instance that may be used to cancel the request

    • performRequestAsync

      protected final <Req extends Validatable, Resp> org.elasticsearch.client.Cancellable performRequestAsync(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.client.Response,Resp,IOException> responseConverter, org.elasticsearch.action.ActionListener<Resp> listener, Set<Integer> ignores)
      Deprecated.
      Defines a helper method for asynchronously performing a request.
      Returns:
      Cancellable instance that may be used to cancel the request

    • performRequestAsyncAndParseOptionalEntity

      protected final <Req extends Validatable, Resp> org.elasticsearch.client.Cancellable performRequestAsyncAndParseOptionalEntity(Req request, org.elasticsearch.core.CheckedFunction<Req,org.elasticsearch.client.Request,IOException> requestConverter, org.elasticsearch.client.RequestOptions options, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser, org.elasticsearch.action.ActionListener<Optional<Resp>> listener)
      Deprecated.
      Asynchronous request which returns empty Optionals in the case of 404s or parses entity into an Optional
      Returns:
      Cancellable instance that may be used to cancel the request

    • parseResponseException

      protected final org.elasticsearch.ElasticsearchStatusException parseResponseException(org.elasticsearch.client.ResponseException responseException)
      Deprecated.
      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, org.elasticsearch.core.CheckedFunction<org.elasticsearch.xcontent.XContentParser,Resp,IOException> entityParser) throws IOException
      Deprecated.
      Throws:
      IOException

    • convertExistsResponse

      protected static boolean convertExistsResponse(org.elasticsearch.client.Response response)
      Deprecated.