Package org.elasticsearch.client
Interface Client
-
- All Superinterfaces:
java.lang.AutoCloseable
,java.io.Closeable
,ElasticsearchClient
,Releasable
- All Known Implementing Classes:
AbstractClient
,FilterClient
,NodeClient
,OriginSettingClient
,ParentTaskAssigningClient
,TransportClient
public interface Client extends ElasticsearchClient, Releasable
A client provides a one stop interface for performing actions/operations against the cluster.All operations performed are asynchronous by nature. Each action/operation has two flavors, the first simply returns an
ActionFuture
, while the second accepts anActionListener
.A client can either be retrieved from a
Node
started, or connected remotely to one or more nodes usingTransportClient
.- See Also:
Node.client()
,TransportClient
-
-
Field Summary
Fields Modifier and Type Field Description static Setting<java.lang.String>
CLIENT_TYPE_SETTING_S
-
Method Summary
Modifier and Type Method 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<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<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<FieldCapabilitiesResponse>
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 requestClient
filterWithHeader(java.util.Map<java.lang.String,java.lang.String> headers)
Returns a new lightweight Client that applies all given headers to each of the requests issued from it.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.default Client
getRemoteClusterClient(java.lang.String clusterAlias)
Returns a client to a remote cluster with the given cluster alias.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<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.BulkRequestBuilder
prepareBulk()
Executes a bulk of index / delete operations.BulkRequestBuilder
prepareBulk(java.lang.String globalIndex, java.lang.String globalType)
Executes a bulk of index / delete operations with default index and/or typeClearScrollRequestBuilder
prepareClearScroll()
Clears the search contexts associated with specified scroll ids.DeleteRequestBuilder
prepareDelete()
Deletes a document from the index based on the index, type and id.DeleteRequestBuilder
prepareDelete(java.lang.String index, java.lang.String type, java.lang.String id)
Deletes a document from the index based on the index, type and id.ExplainRequestBuilder
prepareExplain(java.lang.String index, java.lang.String type, java.lang.String id)
Computes a score explanation for the specified request.FieldCapabilitiesRequestBuilder
prepareFieldCaps(java.lang.String... indices)
Builder for the field capabilities request.GetRequestBuilder
prepareGet()
Gets the document that was indexed from an index with a type and id.GetRequestBuilder
prepareGet(java.lang.String index, java.lang.String type, java.lang.String id)
Gets the document that was indexed from an index with a type (optional) and id.IndexRequestBuilder
prepareIndex()
Index a document associated with a given index and type.IndexRequestBuilder
prepareIndex(java.lang.String index, java.lang.String type)
Index a document associated with a given index and type.IndexRequestBuilder
prepareIndex(java.lang.String index, java.lang.String type, java.lang.String id)
Index a document associated with a given index and type.MultiGetRequestBuilder
prepareMultiGet()
Multi get documents.MultiSearchRequestBuilder
prepareMultiSearch()
Performs multiple search requests.MultiTermVectorsRequestBuilder
prepareMultiTermVectors()
Multi get term vectors.SearchRequestBuilder
prepareSearch(java.lang.String... indices)
Search across one or more indices and one or more types with a query.SearchScrollRequestBuilder
prepareSearchScroll(java.lang.String scrollId)
A search scroll request to continue searching a previous scrollable search request.TermVectorsRequestBuilder
prepareTermVector()
Deprecated.TermVectorsRequestBuilder
prepareTermVector(java.lang.String index, java.lang.String type, java.lang.String id)
Deprecated.TermVectorsRequestBuilder
prepareTermVectors()
Builder for the term vector request.TermVectorsRequestBuilder
prepareTermVectors(java.lang.String index, java.lang.String type, java.lang.String id)
Builder for the term vector request.UpdateRequestBuilder
prepareUpdate()
Updates a document based on a script.UpdateRequestBuilder
prepareUpdate(java.lang.String index, java.lang.String type, java.lang.String id)
Updates a document based on a 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 settingsActionFuture<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.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 interface org.elasticsearch.client.ElasticsearchClient
execute, execute, prepareExecute, threadPool
-
Methods inherited from interface org.elasticsearch.common.lease.Releasable
close
-
-
-
-
Field Detail
-
CLIENT_TYPE_SETTING_S
static final Setting<java.lang.String> CLIENT_TYPE_SETTING_S
-
-
Method Detail
-
admin
AdminClient admin()
The admin client that can be used to perform administrative operations.
-
index
ActionFuture<IndexResponse> index(IndexRequest request)
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.
- Parameters:
request
- The index request- Returns:
- The result future
- See Also:
Requests.indexRequest(String)
-
index
void index(IndexRequest request, ActionListener<IndexResponse> listener)
Index a document associated with a given index and type.The id is optional, if it is not provided, one will be generated automatically.
- Parameters:
request
- The index requestlistener
- A listener to be notified with a result- See Also:
Requests.indexRequest(String)
-
prepareIndex
IndexRequestBuilder prepareIndex()
Index a document associated with a given index and type.The id is optional, if it is not provided, one will be generated automatically.
-
update
ActionFuture<UpdateResponse> update(UpdateRequest request)
Updates a document based on a script.- Parameters:
request
- The update request- Returns:
- The result future
-
update
void update(UpdateRequest request, ActionListener<UpdateResponse> listener)
Updates a document based on a script.- Parameters:
request
- The update requestlistener
- A listener to be notified with a result
-
prepareUpdate
UpdateRequestBuilder prepareUpdate()
Updates a document based on a script.
-
prepareUpdate
UpdateRequestBuilder prepareUpdate(java.lang.String index, java.lang.String type, java.lang.String id)
Updates a document based on a script.
-
prepareIndex
IndexRequestBuilder prepareIndex(java.lang.String index, java.lang.String type)
Index a document associated with a given index and type.The id is optional, if it is not provided, one will be generated automatically.
- Parameters:
index
- The index to index the document totype
- The type to index the document to
-
prepareIndex
IndexRequestBuilder prepareIndex(java.lang.String index, java.lang.String type, @Nullable java.lang.String id)
Index a document associated with a given index and type.The id is optional, if it is not provided, one will be generated automatically.
- Parameters:
index
- The index to index the document totype
- The type to index the document toid
- The id of the document
-
delete
ActionFuture<DeleteResponse> delete(DeleteRequest request)
Deletes a document from the index based on the index, type and id.- Parameters:
request
- The delete request- Returns:
- The result future
- See Also:
Requests.deleteRequest(String)
-
delete
void delete(DeleteRequest request, ActionListener<DeleteResponse> listener)
Deletes a document from the index based on the index, type and id.- Parameters:
request
- The delete requestlistener
- A listener to be notified with a result- See Also:
Requests.deleteRequest(String)
-
prepareDelete
DeleteRequestBuilder prepareDelete()
Deletes a document from the index based on the index, type and id.
-
prepareDelete
DeleteRequestBuilder prepareDelete(java.lang.String index, java.lang.String type, java.lang.String id)
Deletes a document from the index based on the index, type and id.- Parameters:
index
- The index to delete the document fromtype
- The type of the document to deleteid
- The id of the document to delete
-
bulk
ActionFuture<BulkResponse> bulk(BulkRequest request)
Executes a bulk of index / delete operations.- Parameters:
request
- The bulk request- Returns:
- The result future
- See Also:
Requests.bulkRequest()
-
bulk
void bulk(BulkRequest request, ActionListener<BulkResponse> listener)
Executes a bulk of index / delete operations.- Parameters:
request
- The bulk requestlistener
- A listener to be notified with a result- See Also:
Requests.bulkRequest()
-
prepareBulk
BulkRequestBuilder prepareBulk()
Executes a bulk of index / delete operations.
-
prepareBulk
BulkRequestBuilder prepareBulk(@Nullable java.lang.String globalIndex, @Nullable java.lang.String globalType)
Executes a bulk of index / delete operations with default index and/or type
-
get
ActionFuture<GetResponse> get(GetRequest request)
Gets the document that was indexed from an index with a type and id.- Parameters:
request
- The get request- Returns:
- The result future
- See Also:
Requests.getRequest(String)
-
get
void get(GetRequest request, ActionListener<GetResponse> listener)
Gets the document that was indexed from an index with a type and id.- Parameters:
request
- The get requestlistener
- A listener to be notified with a result- See Also:
Requests.getRequest(String)
-
prepareGet
GetRequestBuilder prepareGet()
Gets the document that was indexed from an index with a type and id.
-
prepareGet
GetRequestBuilder prepareGet(java.lang.String index, @Nullable java.lang.String type, java.lang.String id)
Gets the document that was indexed from an index with a type (optional) and id.
-
multiGet
ActionFuture<MultiGetResponse> multiGet(MultiGetRequest request)
Multi get documents.
-
multiGet
void multiGet(MultiGetRequest request, ActionListener<MultiGetResponse> listener)
Multi get documents.
-
prepareMultiGet
MultiGetRequestBuilder prepareMultiGet()
Multi get documents.
-
search
ActionFuture<SearchResponse> search(SearchRequest request)
Search across one or more indices and one or more types with a query.- Parameters:
request
- The search request- Returns:
- The result future
- See Also:
Requests.searchRequest(String...)
-
search
void search(SearchRequest request, ActionListener<SearchResponse> listener)
Search across one or more indices and one or more types with a query.- Parameters:
request
- The search requestlistener
- A listener to be notified of the result- See Also:
Requests.searchRequest(String...)
-
prepareSearch
SearchRequestBuilder prepareSearch(java.lang.String... indices)
Search across one or more indices and one or more types with a query.
-
searchScroll
ActionFuture<SearchResponse> searchScroll(SearchScrollRequest request)
A search scroll request to continue searching a previous scrollable search request.- Parameters:
request
- The search scroll request- Returns:
- The result future
- See Also:
Requests.searchScrollRequest(String)
-
searchScroll
void searchScroll(SearchScrollRequest request, ActionListener<SearchResponse> listener)
A search scroll request to continue searching a previous scrollable search request.- Parameters:
request
- The search scroll requestlistener
- A listener to be notified of the result- See Also:
Requests.searchScrollRequest(String)
-
prepareSearchScroll
SearchScrollRequestBuilder prepareSearchScroll(java.lang.String scrollId)
A search scroll request to continue searching a previous scrollable search request.
-
multiSearch
ActionFuture<MultiSearchResponse> multiSearch(MultiSearchRequest request)
Performs multiple search requests.
-
multiSearch
void multiSearch(MultiSearchRequest request, ActionListener<MultiSearchResponse> listener)
Performs multiple search requests.
-
prepareMultiSearch
MultiSearchRequestBuilder prepareMultiSearch()
Performs multiple search requests.
-
termVectors
ActionFuture<TermVectorsResponse> termVectors(TermVectorsRequest request)
An action that returns the term vectors for a specific document.- Parameters:
request
- The term vector request- Returns:
- The response future
-
termVectors
void termVectors(TermVectorsRequest request, ActionListener<TermVectorsResponse> listener)
An action that returns the term vectors for a specific document.- Parameters:
request
- The term vector request
-
prepareTermVectors
TermVectorsRequestBuilder prepareTermVectors()
Builder for the term vector request.
-
prepareTermVectors
TermVectorsRequestBuilder prepareTermVectors(java.lang.String index, java.lang.String type, java.lang.String id)
Builder for the term vector request.- Parameters:
index
- The index to load the document fromtype
- The type of the documentid
- The id of the document
-
termVector
@Deprecated ActionFuture<TermVectorsResponse> termVector(TermVectorsRequest request)
Deprecated.An action that returns the term vectors for a specific document.- Parameters:
request
- The term vector request- Returns:
- The response future
-
termVector
@Deprecated void termVector(TermVectorsRequest request, ActionListener<TermVectorsResponse> listener)
Deprecated.An action that returns the term vectors for a specific document.- Parameters:
request
- The term vector request
-
prepareTermVector
@Deprecated TermVectorsRequestBuilder prepareTermVector()
Deprecated.Builder for the term vector request.
-
prepareTermVector
@Deprecated TermVectorsRequestBuilder prepareTermVector(java.lang.String index, java.lang.String type, java.lang.String id)
Deprecated.Builder for the term vector request.- Parameters:
index
- The index to load the document fromtype
- The type of the documentid
- The id of the document
-
multiTermVectors
ActionFuture<MultiTermVectorsResponse> multiTermVectors(MultiTermVectorsRequest request)
Multi get term vectors.
-
multiTermVectors
void multiTermVectors(MultiTermVectorsRequest request, ActionListener<MultiTermVectorsResponse> listener)
Multi get term vectors.
-
prepareMultiTermVectors
MultiTermVectorsRequestBuilder prepareMultiTermVectors()
Multi get term vectors.
-
prepareExplain
ExplainRequestBuilder prepareExplain(java.lang.String index, java.lang.String type, java.lang.String id)
Computes a score explanation for the specified request.- Parameters:
index
- The index this explain is targeted fortype
- The type this explain is targeted forid
- The document identifier this explain is targeted for
-
explain
ActionFuture<ExplainResponse> explain(ExplainRequest request)
Computes a score explanation for the specified request.- Parameters:
request
- The request encapsulating the query and document identifier to compute a score explanation for
-
explain
void explain(ExplainRequest request, ActionListener<ExplainResponse> listener)
Computes a score explanation for the specified request.- Parameters:
request
- The request encapsulating the query and document identifier to compute a score explanation forlistener
- A listener to be notified of the result
-
prepareClearScroll
ClearScrollRequestBuilder prepareClearScroll()
Clears the search contexts associated with specified scroll ids.
-
clearScroll
ActionFuture<ClearScrollResponse> clearScroll(ClearScrollRequest request)
Clears the search contexts associated with specified scroll ids.
-
clearScroll
void clearScroll(ClearScrollRequest request, ActionListener<ClearScrollResponse> listener)
Clears the search contexts associated with specified scroll ids.
-
prepareFieldCaps
FieldCapabilitiesRequestBuilder prepareFieldCaps(java.lang.String... indices)
Builder for the field capabilities request.
-
fieldCaps
ActionFuture<FieldCapabilitiesResponse> fieldCaps(FieldCapabilitiesRequest request)
An action that returns the field capabilities from the provided request
-
fieldCaps
void fieldCaps(FieldCapabilitiesRequest request, ActionListener<FieldCapabilitiesResponse> listener)
An action that returns the field capabilities from the provided request
-
settings
Settings settings()
Returns this clients settings
-
filterWithHeader
Client filterWithHeader(java.util.Map<java.lang.String,java.lang.String> headers)
Returns a new lightweight Client that applies all given headers to each of the requests issued from it.
-
getRemoteClusterClient
default Client getRemoteClusterClient(java.lang.String clusterAlias)
Returns a client to a remote cluster with the given cluster alias.- Throws:
java.lang.IllegalArgumentException
- if the given clusterAlias doesn't existjava.lang.UnsupportedOperationException
- if this functionality is not available on this client.
-
-