org.elasticsearch.client.support

Class AbstractClient

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.client.support.AbstractClient

All Implemented Interfaces:

AutoCloseable, Client, ElasticsearchClient, Releasable

Direct Known Subclasses:

FilterClient, NodeClient, TransportClient

public abstract class AbstractClient
extends AbstractComponent
implements Client

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Fields inherited from interface org.elasticsearch.client.Client

CLIENT_TYPE_SETTING

Constructor Summary

Constructors

Constructor and Description
AbstractClient(Settings settings, ThreadPool threadPool, Headers headers)

Method Summary

Methods

Modifier and Type	Method and Description
AdminClient	admin() The admin client that can be used to perform administrative operations.
ActionFuture<BulkResponse>	bulk(BulkRequest request) Executes a bulk of index / delete operations.
void	bulk(BulkRequest request, ActionListener<BulkResponse> listener) Executes a bulk of index / delete operations.
ActionFuture<ClearScrollResponse>	clearScroll(ClearScrollRequest request) Clears the search contexts associated with specified scroll ids.
void	clearScroll(ClearScrollRequest request, ActionListener<ClearScrollResponse> listener) Clears the search contexts associated with specified scroll ids.
ActionFuture<CountResponse>	count(CountRequest request) A count of all the documents matching a specific query.
void	count(CountRequest request, ActionListener<CountResponse> listener) A count of all the documents matching a specific query.
ActionFuture<DeleteResponse>	delete(DeleteRequest request) Deletes a document from the index based on the index, type and id.
void	delete(DeleteRequest request, ActionListener<DeleteResponse> listener) Deletes a document from the index based on the index, type and id.
ActionFuture<DeleteIndexedScriptResponse>	deleteIndexedScript(DeleteIndexedScriptRequest request) Delete an indexed script
void	deleteIndexedScript(DeleteIndexedScriptRequest request, ActionListener<DeleteIndexedScriptResponse> listener) delete an indexed script
protected abstract <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void	doExecute(Action<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener)
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> ActionFuture<Response>	execute(Action<Request,Response,RequestBuilder> action, Request request) Executes a generic action, denoted by an Action.
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void	execute(Action<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener) This is the single execution point of *all* clients.
ActionFuture<ExistsResponse>	exists(ExistsRequest request) Checks existence of any documents matching a specific query.
void	exists(ExistsRequest request, ActionListener<ExistsResponse> listener) Checks existence of any documents matching a specific query.
ActionFuture<ExplainResponse>	explain(ExplainRequest request) Computes a score explanation for the specified request.
void	explain(ExplainRequest request, ActionListener<ExplainResponse> listener) Computes a score explanation for the specified request.
ActionFuture<FieldStatsResponse>	fieldStats(FieldStatsRequest request)
void	fieldStats(FieldStatsRequest request, ActionListener<FieldStatsResponse> listener)
ActionFuture<GetResponse>	get(GetRequest request) Gets the document that was indexed from an index with a type and id.
void	get(GetRequest request, ActionListener<GetResponse> listener) Gets the document that was indexed from an index with a type and id.
ActionFuture<GetIndexedScriptResponse>	getIndexedScript(GetIndexedScriptRequest request) Gets the document that was indexed from an index with a type and id.
void	getIndexedScript(GetIndexedScriptRequest request, ActionListener<GetIndexedScriptResponse> listener) Get an indexed script
Headers	headers()
ActionFuture<IndexResponse>	index(IndexRequest request) Index a JSON source associated with a given index and type.
void	index(IndexRequest request, ActionListener<IndexResponse> listener) Index a document associated with a given index and type.
ActionFuture<MultiGetResponse>	multiGet(MultiGetRequest request) Multi get documents.
void	multiGet(MultiGetRequest request, ActionListener<MultiGetResponse> listener) Multi get documents.
ActionFuture<MultiPercolateResponse>	multiPercolate(MultiPercolateRequest request) Performs multiple percolate requests.
void	multiPercolate(MultiPercolateRequest request, ActionListener<MultiPercolateResponse> listener) Performs multiple percolate requests.
ActionFuture<MultiSearchResponse>	multiSearch(MultiSearchRequest request) Performs multiple search requests.
void	multiSearch(MultiSearchRequest request, ActionListener<MultiSearchResponse> listener) Performs multiple search requests.
ActionFuture<MultiTermVectorsResponse>	multiTermVectors(MultiTermVectorsRequest request) Multi get term vectors.
void	multiTermVectors(MultiTermVectorsRequest request, ActionListener<MultiTermVectorsResponse> listener) Multi get term vectors.
ActionFuture<PercolateResponse>	percolate(PercolateRequest request) Percolates a request returning the matches documents.
void	percolate(PercolateRequest request, ActionListener<PercolateResponse> listener) Percolates a request returning the matches documents.
BulkRequestBuilder	prepareBulk() Executes a bulk of index / delete operations.
ClearScrollRequestBuilder	prepareClearScroll() Clears the search contexts associated with specified scroll ids.
CountRequestBuilder	prepareCount(String... indices) A count of all the documents matching a specific query.
DeleteRequestBuilder	prepareDelete() Deletes a document from the index based on the index, type and id.
DeleteRequestBuilder	prepareDelete(String index, String type, String id) Deletes a document from the index based on the index, type and id.
DeleteIndexedScriptRequestBuilder	prepareDeleteIndexedScript() Delete an indexed script
DeleteIndexedScriptRequestBuilder	prepareDeleteIndexedScript(String scriptLang, String id) Delete an indexed script
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> RequestBuilder	prepareExecute(Action<Request,Response,RequestBuilder> action) Prepares a request builder to execute, specified by Action.
ExistsRequestBuilder	prepareExists(String... indices) Checks existence of any documents matching a specific query.
ExplainRequestBuilder	prepareExplain(String index, String type, String id) Computes a score explanation for the specified request.
FieldStatsRequestBuilder	prepareFieldStats()
GetRequestBuilder	prepareGet() Gets the document that was indexed from an index with a type and id.
GetRequestBuilder	prepareGet(String index, String type, String id) Gets the document that was indexed from an index with a type (optional) and id.
GetIndexedScriptRequestBuilder	prepareGetIndexedScript() Get an indexed script
GetIndexedScriptRequestBuilder	prepareGetIndexedScript(String scriptLang, String id) Get the indexed script
IndexRequestBuilder	prepareIndex() Index a document associated with a given index and type.
IndexRequestBuilder	prepareIndex(String index, String type) Index a document associated with a given index and type.
IndexRequestBuilder	prepareIndex(String index, String type, String id) Index a document associated with a given index and type.
MultiGetRequestBuilder	prepareMultiGet() Multi get documents.
MultiPercolateRequestBuilder	prepareMultiPercolate() Performs multiple percolate requests.
MultiSearchRequestBuilder	prepareMultiSearch() Performs multiple search requests.
MultiTermVectorsRequestBuilder	prepareMultiTermVectors() Multi get term vectors.
PercolateRequestBuilder	preparePercolate() Percolates a request returning the matches documents.
PutIndexedScriptRequestBuilder	preparePutIndexedScript() Put an indexed script
PutIndexedScriptRequestBuilder	preparePutIndexedScript(String scriptLang, String id, String source) Put the indexed script
SearchRequestBuilder	prepareSearch(String... indices) Search across one or more indices and one or more types with a query.
SearchScrollRequestBuilder	prepareSearchScroll(String scrollId) A search scroll request to continue searching a previous scrollable search request.
SuggestRequestBuilder	prepareSuggest(String... indices) Suggestions matching a specific phrase.
TermVectorsRequestBuilder	prepareTermVector() Deprecated.
TermVectorsRequestBuilder	prepareTermVector(String index, String type, String id) Deprecated.
TermVectorsRequestBuilder	prepareTermVectors() Builder for the term vector request.
TermVectorsRequestBuilder	prepareTermVectors(String index, String type, String id) Builder for the term vector request.
UpdateRequestBuilder	prepareUpdate() Updates a document based on a script.
UpdateRequestBuilder	prepareUpdate(String index, String type, String id) Updates a document based on a script.
ActionFuture<PutIndexedScriptResponse>	putIndexedScript(PutIndexedScriptRequest request) Put an indexed script
void	putIndexedScript(PutIndexedScriptRequest request, ActionListener<PutIndexedScriptResponse> listener) Put an indexed script
ActionFuture<SearchResponse>	search(SearchRequest request) Search across one or more indices and one or more types with a query.
void	search(SearchRequest request, ActionListener<SearchResponse> listener) Search across one or more indices and one or more types with a query.
ActionFuture<SearchResponse>	searchScroll(SearchScrollRequest request) A search scroll request to continue searching a previous scrollable search request.
void	searchScroll(SearchScrollRequest request, ActionListener<SearchResponse> listener) A search scroll request to continue searching a previous scrollable search request.
Settings	settings() Returns this clients settings
ActionFuture<SuggestResponse>	suggest(SuggestRequest request) Suggestion matching a specific phrase.
void	suggest(SuggestRequest request, ActionListener<SuggestResponse> listener) Suggestions matching a specific phrase.
ActionFuture<TermVectorsResponse>	termVector(TermVectorsRequest request) Deprecated.
void	termVector(TermVectorsRequest request, ActionListener<TermVectorsResponse> listener) Deprecated.
ActionFuture<TermVectorsResponse>	termVectors(TermVectorsRequest request) An action that returns the term vectors for a specific document.
void	termVectors(TermVectorsRequest request, ActionListener<TermVectorsResponse> listener) An action that returns the term vectors for a specific document.
ThreadPool	threadPool() Returns the threadpool used to execute requests on this client
ActionFuture<UpdateResponse>	update(UpdateRequest request) Updates a document based on a script.
void	update(UpdateRequest request, ActionListener<UpdateResponse> listener) Updates a document based on a script.

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.lease.Releasable

