Module org.elasticsearch.server
Class AbstractClient
java.lang.Object
org.elasticsearch.client.internal.support.AbstractClient
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Client
,ElasticsearchClient
,Releasable
- Direct Known Subclasses:
FilterClient
,NodeClient
-
Field Summary
Modifier and TypeFieldDescriptionprotected final org.apache.logging.log4j.Logger
protected final Settings
Fields inherited from interface org.elasticsearch.client.internal.Client
CLIENT_TYPE_SETTING_S
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AdminClient
admin()
The admin client that can be used to perform administrative operations.bulk
(BulkRequest request) Executes a bulk of index / delete operations.void
bulk
(BulkRequest request, ActionListener<BulkResponse> listener) Executes a bulk of index / delete operations.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.delete
(DeleteRequest request) Deletes a document from the index based on the index and id.void
delete
(DeleteRequest request, ActionListener<DeleteResponse> listener) Deletes a document from the index based on the index and id.protected abstract <Request extends ActionRequest,
Response extends ActionResponse>
voiddoExecute
(ActionType<Response> action, Request request, ActionListener<Response> listener) final <Request extends ActionRequest,
Response extends ActionResponse>
ActionFuture<Response>execute
(ActionType<Response> action, Request request) Executes a generic action, denoted by anActionType
.final <Request extends ActionRequest,
Response extends ActionResponse>
voidexecute
(ActionType<Response> action, Request request, ActionListener<Response> listener) This is the single execution point of *all* clients.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.fieldCaps
(FieldCapabilitiesRequest request) An action that returns the field capabilities from the provided requestvoid
fieldCaps
(FieldCapabilitiesRequest request, ActionListener<FieldCapabilitiesResponse> listener) An action that returns the field capabilities from the provided requestfilterWithHeader
(Map<String, String> headers) Returns a new lightweight Client that applies all given headers to each of the requests issued from it.get
(GetRequest request) Gets the document that was indexed from an index with an id.void
get
(GetRequest request, ActionListener<GetResponse> listener) Gets the document that was indexed from an index with an id.index
(IndexRequest request) Index a JSON source associated with a given index.void
index
(IndexRequest request, ActionListener<IndexResponse> listener) Index a document associated with a given index.multiGet
(MultiGetRequest request) Multi get documents.void
multiGet
(MultiGetRequest request, ActionListener<MultiGetResponse> listener) Multi get documents.multiSearch
(MultiSearchRequest request) Performs multiple search requests.void
multiSearch
(MultiSearchRequest request, ActionListener<MultiSearchResponse> listener) Performs multiple search requests.multiTermVectors
(MultiTermVectorsRequest request) Multi get term vectors.void
multiTermVectors
(MultiTermVectorsRequest request, ActionListener<MultiTermVectorsResponse> listener) Multi get term vectors.Executes a bulk of index / delete operations.prepareBulk
(String globalIndex) Executes a bulk of index / delete operations with default indexClears the search contexts associated with specified scroll ids.Deletes a document from the index based on the index and id.prepareDelete
(String index, String id) Deletes a document from the index based on the index and id.prepareExplain
(String index, String id) Computes a score explanation for the specified request.prepareFieldCaps
(String... indices) Builder for the field capabilities request.Gets the document that was indexed from an index with an id.prepareGet
(String index, String id) Gets the document that was indexed from an index with an id.Index a document associated with a given index.prepareIndex
(String index) Index a document associated with a given index.Multi get documents.Performs multiple search requests.Multi get term vectors.prepareSearch
(String... indices) Search across one or more indices with a query.prepareSearchScroll
(String scrollId) A search scroll request to continue searching a previous scrollable search request.Builder for the term vector request.prepareTermVectors
(String index, String id) Builder for the term vector request.Updates a document based on a script.prepareUpdate
(String index, String id) Updates a document based on a script.search
(SearchRequest request) Search across one or more indices with a query.void
search
(SearchRequest request, ActionListener<SearchResponse> listener) Search across one or more indices with a query.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.final Settings
settings()
Returns this clients settingstermVectors
(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.final ThreadPool
Returns the threadpool used to execute requests on this clientupdate
(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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.client.internal.Client
getRemoteClusterClient
Methods inherited from interface org.elasticsearch.core.Releasable
close
-
Field Details
-
logger
protected final org.apache.logging.log4j.Logger logger -
settings
-
-
Constructor Details
-
AbstractClient
-
-
Method Details
-
settings
Description copied from interface:Client
Returns this clients settings -
threadPool
Description copied from interface:ElasticsearchClient
Returns the threadpool used to execute requests on this client- Specified by:
threadPool
in interfaceElasticsearchClient
-
admin
Description copied from interface:Client
The admin client that can be used to perform administrative operations. -
execute
public final <Request extends ActionRequest,Response extends ActionResponse> ActionFuture<Response> execute(ActionType<Response> action, Request request) Description copied from interface:ElasticsearchClient
Executes a generic action, denoted by anActionType
.- Specified by:
execute
in interfaceElasticsearchClient
- Type Parameters:
Request
- The request type.Response
- the response 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> void execute(ActionType<Response> action, Request request, ActionListener<Response> listener) This is the single execution point of *all* clients.- Specified by:
execute
in interfaceElasticsearchClient
- Type Parameters:
Request
- The request type.Response
- The response 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> void doExecute(ActionType<Response> action, Request request, ActionListener<Response> listener) -
index
Description copied from interface:Client
Index a JSON source associated with a given index.The id is optional, if it is not provided, one will be generated automatically.
-
index
Description copied from interface:Client
Index a document associated with a given index.The id is optional, if it is not provided, one will be generated automatically.
-
prepareIndex
Description copied from interface:Client
Index a document associated with a given index.The id is optional, if it is not provided, one will be generated automatically.
- Specified by:
prepareIndex
in interfaceClient
-
prepareIndex
Description copied from interface:Client
Index a document associated with a given index.The id is optional, if it is not provided, one will be generated automatically.
- Specified by:
prepareIndex
in interfaceClient
- Parameters:
index
- The index to index the document to
-
update
Description copied from interface:Client
Updates a document based on a script. -
update
Description copied from interface:Client
Updates a document based on a script. -
prepareUpdate
Description copied from interface:Client
Updates a document based on a script.- Specified by:
prepareUpdate
in interfaceClient
-
prepareUpdate
Description copied from interface:Client
Updates a document based on a script.- Specified by:
prepareUpdate
in interfaceClient
-
delete
Description copied from interface:Client
Deletes a document from the index based on the index and id. -
delete
Description copied from interface:Client
Deletes a document from the index based on the index and id. -
prepareDelete
Description copied from interface:Client
Deletes a document from the index based on the index and id.- Specified by:
prepareDelete
in interfaceClient
-
prepareDelete
Description copied from interface:Client
Deletes a document from the index based on the index and id.- Specified by:
prepareDelete
in interfaceClient
- Parameters:
index
- The index to delete the document fromid
- The id of the document to delete
-
bulk
Description copied from interface:Client
Executes a bulk of index / delete operations. -
bulk
Description copied from interface:Client
Executes a bulk of index / delete operations. -
prepareBulk
Description copied from interface:Client
Executes a bulk of index / delete operations.- Specified by:
prepareBulk
in interfaceClient
-
prepareBulk
Description copied from interface:Client
Executes a bulk of index / delete operations with default index- Specified by:
prepareBulk
in interfaceClient
-
get
Description copied from interface:Client
Gets the document that was indexed from an index with an id. -
get
Description copied from interface:Client
Gets the document that was indexed from an index with an id. -
prepareGet
Description copied from interface:Client
Gets the document that was indexed from an index with an id.- Specified by:
prepareGet
in interfaceClient
-
prepareGet
Description copied from interface:Client
Gets the document that was indexed from an index with an id.- Specified by:
prepareGet
in interfaceClient
-
multiGet
Description copied from interface:Client
Multi get documents. -
multiGet
Description copied from interface:Client
Multi get documents. -
prepareMultiGet
Description copied from interface:Client
Multi get documents.- Specified by:
prepareMultiGet
in interfaceClient
-
search
Description copied from interface:Client
Search across one or more indices with a query. -
search
Description copied from interface:Client
Search across one or more indices with a query. -
prepareSearch
Description copied from interface:Client
Search across one or more indices with a query.- Specified by:
prepareSearch
in interfaceClient
-
searchScroll
Description copied from interface:Client
A search scroll request to continue searching a previous scrollable search request.- Specified by:
searchScroll
in interfaceClient
- Parameters:
request
- The search scroll request- Returns:
- The result future
- See Also:
-
searchScroll
Description copied from interface:Client
A search scroll request to continue searching a previous scrollable search request.- Specified by:
searchScroll
in interfaceClient
- Parameters:
request
- The search scroll requestlistener
- A listener to be notified of the result- See Also:
-
prepareSearchScroll
Description copied from interface:Client
A search scroll request to continue searching a previous scrollable search request.- Specified by:
prepareSearchScroll
in interfaceClient
-
multiSearch
Description copied from interface:Client
Performs multiple search requests.- Specified by:
multiSearch
in interfaceClient
-
multiSearch
Description copied from interface:Client
Performs multiple search requests.- Specified by:
multiSearch
in interfaceClient
-
prepareMultiSearch
Description copied from interface:Client
Performs multiple search requests.- Specified by:
prepareMultiSearch
in interfaceClient
-
termVectors
Description copied from interface:Client
An action that returns the term vectors for a specific document.- Specified by:
termVectors
in interfaceClient
- Parameters:
request
- The term vector request- Returns:
- The response future
-
termVectors
Description copied from interface:Client
An action that returns the term vectors for a specific document.- Specified by:
termVectors
in interfaceClient
- Parameters:
request
- The term vector request
-
prepareTermVectors
Description copied from interface:Client
Builder for the term vector request.- Specified by:
prepareTermVectors
in interfaceClient
-
prepareTermVectors
Description copied from interface:Client
Builder for the term vector request.- Specified by:
prepareTermVectors
in interfaceClient
- Parameters:
index
- The index to load the document fromid
- The id of the document
-
multiTermVectors
Description copied from interface:Client
Multi get term vectors.- Specified by:
multiTermVectors
in interfaceClient
-
multiTermVectors
public void multiTermVectors(MultiTermVectorsRequest request, ActionListener<MultiTermVectorsResponse> listener) Description copied from interface:Client
Multi get term vectors.- Specified by:
multiTermVectors
in interfaceClient
-
prepareMultiTermVectors
Description copied from interface:Client
Multi get term vectors.- Specified by:
prepareMultiTermVectors
in interfaceClient
-
prepareExplain
Description copied from interface:Client
Computes a score explanation for the specified request.- Specified by:
prepareExplain
in interfaceClient
- Parameters:
index
- The index this explain is targeted forid
- The document identifier this explain is targeted for
-
explain
Description copied from interface:Client
Computes a score explanation for the specified request. -
explain
Description copied from interface:Client
Computes a score explanation for the specified request. -
clearScroll
Description copied from interface:Client
Clears the search contexts associated with specified scroll ids.- Specified by:
clearScroll
in interfaceClient
-
clearScroll
Description copied from interface:Client
Clears the search contexts associated with specified scroll ids.- Specified by:
clearScroll
in interfaceClient
-
prepareClearScroll
Description copied from interface:Client
Clears the search contexts associated with specified scroll ids.- Specified by:
prepareClearScroll
in interfaceClient
-
fieldCaps
public void fieldCaps(FieldCapabilitiesRequest request, ActionListener<FieldCapabilitiesResponse> listener) Description copied from interface:Client
An action that returns the field capabilities from the provided request -
fieldCaps
Description copied from interface:Client
An action that returns the field capabilities from the provided request -
prepareFieldCaps
Description copied from interface:Client
Builder for the field capabilities request.- Specified by:
prepareFieldCaps
in interfaceClient
-
filterWithHeader
Description copied from interface:Client
Returns a new lightweight Client that applies all given headers to each of the requests issued from it.- Specified by:
filterWithHeader
in interfaceClient
-