ElasticsearchRestTemplate (Spring Data Elasticsearch 4.1.5 API)

java.lang.Object
- org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate
- - org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate

All Implemented Interfaces:

Aware, ApplicationContextAware, DocumentOperations, ElasticsearchOperations, SearchOperations
```
public class ElasticsearchRestTemplate
extends AbstractElasticsearchTemplate
```
ElasticsearchRestTemplate

Author:

Rizwan Idrees, Mohsin Husen, Artur Konczak, Kevin Leturc, Mason Chan, Young Gu, Oliver Gierke, Mark Janssen, Chris White, Mark Paluch, Ilkang Na, Alen Turkovic, Sascha Woo, Ted Liang, Don Wellington, Zetang Zeng, Peter Nowak, Ivan Greene, Christoph Strobl, Lorenzo Spinelli, Dmitriy Yakovlev, Roman Puchkovskiy, Martin Choraine, Farid Azaza, Peter-Josef Meisch, Mathias Teier, Gyula Attila Csorogi, Massimiliano Poggi

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ElasticsearchRestTemplate.ClientCallback<T>` Callback interface to be used with `execute(ClientCallback)` for operating directly on `RestHighLevelClient`.

Nested classes/interfaces inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate
AbstractElasticsearchTemplate.DocumentCallback<T>, AbstractElasticsearchTemplate.ReadDocumentCallback<T>, AbstractElasticsearchTemplate.ReadSearchDocumentResponseCallback<T>, AbstractElasticsearchTemplate.ReadSearchScrollDocumentResponseCallback<T>, AbstractElasticsearchTemplate.SearchDocumentResponseCallback<T>

Field Summary
- Fields inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate
  elasticsearchConverter, requestFactory

Constructor Summary

Constructors
Constructor and Description
`ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client)`
`ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client, ElasticsearchConverter elasticsearchConverter)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`bulkUpdate(List<UpdateQuery> queries, BulkOptions bulkOptions, IndexCoordinates index)` Bulk update all objects.
`long`	`count(Query query, Class<?> clazz, IndexCoordinates index)` return number of elements found by given query
`void`	`delete(DeleteQuery deleteQuery, IndexCoordinates index)` Deprecated.
`void`	`delete(Query query, Class<?> clazz, IndexCoordinates index)` Delete all records matching the query.
`String`	`delete(String id, String routing, IndexCoordinates index)` Delete the one object with provided id.
`List<IndexedObjectInformation>`	`doBulkOperation(List<?> queries, BulkOptions bulkOptions, IndexCoordinates index)`
`protected boolean`	`doExists(String id, IndexCoordinates index)`
`String`	`doIndex(IndexQuery query, IndexCoordinates index)`
`<T> T`	`execute(ElasticsearchRestTemplate.ClientCallback<T> callback)` Execute a callback with the `RestHighLevelClient`
`<T> T`	`get(String id, Class<T> clazz, IndexCoordinates index)` Retrieves an object from the index specified in the entity's Document annotation.
`protected String`	`getClusterVersion()` tries to extract the version of the Elasticsearch cluster
`protected org.elasticsearch.action.search.MultiSearchResponse.Item[]`	`getMultiSearchResult(org.elasticsearch.action.search.MultiSearchRequest request)`
`IndexOperations`	`indexOps(Class<?> clazz)` get an `IndexOperations` that is bound to the given class
`IndexOperations`	`indexOps(IndexCoordinates index)` get an `IndexOperations` that is bound to the given index
`<T> List<T>`	`multiGet(Query query, Class<T> clazz, IndexCoordinates index)` Execute a multiGet against elasticsearch for the given ids.
`<T> SearchHits<T>`	`search(Query query, Class<T> clazz, IndexCoordinates index)` Execute the criteria query against elasticsearch and return result as `SearchHits`
`void`	`searchScrollClear(List<String> scrollIds)`
`<T> SearchScrollHits<T>`	`searchScrollContinue(String scrollId, long scrollTimeInMillis, Class<T> clazz, IndexCoordinates index)`
`<T> SearchScrollHits<T>`	`searchScrollStart(long scrollTimeInMillis, Query query, Class<T> clazz, IndexCoordinates index)`
`org.elasticsearch.action.search.SearchResponse`	`suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, IndexCoordinates index)` Does a suggest query
`UpdateResponse`	`update(UpdateQuery query, IndexCoordinates index)` Partial update of the document.