close

Constructor Detail

AbstractClient

public AbstractClient(Settings settings,
              ThreadPool threadPool,
              Headers headers)

Method Detail

headers

public Headers headers()

Specified by:

headers in interface Client

settings

public final Settings settings()

Description copied from interface: Client

Returns this clients settings

Specified by:

settings in interface Client

threadPool

public final ThreadPool threadPool()

Description copied from interface: ElasticsearchClient

Returns the threadpool used to execute requests on this client

Specified by:

threadPool in interface ElasticsearchClient

admin

public final AdminClient admin()

Description copied from interface: Client

The admin client that can be used to perform administrative operations.

Specified by:

admin in interface Client

prepareExecute

public final <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> RequestBuilder prepareExecute(Action<Request,Response,RequestBuilder> action)

Description copied from interface: ElasticsearchClient

Prepares a request builder to execute, specified by Action.

Specified by:

prepareExecute in interface ElasticsearchClient

Type Parameters:

Request - The request type.

Response - The response type.

RequestBuilder - The request builder.

Parameters:

action - The action type to execute.

Returns:

The request builder, that can, at a later stage, execute the request.

execute

public final <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> ActionFuture<Response> execute(Action<Request,Response,RequestBuilder> action,
                                                                                                                                                                          Request request)

Description copied from interface: ElasticsearchClient