Methods inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate
bulkIndex, bulkIndex, bulkIndex, bulkOperation, bulkUpdate, checkForBulkOperationFailure, count, createElasticsearchConverter, delete, delete, delete, delete, exists, exists, get, get, getElasticsearchConverter, getEntityRouting, getIndexCoordinatesFor, getRequestFactory, index, initialize, maybeCallbackAfterConvert, maybeCallbackAfterSave, maybeCallbackAfterSaveWithQueries, maybeCallbackAfterSaveWithQuery, maybeCallbackBeforeConvert, maybeCallbackBeforeConvertWithQueries, maybeCallbackBeforeConvertWithQuery, multiGet, multiSearch, multiSearch, multiSearch, multiSearch, queryForObject, save, save, save, save, save, search, search, search, searchForStream, searchForStream, searchScrollClear, setApplicationContext, setEntityCallbacks, stream, suggest, toArray, updateIndexedObject, updateIndexedObjectsWithQueries

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

Methods inherited from interface org.springframework.data.elasticsearch.core.ElasticsearchOperations
addAlias, createIndex, createIndex, createIndex, createIndex, deleteIndex, deleteIndex, deleteIndex, getDocument, getMapping, getMapping, getSetting, getSetting, getSettings, getSettings, indexExists, indexExists, putMapping, putMapping, putMapping, putMapping, queryForAlias, refresh, refresh, removeAlias, stringIdRepresentation

Methods inherited from interface org.springframework.data.elasticsearch.core.DocumentOperations
bulkIndex, bulkUpdate, delete

Methods inherited from interface org.springframework.data.elasticsearch.core.SearchOperations
count, moreLikeThis, queryForIds, queryForList, queryForList, queryForList, queryForObject, queryForPage, queryForPage, queryForPage, searchOne, searchOne

Constructor Detail

ElasticsearchRestTemplate

public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client)

ElasticsearchRestTemplate

public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client,
                                 ElasticsearchConverter elasticsearchConverter)

Method Detail

indexOps
```
public IndexOperations indexOps(Class<?> clazz)
```
Description copied from interface: ElasticsearchOperations

get an IndexOperations that is bound to the given class

Returns:

IndexOperations

indexOps
```
public IndexOperations indexOps(IndexCoordinates index)
```
Description copied from interface: ElasticsearchOperations

get an IndexOperations that is bound to the given index

Returns:

IndexOperations

doIndex

public String doIndex(IndexQuery query,
                      IndexCoordinates index)

Specified by:: doIndex in class AbstractElasticsearchTemplate

get
```
@Nullable
public <T> T get(String id,
                           Class<T> clazz,
                           IndexCoordinates index)
```
Description copied from interface: DocumentOperations

Retrieves an object from the index specified in the entity's Document annotation.

Parameters:

id - the id of the object

clazz - the entity class,

index - the index from which the object is read.

Returns:

the entity

multiGet
```
public <T> List<T> multiGet(Query query,
                            Class<T> clazz,
                            IndexCoordinates index)
```
Description copied from interface: DocumentOperations

Execute a multiGet against elasticsearch for the given ids.

Parameters:

query - the query defining the ids of the objects to get

clazz - the type of the object to be returned

index - the index(es) from which the objects are read.

Returns:

list of objects, contains null values for ids that are not found

doExists

protected boolean doExists(String id,
                           IndexCoordinates index)

Specified by:: doExists in class AbstractElasticsearchTemplate

bulkUpdate
```
public void bulkUpdate(List<UpdateQuery> queries,
                       BulkOptions bulkOptions,
                       IndexCoordinates index)
```
Description copied from interface: DocumentOperations

Bulk update all objects. Will do update.

Parameters:

queries - the queries to execute in bulk

bulkOptions - options to be added to the bulk request

delete
```
public String delete(String id,
                     @Nullable
                     String routing,
                     IndexCoordinates index)
```
Description copied from interface: DocumentOperations

Delete the one object with provided id.

Parameters:

id - the document to delete