Executes a generic action, denoted by an Action.

Specified by:

execute in interface ElasticsearchClient

Type Parameters:

Request - The request type.

Response - the response type.

RequestBuilder - The request builder type.

Parameters:

action - The action type to execute.

request - The action request.

Returns:

A future allowing to get back the response.

execute

public final <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void execute(Action<Request,Response,RequestBuilder> action,
                                                                                                                                                        Request request,
                                                                                                                                                        ActionListener<Response> listener)

This is the single execution point of *all* clients.

Specified by:

execute in interface ElasticsearchClient

Type Parameters:

Request - The request type.

Response - The response type.

RequestBuilder - The request builder type.

Parameters:

action - The action type to execute.

request - The action request.

listener - The listener to receive the response back.

doExecute

protected abstract <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void doExecute(Action<Request,Response,RequestBuilder> action,
                                                                                                                                                          Request request,
                                                                                                                                                          ActionListener<Response> listener)

index

public ActionFuture<IndexResponse> index(IndexRequest request)

Description copied from interface: Client

Index a JSON source associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

index in interface Client

Parameters:

request - The index request

Returns:

The result future

See Also:

Requests.indexRequest(String)

index

public void index(IndexRequest request,
         ActionListener<IndexResponse> listener)

Description copied from interface: Client

Index a document associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

index in interface Client

Parameters:

request - The index request

listener - A listener to be notified with a result

See Also:

Requests.indexRequest(String)

prepareIndex

public IndexRequestBuilder prepareIndex()

Description copied from interface: Client

Index a document associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

prepareIndex in interface Client

prepareIndex

public IndexRequestBuilder prepareIndex(String index,
                               String type)

Description copied from interface: Client

Index a document associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

prepareIndex in interface Client

Parameters:

index - The index to index the document to

type - The type to index the document to

prepareIndex

public IndexRequestBuilder prepareIndex(String index,
                               String type,
                               @Nullable
                               String id)

Description copied from interface: Client

Index a document associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

prepareIndex in interface Client

Parameters:

index - The index to index the document to

type - The type to index the document to

id - The id of the document

update

public ActionFuture<UpdateResponse> update(UpdateRequest request)

Description copied from interface: Client

Updates a document based on a script.

Specified by:

update in interface Client

Parameters:

request - The update request

Returns:

The result future

update

public void update(UpdateRequest request,
          ActionListener<UpdateResponse> listener)

Description copied from interface: Client

Updates a document based on a script.

Specified by:

update in interface Client

Parameters:

request - The update request

listener - A listener to be notified with a result

prepareUpdate

public UpdateRequestBuilder prepareUpdate()

Description copied from interface: Client

Updates a document based on a script.

Specified by:

prepareUpdate in interface Client

prepareUpdate

public UpdateRequestBuilder prepareUpdate(String index,
                                 String type,
                                 String id)

Description copied from interface: Client

Updates a document based on a script.

Specified by:

prepareUpdate in interface Client

delete

public ActionFuture<DeleteResponse> delete(DeleteRequest request)

Description copied from interface: Client

Deletes a document from the index based on the index, type and id.

Specified by:

delete in interface Client

Parameters:

request - The delete request

Returns:

The result future

See Also:

Requests.deleteRequest(String)

delete

public void delete(DeleteRequest request,
          ActionListener<DeleteResponse> listener)

Description copied from interface: Client

Deletes a document from the index based on the index, type and id.

Specified by:

delete in interface Client

Parameters:

request - The delete request

listener - A listener to be notified with a result

See Also:

Requests.deleteRequest(String)

prepareDelete

public DeleteRequestBuilder prepareDelete()

Description copied from interface: Client

Deletes a document from the index based on the index, type and id.

Specified by:

prepareDelete in interface Client

prepareDelete

public DeleteRequestBuilder prepareDelete(String index,
                                 String type,
                                 String id)

Description copied from interface: Client

Deletes a document from the index based on the index, type and id.

Specified by:

prepareDelete in interface Client

Parameters:

index - The index to delete the document from

type - The type of the document to delete

id - The id of the document to delete

bulk

public ActionFuture<BulkResponse> bulk(BulkRequest request)

Description copied from interface: Client

Executes a bulk of index / delete operations.

Specified by:

bulk in interface Client

Parameters:

request - The bulk request

Returns:

The result future

See Also:

Requests.bulkRequest()