routing - the optional routing for the document to be deleted

index - the index from which to delete

Returns:

documentId of the document deleted

delete
```
public void delete(Query query,
                   Class<?> clazz,
                   IndexCoordinates index)
```
Description copied from interface: DocumentOperations

Delete all records matching the query.

Parameters:

query - query defining the objects

clazz - The entity class, must be annotated with Document

index - the index from which to delete

delete
```
@Deprecated
public void delete(DeleteQuery deleteQuery,
                               IndexCoordinates index)
```
Deprecated.

Description copied from interface: DocumentOperations

Delete all records matching the query.

Parameters:

deleteQuery - query defining the objects

index - the index where to delete the records

update
```
public UpdateResponse update(UpdateQuery query,
                             IndexCoordinates index)
```
Description copied from interface: DocumentOperations

Partial update of the document.

Parameters:

query - query defining the update

index - the index where to update the records

Returns:

the update response

doBulkOperation

public List<IndexedObjectInformation> doBulkOperation(List<?> queries,
                                                      BulkOptions bulkOptions,
                                                      IndexCoordinates index)

Specified by:: doBulkOperation in class AbstractElasticsearchTemplate

count
```
public long count(Query query,
                  @Nullable
                  Class<?> clazz,
                  IndexCoordinates index)
```
Description copied from interface: SearchOperations

return number of elements found by given query

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

count

search
```
public <T> SearchHits<T> search(Query query,
                                Class<T> clazz,
                                IndexCoordinates index)
```
Description copied from interface: SearchOperations

Execute the criteria query against elasticsearch and return result as SearchHits

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

SearchHits containing the list of found objects

searchScrollStart

public <T> SearchScrollHits<T> searchScrollStart(long scrollTimeInMillis,
                                                 Query query,
                                                 Class<T> clazz,
                                                 IndexCoordinates index)

Specified by:: searchScrollStart in class AbstractElasticsearchTemplate

searchScrollContinue

public <T> SearchScrollHits<T> searchScrollContinue(@Nullable
                                                    String scrollId,
                                                    long scrollTimeInMillis,
                                                    Class<T> clazz,
                                                    IndexCoordinates index)

Specified by:: searchScrollContinue in class AbstractElasticsearchTemplate

searchScrollClear
```
public void searchScrollClear(List<String> scrollIds)
```
Specified by:

searchScrollClear in class AbstractElasticsearchTemplate

suggest

public org.elasticsearch.action.search.SearchResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                              IndexCoordinates index)

Description copied from interface: SearchOperations

Does a suggest query

Parameters:: suggestion - the query; index - the index to run the query against
Returns:: the suggest response

getMultiSearchResult

protected org.elasticsearch.action.search.MultiSearchResponse.Item[] getMultiSearchResult(org.elasticsearch.action.search.MultiSearchRequest request)

Specified by:: getMultiSearchResult in class AbstractElasticsearchTemplate

execute
```
public <T> T execute(ElasticsearchRestTemplate.ClientCallback<T> callback)
```
Execute a callback with the RestHighLevelClient

Type Parameters:

T - the type returned from the callback

Parameters:

callback - the callback to execute, must not be null

Returns:

the callback result

Since:

4.0

getClusterVersion
```
protected String getClusterVersion()
```
Description copied from class: AbstractElasticsearchTemplate

tries to extract the version of the Elasticsearch cluster

Specified by:

getClusterVersion in class AbstractElasticsearchTemplate

Returns:

the version as string if it can be retrieved

Class ElasticsearchRestTemplate

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

Field Summary

Fields inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

Constructor Summary

Method Summary

Methods inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.data.elasticsearch.core.ElasticsearchOperations

Methods inherited from interface org.springframework.data.elasticsearch.core.DocumentOperations

Methods inherited from interface org.springframework.data.elasticsearch.core.SearchOperations

Constructor Detail

ElasticsearchRestTemplate

ElasticsearchRestTemplate

Method Detail

indexOps

indexOps

doIndex

get

multiGet

doExists

bulkUpdate

delete

delete

delete

update

doBulkOperation

count

search

searchScrollStart

searchScrollContinue

searchScrollClear

suggest

getMultiSearchResult

execute

getClusterVersion