bulk

public void bulk(BulkRequest request,
        ActionListener<BulkResponse> listener)

Description copied from interface: Client

Executes a bulk of index / delete operations.

Specified by:

bulk in interface Client

Parameters:

request - The bulk request

listener - A listener to be notified with a result

See Also:

Requests.bulkRequest()

prepareBulk

public BulkRequestBuilder prepareBulk()

Description copied from interface: Client

Executes a bulk of index / delete operations.

Specified by:

prepareBulk in interface Client

get

public ActionFuture<GetResponse> get(GetRequest request)

Description copied from interface: Client

Gets the document that was indexed from an index with a type and id.

Specified by:

get in interface Client

Parameters:

request - The get request

Returns:

The result future

See Also:

Requests.getRequest(String)

get

public void get(GetRequest request,
       ActionListener<GetResponse> listener)

Description copied from interface: Client

Gets the document that was indexed from an index with a type and id.

Specified by:

get in interface Client

Parameters:

request - The get request

listener - A listener to be notified with a result

See Also:

Requests.getRequest(String)

prepareGet

public GetRequestBuilder prepareGet()

Description copied from interface: Client

Gets the document that was indexed from an index with a type and id.

Specified by:

prepareGet in interface Client

prepareGet

public GetRequestBuilder prepareGet(String index,
                           String type,
                           String id)

Description copied from interface: Client

Gets the document that was indexed from an index with a type (optional) and id.

Specified by:

prepareGet in interface Client

getIndexedScript

public ActionFuture<GetIndexedScriptResponse> getIndexedScript(GetIndexedScriptRequest request)

Description copied from interface: Client

Gets the document that was indexed from an index with a type and id.

Specified by:

getIndexedScript in interface Client

Parameters:

request - The get request

Returns:

The result future

See Also:

Requests.getRequest(String)

getIndexedScript

public void getIndexedScript(GetIndexedScriptRequest request,
                    ActionListener<GetIndexedScriptResponse> listener)

Description copied from interface: Client

Get an indexed script

Specified by:

getIndexedScript in interface Client

prepareGetIndexedScript

public GetIndexedScriptRequestBuilder prepareGetIndexedScript()

Description copied from interface: Client

Get an indexed script

Specified by:

prepareGetIndexedScript in interface Client

prepareGetIndexedScript

public GetIndexedScriptRequestBuilder prepareGetIndexedScript(String scriptLang,
                                                     String id)

Description copied from interface: Client

Get the indexed script

Specified by:

prepareGetIndexedScript in interface Client

preparePutIndexedScript

public PutIndexedScriptRequestBuilder preparePutIndexedScript()

Put an indexed script

Specified by:

preparePutIndexedScript in interface Client

preparePutIndexedScript

public PutIndexedScriptRequestBuilder preparePutIndexedScript(@Nullable
                                                     String scriptLang,
                                                     String id,
                                                     String source)

Put the indexed script

Specified by:

preparePutIndexedScript in interface Client

putIndexedScript

public void putIndexedScript(PutIndexedScriptRequest request,
                    ActionListener<PutIndexedScriptResponse> listener)

Put an indexed script

Specified by:

putIndexedScript in interface Client

putIndexedScript

public ActionFuture<PutIndexedScriptResponse> putIndexedScript(PutIndexedScriptRequest request)

Put an indexed script

Specified by:

putIndexedScript in interface Client

Parameters:

request - The put request

Returns:

The result future

deleteIndexedScript

public void deleteIndexedScript(DeleteIndexedScriptRequest request,
                       ActionListener<DeleteIndexedScriptResponse> listener)

delete an indexed script

Specified by:

deleteIndexedScript in interface Client

deleteIndexedScript

public ActionFuture<DeleteIndexedScriptResponse> deleteIndexedScript(DeleteIndexedScriptRequest request)

Delete an indexed script

Specified by:

deleteIndexedScript in interface Client

Parameters:

request - The put request

Returns:

The result future

prepareDeleteIndexedScript

public DeleteIndexedScriptRequestBuilder prepareDeleteIndexedScript()

Delete an indexed script

Specified by:

prepareDeleteIndexedScript in interface Client

prepareDeleteIndexedScript

public DeleteIndexedScriptRequestBuilder prepareDeleteIndexedScript(@Nullable
                                                           String scriptLang,
                                                           String id)

Delete an indexed script

Specified by:

prepareDeleteIndexedScript in interface Client

multiGet

public ActionFuture<MultiGetResponse> multiGet(MultiGetRequest request)

Description copied from interface: Client

Multi get documents.

Specified by:

multiGet in interface Client

multiGet

public void multiGet(MultiGetRequest request,
            ActionListener<MultiGetResponse> listener)

Description copied from interface: Client

Multi get documents.

Specified by:

multiGet in interface Client

prepareMultiGet

public MultiGetRequestBuilder prepareMultiGet()

Description copied from interface: Client

Multi get documents.

Specified by:

prepareMultiGet in interface Client

search

public ActionFuture<SearchResponse> search(SearchRequest request)

Description copied from interface: Client

Search across one or more indices and one or more types with a query.

Specified by:

search in interface Client

Parameters:

request - The search request

Returns:

The result future

See Also:

Requests.searchRequest(String...)

search

public void search(SearchRequest request,
          ActionListener<SearchResponse> listener)

Description copied from interface: Client

Search across one or more indices and one or more types with a query.

Specified by:

search in interface Client

Parameters:

request - The search request

listener - A listener to be notified of the result

See Also:

Requests.searchRequest(String...)

prepareSearch

public SearchRequestBuilder prepareSearch(String... indices)

Description copied from interface: Client

Search across one or more indices and one or more types with a query.

Specified by:

prepareSearch in interface Client

searchScroll

public ActionFuture<SearchResponse> searchScroll(SearchScrollRequest request)

Description copied from interface: Client

A search scroll request to continue searching a previous scrollable search request.

Specified by:

searchScroll in interface Client

Parameters:

request - The search scroll request

Returns:

The result future

See Also:

Requests.searchScrollRequest(String)

searchScroll

public void searchScroll(SearchScrollRequest request,
                ActionListener<SearchResponse> listener)

Description copied from interface: Client

A search scroll request to continue searching a previous scrollable search request.

Specified by:

searchScroll in interface Client

Parameters:

request - The search scroll request

listener - A listener to be notified of the result

See Also:

Requests.searchScrollRequest(String)

prepareSearchScroll

public SearchScrollRequestBuilder prepareSearchScroll(String scrollId)

Description copied from interface: Client

A search scroll request to continue searching a previous scrollable search request.

Specified by:

prepareSearchScroll in interface Client

multiSearch

public ActionFuture<MultiSearchResponse> multiSearch(MultiSearchRequest request)

Description copied from interface: Client

Performs multiple search requests.

Specified by:

multiSearch in interface Client

multiSearch

public void multiSearch(MultiSearchRequest request,
               ActionListener<MultiSearchResponse> listener)

Description copied from interface: Client

Performs multiple search requests.

Specified by:

multiSearch in interface Client

prepareMultiSearch

public MultiSearchRequestBuilder prepareMultiSearch()

Description copied from interface: Client

Performs multiple search requests.

Specified by:

prepareMultiSearch in interface Client

count

public ActionFuture<CountResponse> count(CountRequest request)

Description copied from interface: Client

A count of all the documents matching a specific query.

Specified by:

count in interface Client

Parameters:

request - The count request

Returns:

The result future

See Also:

Requests.countRequest(String...)

count

public void count(CountRequest request,
         ActionListener<CountResponse> listener)

Description copied from interface: Client

A count of all the documents matching a specific query.

Specified by:

count in interface Client

Parameters:

request - The count request

listener - A listener to be notified of the result

See Also:

Requests.countRequest(String...)

prepareCount

public CountRequestBuilder prepareCount(String... indices)

Description copied from interface: Client

A count of all the documents matching a specific query.

Specified by:

prepareCount in interface Client

exists

public ActionFuture<ExistsResponse> exists(ExistsRequest request)

Description copied from interface: Client

Checks existence of any documents matching a specific query.

Specified by:

exists in interface Client

Parameters:

request - The exists request

Returns:

The result future

exists

public void exists(ExistsRequest request,
          ActionListener<ExistsResponse> listener)

Description copied from interface: Client

Checks existence of any documents matching a specific query.

Specified by:

exists in interface Client

Parameters:

request - The exists request

listener - A listener to be notified of the result

prepareExists

public ExistsRequestBuilder prepareExists(String... indices)

Description copied from interface: Client

Checks existence of any documents matching a specific query.

Specified by:

prepareExists in interface Client

suggest

public ActionFuture<SuggestResponse> suggest(SuggestRequest request)

Description copied from interface: Client

Suggestion matching a specific phrase.

Specified by:

suggest in interface Client

Parameters:

request - The suggest request

Returns:

The result future

See Also:

Requests.suggestRequest(String...)

suggest

public void suggest(SuggestRequest request,
           ActionListener<SuggestResponse> listener)

Description copied from interface: Client

Suggestions matching a specific phrase.

Specified by:

suggest in interface Client

Parameters:

request - The suggest request

listener - A listener to be notified of the result

See Also:

Requests.suggestRequest(String...)

prepareSuggest

public SuggestRequestBuilder prepareSuggest(String... indices)

Description copied from interface: Client

Suggestions matching a specific phrase.

Specified by:

prepareSuggest in interface Client

termVectors

public ActionFuture<TermVectorsResponse> termVectors(TermVectorsRequest request)

Description copied from interface: Client

An action that returns the term vectors for a specific document.

Specified by:

termVectors in interface Client

Parameters:

request - The term vector request

Returns:

The response future

termVectors

public void termVectors(TermVectorsRequest request,
               ActionListener<TermVectorsResponse> listener)

Description copied from interface: Client

An action that returns the term vectors for a specific document.

Specified by:

termVectors in interface Client

Parameters:

request - The term vector request

prepareTermVectors

public TermVectorsRequestBuilder prepareTermVectors()

Description copied from interface: Client

Builder for the term vector request.

Specified by:

prepareTermVectors in interface Client

prepareTermVectors

public TermVectorsRequestBuilder prepareTermVectors(String index,
                                           String type,
                                           String id)

Description copied from interface: Client

Builder for the term vector request.

Specified by:

prepareTermVectors in interface Client

Parameters:

index - The index to load the document from

type - The type of the document

id - The id of the document

termVector

@Deprecated
public ActionFuture<TermVectorsResponse> termVector(TermVectorsRequest request)

Deprecated.

Description copied from interface: Client

An action that returns the term vectors for a specific document.

Specified by:

termVector in interface Client

Parameters:

request - The term vector request

Returns:

The response future

termVector

@Deprecated
public void termVector(TermVectorsRequest request,
                         ActionListener<TermVectorsResponse> listener)

Deprecated.

Description copied from interface: Client

An action that returns the term vectors for a specific document.

Specified by:

termVector in interface Client

Parameters:

request - The term vector request

prepareTermVector

@Deprecated
public TermVectorsRequestBuilder prepareTermVector()

Deprecated.

Description copied from interface: Client

Builder for the term vector request.

Specified by:

prepareTermVector in interface Client

prepareTermVector

@Deprecated
public TermVectorsRequestBuilder prepareTermVector(String index,
                                                     String type,
                                                     String id)

Deprecated.

Description copied from interface: Client

Builder for the term vector request.

Specified by:

prepareTermVector in interface Client

Parameters:

index - The index to load the document from

type - The type of the document

id - The id of the document

multiTermVectors

public ActionFuture<MultiTermVectorsResponse> multiTermVectors(MultiTermVectorsRequest request)

Description copied from interface: Client

Multi get term vectors.

Specified by:

multiTermVectors in interface Client

multiTermVectors

public void multiTermVectors(MultiTermVectorsRequest request,
                    ActionListener<MultiTermVectorsResponse> listener)

Description copied from interface: Client

Multi get term vectors.

Specified by:

multiTermVectors in interface Client

prepareMultiTermVectors

public MultiTermVectorsRequestBuilder prepareMultiTermVectors()

Description copied from interface: Client

Multi get term vectors.

Specified by:

prepareMultiTermVectors in interface Client

percolate

public ActionFuture<PercolateResponse> percolate(PercolateRequest request)

Description copied from interface: Client

Percolates a request returning the matches documents.

Specified by:

percolate in interface Client

percolate

public void percolate(PercolateRequest request,
             ActionListener<PercolateResponse> listener)

Description copied from interface: Client

Percolates a request returning the matches documents.

Specified by:

percolate in interface Client

preparePercolate

public PercolateRequestBuilder preparePercolate()

Description copied from interface: Client

Percolates a request returning the matches documents.

Specified by:

preparePercolate in interface Client

prepareMultiPercolate

public MultiPercolateRequestBuilder prepareMultiPercolate()

Description copied from interface: Client

Performs multiple percolate requests.

Specified by:

prepareMultiPercolate in interface Client

multiPercolate

public void multiPercolate(MultiPercolateRequest request,
                  ActionListener<MultiPercolateResponse> listener)

Description copied from interface: Client

Performs multiple percolate requests.

Specified by:

multiPercolate in interface Client

multiPercolate

public ActionFuture<MultiPercolateResponse> multiPercolate(MultiPercolateRequest request)

Description copied from interface: Client

Performs multiple percolate requests.

Specified by:

multiPercolate in interface Client

prepareExplain

public ExplainRequestBuilder prepareExplain(String index,
                                   String type,
                                   String id)

Description copied from interface: Client

Computes a score explanation for the specified request.

Specified by:

prepareExplain in interface Client

Parameters:

index - The index this explain is targeted for

type - The type this explain is targeted for

id - The document identifier this explain is targeted for

explain

public ActionFuture<ExplainResponse> explain(ExplainRequest request)

Description copied from interface: Client

Computes a score explanation for the specified request.

Specified by:

explain in interface Client

Parameters:

request - The request encapsulating the query and document identifier to compute a score explanation for

explain

public void explain(ExplainRequest request,
           ActionListener<ExplainResponse> listener)

Description copied from interface: Client

Computes a score explanation for the specified request.

Specified by:

explain in interface Client

Parameters:

request - The request encapsulating the query and document identifier to compute a score explanation for

listener - A listener to be notified of the result

clearScroll

public void clearScroll(ClearScrollRequest request,
               ActionListener<ClearScrollResponse> listener)

Description copied from interface: Client

Clears the search contexts associated with specified scroll ids.

Specified by:

clearScroll in interface Client

clearScroll

public ActionFuture<ClearScrollResponse> clearScroll(ClearScrollRequest request)

Description copied from interface: Client

Clears the search contexts associated with specified scroll ids.

Specified by:

clearScroll in interface Client

prepareClearScroll

public ClearScrollRequestBuilder prepareClearScroll()

Description copied from interface: Client

Clears the search contexts associated with specified scroll ids.

Specified by:

prepareClearScroll in interface Client

fieldStats

public void fieldStats(FieldStatsRequest request,
              ActionListener<FieldStatsResponse> listener)

Specified by:

fieldStats in interface Client

fieldStats

public ActionFuture<FieldStatsResponse> fieldStats(FieldStatsRequest request)

Specified by:

fieldStats in interface Client

prepareFieldStats

public FieldStatsRequestBuilder prepareFieldStats()

Specified by:

prepareFieldStats in interface Client