ElasticsearchRestTemplate (Spring Data Elasticsearch 3.2.2.RELEASE API)

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

All Implemented Interfaces:

Aware, ApplicationContextAware, ElasticsearchOperations, EsClient<org.elasticsearch.client.RestHighLevelClient>
```
public class ElasticsearchRestTemplate
extends AbstractElasticsearchTemplate
implements ElasticsearchOperations, EsClient<org.elasticsearch.client.RestHighLevelClient>, ApplicationContextAware
```
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

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

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addAlias(AliasQuery query)` adding new alias
`void`	`bulkIndex(List<IndexQuery> queries, BulkOptions bulkOptions)` Bulk index all objects.
`void`	`bulkUpdate(List<UpdateQuery> queries, BulkOptions bulkOptions)` Bulk update all objects.
`void`	`clearScroll(String scrollId)` Clears the search contexts associated with specified scroll ids.
`<T> ScrolledPage<T>`	`continueScroll(String scrollId, long scrollTimeInMillis, Class<T> clazz)`
`<T> ScrolledPage<T>`	`continueScroll(String scrollId, long scrollTimeInMillis, Class<T> clazz, SearchResultMapper mapper)`
`<T> long`	`count(CriteriaQuery query)` return number of elements found by given query
`<T> long`	`count(CriteriaQuery criteriaQuery, Class<T> clazz)` return number of elements found by given query
`<T> long`	`count(SearchQuery query)` return number of elements found by given query
`<T> long`	`count(SearchQuery searchQuery, Class<T> clazz)` return number of elements found by given query
`<T> boolean`	`createIndex(Class<T> clazz)` Create an index for a class
`<T> boolean`	`createIndex(Class<T> clazz, Object settings)` Create an index for given class and Settings
`boolean`	`createIndex(String indexName)` Create an index for given indexName
`boolean`	`createIndex(String indexName, Object settings)` Create an index for given indexName and Settings
`<T> String`	`delete(Class<T> clazz, String id)` Delete the one object with provided id
`<T> void`	`delete(CriteriaQuery criteriaQuery, Class<T> clazz)` Delete all records matching the criteria
`void`	`delete(DeleteQuery deleteQuery)` Delete all records matching the query
`<T> void`	`delete(DeleteQuery deleteQuery, Class<T> clazz)` Delete all records matching the query
`String`	`delete(String indexName, String type, String id)` Delete the one object with provided id
`<T> boolean`	`deleteIndex(Class<T> clazz)` Deletes an index for given entity
`boolean`	`deleteIndex(String indexName)` Deletes an index for given indexName
`org.elasticsearch.client.RestHighLevelClient`	`getClient()`
`ElasticsearchConverter`	`getElasticsearchConverter()`
`<T> Map<String,Object>`	`getMapping(Class<T> clazz)` Get mapping for a class
`Map<String,Object>`	`getMapping(String indexName, String type)` Get mapping for a given indexName and type
`ElasticsearchPersistentEntity`	`getPersistentEntityFor(Class clazz)`
`protected ResultsMapper`	`getResultsMapper()`
`<T> Map`	`getSetting(Class<T> clazz)` Get settings for a given class
`Map`	`getSetting(String indexName)` Get settings for a given indexName
`String`	`index(IndexQuery query)` Index an object.
`<T> boolean`	`indexExists(Class<T> clazz)` check if index is exists
`boolean`	`indexExists(String indexName)` check if index is exists for given IndexName
`<T> Page<T>`	`moreLikeThis(MoreLikeThisQuery query, Class<T> clazz)` more like this query to search for documents that are "like" a specific document.
`<T> List<T>`	`multiGet(SearchQuery searchQuery, Class<T> clazz)` Execute a multiGet against elasticsearch for the given ids
`<T> List<T>`	`multiGet(SearchQuery searchQuery, Class<T> clazz, MultiGetResultMapper getResultMapper)` Execute a multiGet against elasticsearch for the given ids with MultiGetResultMapper
`<T> boolean`	`putMapping(Class<T> clazz)` Create mapping for a class
`<T> boolean`	`putMapping(Class<T> clazz, Object mapping)` Create mapping for a class
`<T> boolean`	`putMapping(String indexName, String type, Class<T> clazz)` Create mapping for the given class and put the mapping to the given indexName and type.
`boolean`	`putMapping(String indexName, String type, Object mapping)` Create mapping for a given indexName and type
`<T> T`	`query(SearchQuery query, ResultsExtractor<T> resultsExtractor)`
`List<org.elasticsearch.cluster.metadata.AliasMetaData>`	`queryForAlias(String indexName)` get all the alias pointing to specified index
`<T> List<String>`	`queryForIds(SearchQuery query)` Execute the query against elasticsearch and return ids
`<T> List<T>`	`queryForList(CriteriaQuery query, Class<T> clazz)` Execute the criteria query against elasticsearch and return result as `List`
`<T> List<T>`	`queryForList(SearchQuery query, Class<T> clazz)` Execute the search query against elasticsearch and return result as `List`
`<T> List<T>`	`queryForList(StringQuery query, Class<T> clazz)` Execute the string query against elasticsearch and return result as `List`
`<T> T`	`queryForObject(CriteriaQuery query, Class<T> clazz)` Execute the query against elasticsearch and return the first returned object
`<T> T`	`queryForObject(GetQuery query, Class<T> clazz)` Execute the query against elasticsearch and return the first returned object
`<T> T`	`queryForObject(GetQuery query, Class<T> clazz, GetResultMapper mapper)` Execute the query against elasticsearch and return the first returned object using custom mapper
`<T> T`	`queryForObject(StringQuery query, Class<T> clazz)` Execute the query against elasticsearch and return the first returned object
`<T> Page<T>`	`queryForPage(CriteriaQuery criteriaQuery, Class<T> clazz)` Execute the query against elasticsearch and return result as `Page`
`<T> List<Page<T>>`	`queryForPage(List<SearchQuery> queries, Class<T> clazz)` Execute the multi-search against elasticsearch and return result as `List` of `Page`
`<T> List<Page<T>>`	`queryForPage(List<SearchQuery> queries, Class<T> clazz, SearchResultMapper mapper)` Execute the multi-search against elasticsearch and return result as `List` of `Page` using custom mapper
`List<Page<?>>`	`queryForPage(List<SearchQuery> queries, List<Class<?>> classes)` Execute the multi-search against elasticsearch and return result as `List` of `Page`
`List<Page<?>>`	`queryForPage(List<SearchQuery> queries, List<Class<?>> classes, SearchResultMapper mapper)` Execute the multi-search against elasticsearch and return result as `List` of `Page` using custom mapper
`<T> AggregatedPage<T>`	`queryForPage(SearchQuery query, Class<T> clazz)` Execute the query against elasticsearch and return result as `Page`
`<T> AggregatedPage<T>`	`queryForPage(SearchQuery query, Class<T> clazz, SearchResultMapper mapper)` Execute the query against elasticsearch and return result as `Page` using custom mapper
`<T> Page<T>`	`queryForPage(StringQuery query, Class<T> clazz)` Execute the query against elasticsearch and return result as `Page`
`<T> Page<T>`	`queryForPage(StringQuery query, Class<T> clazz, SearchResultMapper mapper)` Execute the query against elasticsearch and return result as `Page` using custom mapper
`static String`	`readFileFromClasspath(String url)` Deprecated.
`<T> void`	`refresh(Class<T> clazz)` refresh the index
`void`	`refresh(String indexName)` refresh the index
`boolean`	`removeAlias(AliasQuery query)` removing previously created alias
`void`	`setApplicationContext(ApplicationContext context)`
`void`	`setSearchTimeout(String searchTimeout)`
`<T> ScrolledPage<T>`	`startScroll(long scrollTimeInMillis, CriteriaQuery criteriaQuery, Class<T> clazz)` Returns scrolled page for given query
`<T> ScrolledPage<T>`	`startScroll(long scrollTimeInMillis, CriteriaQuery criteriaQuery, Class<T> clazz, SearchResultMapper mapper)` Returns scrolled page for given query
`<T> ScrolledPage<T>`	`startScroll(long scrollTimeInMillis, SearchQuery searchQuery, Class<T> clazz)` Returns scrolled page for given query
`<T> ScrolledPage<T>`	`startScroll(long scrollTimeInMillis, SearchQuery searchQuery, Class<T> clazz, SearchResultMapper mapper)` Returns scrolled page for given query
`<T> CloseableIterator<T>`	`stream(CriteriaQuery query, Class<T> clazz)` Executes the given `CriteriaQuery` against elasticsearch and return result as `CloseableIterator`.
`<T> CloseableIterator<T>`	`stream(SearchQuery query, Class<T> clazz)` Executes the given `SearchQuery` against elasticsearch and return result as `CloseableIterator`.
`<T> CloseableIterator<T>`	`stream(SearchQuery query, Class<T> clazz, SearchResultMapper mapper)` Executes the given `SearchQuery` against elasticsearch and return result as `CloseableIterator` using custom mapper.
`org.elasticsearch.action.search.SearchResponse`	`suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, Class clazz)`
`org.elasticsearch.action.search.SearchResponse`	`suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, String... indices)`
`boolean`	`typeExists(String index, String type)` check if type is exists in an index
`org.elasticsearch.action.update.UpdateResponse`	`update(UpdateQuery query)` Partial update of the document

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

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
bulkIndex, bulkUpdate, queryForList, queryForList

- Constructor Detail
  - ElasticsearchRestTemplate
```
public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client)
```
  - ElasticsearchRestTemplate
```
public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client,
                                 EntityMapper entityMapper)
```
  - ElasticsearchRestTemplate
```
public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client,
                                 ElasticsearchConverter elasticsearchConverter,
                                 EntityMapper entityMapper)
```
  - ElasticsearchRestTemplate
```
public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client,
                                 ResultsMapper resultsMapper)
```
  - ElasticsearchRestTemplate
```
public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client,
                                 ElasticsearchConverter elasticsearchConverter)
```
  - ElasticsearchRestTemplate
```
public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client,
                                 ElasticsearchConverter elasticsearchConverter,
                                 ResultsMapper resultsMapper)
```
- Method Detail
  - getClient
```
public org.elasticsearch.client.RestHighLevelClient getClient()
```
    Specified by:
    
    getClient in interface EsClient<org.elasticsearch.client.RestHighLevelClient>
  - setSearchTimeout
```
public void setSearchTimeout(String searchTimeout)
```
  - addAlias
```
public boolean addAlias(AliasQuery query)
```
    Description copied from interface: ElasticsearchOperations
    
    adding new alias
    
    Specified by:
    
    addAlias in interface ElasticsearchOperations
    
    Returns:
  - removeAlias
```
public boolean removeAlias(AliasQuery query)
```
    Description copied from interface: ElasticsearchOperations
    
    removing previously created alias
    
    Specified by:
    
    removeAlias in interface ElasticsearchOperations
    
    Returns:
  - createIndex
```
public <T> boolean createIndex(Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Create an index for a class
    
    Specified by:
    
    createIndex in interface ElasticsearchOperations
  - createIndex
```
public boolean createIndex(String indexName)
```
    Description copied from interface: ElasticsearchOperations
    
    Create an index for given indexName
    
    Specified by:
    
    createIndex in interface ElasticsearchOperations
  - putMapping
```
public <T> boolean putMapping(Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Create mapping for a class
    
    Specified by:
    
    putMapping in interface ElasticsearchOperations
  - putMapping
```
public <T> boolean putMapping(Class<T> clazz,
                              Object mapping)
```
    Description copied from interface: ElasticsearchOperations
    
    Create mapping for a class
    
    Specified by:
    
    putMapping in interface ElasticsearchOperations
  - putMapping
```
public <T> boolean putMapping(String indexName,
                              String type,
                              Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Create mapping for the given class and put the mapping to the given indexName and type.
    
    Specified by:
    
    putMapping in interface ElasticsearchOperations
  - putMapping
```
public boolean putMapping(String indexName,
                          String type,
                          Object mapping)
```
    Description copied from interface: ElasticsearchOperations
    
    Create mapping for a given indexName and type
    
    Specified by:
    
    putMapping in interface ElasticsearchOperations
  - getMapping
```
public Map<String,Object> getMapping(String indexName,
                                     String type)
```
    Description copied from interface: ElasticsearchOperations
    
    Get mapping for a given indexName and type
    
    Specified by:
    
    getMapping in interface ElasticsearchOperations
  - getMapping
```
public <T> Map<String,Object> getMapping(Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Get mapping for a class
    
    Specified by:
    
    getMapping in interface ElasticsearchOperations
  - getElasticsearchConverter
```
public ElasticsearchConverter getElasticsearchConverter()
```
    Specified by:
    
    getElasticsearchConverter in interface ElasticsearchOperations
    
    Returns:
    
    Converter in use
  - queryForObject
```
public <T> T queryForObject(GetQuery query,
                            Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return the first returned object
    
    Specified by:
    
    queryForObject in interface ElasticsearchOperations
    
    Returns:
    
    the first matching object
  - queryForObject
```
public <T> T queryForObject(GetQuery query,
                            Class<T> clazz,
                            GetResultMapper mapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return the first returned object using custom mapper
    
    Specified by:
    
    queryForObject in interface ElasticsearchOperations
    
    Returns:
    
    the first matching object
  - queryForObject
```
public <T> T queryForObject(CriteriaQuery query,
                            Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return the first returned object
    
    Specified by:
    
    queryForObject in interface ElasticsearchOperations
    
    Returns:
    
    the first matching object
  - queryForObject
```
public <T> T queryForObject(StringQuery query,
                            Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return the first returned object
    
    Specified by:
    
    queryForObject in interface ElasticsearchOperations
    
    Returns:
    
    the first matching object
  - queryForPage
```
public <T> AggregatedPage<T> queryForPage(SearchQuery query,
                                          Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return result as Page
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - queryForPage
```
public <T> AggregatedPage<T> queryForPage(SearchQuery query,
                                          Class<T> clazz,
                                          SearchResultMapper mapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return result as Page using custom mapper
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - queryForPage
```
public <T> List<Page<T>> queryForPage(List<SearchQuery> queries,
                                      Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the multi-search against elasticsearch and return result as List of Page
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - queryForPage
```
public <T> List<Page<T>> queryForPage(List<SearchQuery> queries,
                                      Class<T> clazz,
                                      SearchResultMapper mapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the multi-search against elasticsearch and return result as List of Page using custom mapper
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - queryForPage
```
public List<Page<?>> queryForPage(List<SearchQuery> queries,
                                  List<Class<?>> classes)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the multi-search against elasticsearch and return result as List of Page
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - queryForPage
```
public List<Page<?>> queryForPage(List<SearchQuery> queries,
                                  List<Class<?>> classes,
                                  SearchResultMapper mapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the multi-search against elasticsearch and return result as List of Page using custom mapper
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - query
```
public <T> T query(SearchQuery query,
                   ResultsExtractor<T> resultsExtractor)
```
    Specified by:
    
    query in interface ElasticsearchOperations
  - queryForList
```
public <T> List<T> queryForList(CriteriaQuery query,
                                Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the criteria query against elasticsearch and return result as List
    
    Specified by:
    
    queryForList in interface ElasticsearchOperations
    
    Returns:
  - queryForList
```
public <T> List<T> queryForList(StringQuery query,
                                Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the string query against elasticsearch and return result as List
    
    Specified by:
    
    queryForList in interface ElasticsearchOperations
    
    Returns:
  - queryForList
```
public <T> List<T> queryForList(SearchQuery query,
                                Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the search query against elasticsearch and return result as List
    
    Specified by:
    
    queryForList in interface ElasticsearchOperations
    
    Returns:
  - queryForIds
```
public <T> List<String> queryForIds(SearchQuery query)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return ids
    
    Specified by:
    
    queryForIds in interface ElasticsearchOperations
    
    Returns:
  - queryForPage
```
public <T> Page<T> queryForPage(CriteriaQuery criteriaQuery,
                                Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return result as Page
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - queryForPage
```
public <T> Page<T> queryForPage(StringQuery query,
                                Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return result as Page
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - queryForPage
```
public <T> Page<T> queryForPage(StringQuery query,
                                Class<T> clazz,
                                SearchResultMapper mapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute the query against elasticsearch and return result as Page using custom mapper
    
    Specified by:
    
    queryForPage in interface ElasticsearchOperations
    
    Returns:
  - stream
```
public <T> CloseableIterator<T> stream(CriteriaQuery query,
                                       Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Executes the given CriteriaQuery against elasticsearch and return result as CloseableIterator.
    Returns a CloseableIterator that wraps an Elasticsearch scroll context that needs to be closed in case of error.
    
    Specified by:
    
    stream in interface ElasticsearchOperations
    
    Type Parameters:
    
    T - element return type
    
    Returns:
  - stream
```
public <T> CloseableIterator<T> stream(SearchQuery query,
                                       Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Executes the given SearchQuery against elasticsearch and return result as CloseableIterator.
    Returns a CloseableIterator that wraps an Elasticsearch scroll context that needs to be closed in case of error.
    
    Specified by:
    
    stream in interface ElasticsearchOperations
    
    Type Parameters:
    
    T - element return type
    
    Returns:
  - stream
```
public <T> CloseableIterator<T> stream(SearchQuery query,
                                       Class<T> clazz,
                                       SearchResultMapper mapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Executes the given SearchQuery against elasticsearch and return result as CloseableIterator using custom mapper.
    Returns a CloseableIterator that wraps an Elasticsearch scroll context that needs to be closed in case of error.
    
    Specified by:
    
    stream in interface ElasticsearchOperations
    
    Type Parameters:
    
    T - element return type
    
    Returns:
  - count
```
public <T> long count(CriteriaQuery criteriaQuery,
                      Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    return number of elements found by given query
    
    Specified by:
    
    count in interface ElasticsearchOperations
    
    Returns:
  - count
```
public <T> long count(SearchQuery searchQuery,
                      Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    return number of elements found by given query
    
    Specified by:
    
    count in interface ElasticsearchOperations
    
    Returns:
  - count
```
public <T> long count(CriteriaQuery query)
```
    Description copied from interface: ElasticsearchOperations
    
    return number of elements found by given query
    
    Specified by:
    
    count in interface ElasticsearchOperations
    
    Returns:
  - count
```
public <T> long count(SearchQuery query)
```
    Description copied from interface: ElasticsearchOperations
    
    return number of elements found by given query
    
    Specified by:
    
    count in interface ElasticsearchOperations
    
    Returns:
  - multiGet
```
public <T> List<T> multiGet(SearchQuery searchQuery,
                            Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute a multiGet against elasticsearch for the given ids
    
    Specified by:
    
    multiGet in interface ElasticsearchOperations
    
    Returns:
  - multiGet
```
public <T> List<T> multiGet(SearchQuery searchQuery,
                            Class<T> clazz,
                            MultiGetResultMapper getResultMapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Execute a multiGet against elasticsearch for the given ids with MultiGetResultMapper
    
    Specified by:
    
    multiGet in interface ElasticsearchOperations
    
    Returns:
  - index
```
public String index(IndexQuery query)
```
    Description copied from interface: ElasticsearchOperations
    
    Index an object. Will do save or update
    
    Specified by:
    
    index in interface ElasticsearchOperations
    
    Returns:
    
    returns the document id
  - update
```
public org.elasticsearch.action.update.UpdateResponse update(UpdateQuery query)
```
    Description copied from interface: ElasticsearchOperations
    
    Partial update of the document
    
    Specified by:
    
    update in interface ElasticsearchOperations
    
    Returns:
  - bulkIndex
```
public void bulkIndex(List<IndexQuery> queries,
                      BulkOptions bulkOptions)
```
    Description copied from interface: ElasticsearchOperations
    
    Bulk index all objects. Will do save or update.
    
    Specified by:
    
    bulkIndex in interface ElasticsearchOperations
    
    Parameters:
    
    queries - the queries to execute in bulk
    
    bulkOptions - options to be added to the bulk request
  - bulkUpdate
```
public void bulkUpdate(List<UpdateQuery> queries,
                       BulkOptions bulkOptions)
```
    Description copied from interface: ElasticsearchOperations
    
    Bulk update all objects. Will do update
    
    Specified by:
    
    bulkUpdate in interface ElasticsearchOperations
    
    Parameters:
    
    queries - the queries to execute in bulk
    
    bulkOptions - options to be added to the bulk request
  - indexExists
```
public <T> boolean indexExists(Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    check if index is exists
    
    Specified by:
    
    indexExists in interface ElasticsearchOperations
    
    Returns:
  - indexExists
```
public boolean indexExists(String indexName)
```
    Description copied from interface: ElasticsearchOperations
    
    check if index is exists for given IndexName
    
    Specified by:
    
    indexExists in interface ElasticsearchOperations
    
    Returns:
  - typeExists
```
public boolean typeExists(String index,
                          String type)
```
    Description copied from interface: ElasticsearchOperations
    
    check if type is exists in an index
    
    Specified by:
    
    typeExists in interface ElasticsearchOperations
    
    Returns:
  - deleteIndex
```
public <T> boolean deleteIndex(Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Deletes an index for given entity
    
    Specified by:
    
    deleteIndex in interface ElasticsearchOperations
    
    Returns:
  - deleteIndex
```
public boolean deleteIndex(String indexName)
```
    Description copied from interface: ElasticsearchOperations
    
    Deletes an index for given indexName
    
    Specified by:
    
    deleteIndex in interface ElasticsearchOperations
    
    Returns:
  - delete
```
public String delete(String indexName,
                     String type,
                     String id)
```
    Description copied from interface: ElasticsearchOperations
    
    Delete the one object with provided id
    
    Specified by:
    
    delete in interface ElasticsearchOperations
    
    Returns:
    
    documentId of the document deleted
  - delete
```
public <T> String delete(Class<T> clazz,
                         String id)
```
    Description copied from interface: ElasticsearchOperations
    
    Delete the one object with provided id
    
    Specified by:
    
    delete in interface ElasticsearchOperations
    
    Returns:
    
    documentId of the document deleted
  - delete
```
public <T> void delete(DeleteQuery deleteQuery,
                       Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Delete all records matching the query
    
    Specified by:
    
    delete in interface ElasticsearchOperations
  - delete
```
public void delete(DeleteQuery deleteQuery)
```
    Description copied from interface: ElasticsearchOperations
    
    Delete all records matching the query
    
    Specified by:
    
    delete in interface ElasticsearchOperations
  - delete
```
public <T> void delete(CriteriaQuery criteriaQuery,
                       Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Delete all records matching the criteria
    
    Specified by:
    
    delete in interface ElasticsearchOperations
  - startScroll
```
public <T> ScrolledPage<T> startScroll(long scrollTimeInMillis,
                                       SearchQuery searchQuery,
                                       Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Returns scrolled page for given query
    
    Specified by:
    
    startScroll in interface ElasticsearchOperations
    
    Parameters:
    
    scrollTimeInMillis - The time in millisecond for scroll feature SearchRequestBuilder.setScroll(org.elasticsearch.common.unit.TimeValue).
    
    searchQuery - The search query.
    
    clazz - The class of entity to retrieve.
    
    Returns:
    
    The scan id for input query.
  - startScroll
```
public <T> ScrolledPage<T> startScroll(long scrollTimeInMillis,
                                       CriteriaQuery criteriaQuery,
                                       Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Returns scrolled page for given query
    
    Specified by:
    
    startScroll in interface ElasticsearchOperations
    
    Parameters:
    
    scrollTimeInMillis - The time in millisecond for scroll feature SearchRequestBuilder.setScroll(org.elasticsearch.common.unit.TimeValue).
    
    criteriaQuery - The search query.
    
    clazz - The class of entity to retrieve.
    
    Returns:
    
    The scan id for input query.
  - startScroll
```
public <T> ScrolledPage<T> startScroll(long scrollTimeInMillis,
                                       SearchQuery searchQuery,
                                       Class<T> clazz,
                                       SearchResultMapper mapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Returns scrolled page for given query
    
    Specified by:
    
    startScroll in interface ElasticsearchOperations
    
    Parameters:
    
    scrollTimeInMillis - The time in millisecond for scroll feature SearchRequestBuilder.setScroll(org.elasticsearch.common.unit.TimeValue).
    
    searchQuery - The search query.
    
    mapper - Custom impl to map result to entities
    
    Returns:
    
    The scan id for input query.
  - startScroll
```
public <T> ScrolledPage<T> startScroll(long scrollTimeInMillis,
                                       CriteriaQuery criteriaQuery,
                                       Class<T> clazz,
                                       SearchResultMapper mapper)
```
    Description copied from interface: ElasticsearchOperations
    
    Returns scrolled page for given query
    
    Specified by:
    
    startScroll in interface ElasticsearchOperations
    
    Parameters:
    
    scrollTimeInMillis - The time in millisecond for scroll feature SearchRequestBuilder.setScroll(org.elasticsearch.common.unit.TimeValue).
    
    criteriaQuery - The search query.
    
    mapper - Custom impl to map result to entities
    
    Returns:
    
    The scan id for input query.
  - continueScroll
```
public <T> ScrolledPage<T> continueScroll(@Nullable
                                          String scrollId,
                                          long scrollTimeInMillis,
                                          Class<T> clazz)
```
    Specified by:
    
    continueScroll in interface ElasticsearchOperations
  - continueScroll
```
public <T> ScrolledPage<T> continueScroll(@Nullable
                                          String scrollId,
                                          long scrollTimeInMillis,
                                          Class<T> clazz,
                                          SearchResultMapper mapper)
```
    Specified by:
    
    continueScroll in interface ElasticsearchOperations
  - clearScroll
```
public void clearScroll(String scrollId)
```
    Description copied from interface: ElasticsearchOperations
    
    Clears the search contexts associated with specified scroll ids.
    
    Specified by:
    
    clearScroll in interface ElasticsearchOperations
  - moreLikeThis
```
public <T> Page<T> moreLikeThis(MoreLikeThisQuery query,
                                Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    more like this query to search for documents that are "like" a specific document.
    
    Specified by:
    
    moreLikeThis in interface ElasticsearchOperations
    
    Returns:
  - createIndex
```
public boolean createIndex(String indexName,
                           Object settings)
```
    Description copied from interface: ElasticsearchOperations
    
    Create an index for given indexName and Settings
    
    Specified by:
    
    createIndex in interface ElasticsearchOperations
  - createIndex
```
public <T> boolean createIndex(Class<T> clazz,
                               Object settings)
```
    Description copied from interface: ElasticsearchOperations
    
    Create an index for given class and Settings
    
    Specified by:
    
    createIndex in interface ElasticsearchOperations
  - getSetting
```
public <T> Map getSetting(Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    Get settings for a given class
    
    Specified by:
    
    getSetting in interface ElasticsearchOperations
  - getSetting
```
public Map getSetting(String indexName)
```
    Description copied from interface: ElasticsearchOperations
    
    Get settings for a given indexName
    
    Specified by:
    
    getSetting in interface ElasticsearchOperations
  - refresh
```
public void refresh(String indexName)
```
    Description copied from interface: ElasticsearchOperations
    
    refresh the index
    
    Specified by:
    
    refresh in interface ElasticsearchOperations
  - refresh
```
public <T> void refresh(Class<T> clazz)
```
    Description copied from interface: ElasticsearchOperations
    
    refresh the index
    
    Specified by:
    
    refresh in interface ElasticsearchOperations
  - queryForAlias
```
public List<org.elasticsearch.cluster.metadata.AliasMetaData> queryForAlias(String indexName)
```
    Description copied from interface: ElasticsearchOperations
    
    get all the alias pointing to specified index
    
    Specified by:
    
    queryForAlias in interface ElasticsearchOperations
    
    Returns:
  - getPersistentEntityFor
```
public ElasticsearchPersistentEntity getPersistentEntityFor(Class clazz)
```
    Specified by:
    
    getPersistentEntityFor in interface ElasticsearchOperations
  - setApplicationContext
```
public void setApplicationContext(ApplicationContext context)
                           throws BeansException
```
    Specified by:
    
    setApplicationContext in interface ApplicationContextAware
    
    Throws:
    
    BeansException
  - getResultsMapper
```
protected ResultsMapper getResultsMapper()
```
  - readFileFromClasspath
```
@Deprecated
public static String readFileFromClasspath(String url)
```
    Deprecated.
  - suggest
```
public org.elasticsearch.action.search.SearchResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                              String... indices)
```
  - suggest
```
public org.elasticsearch.action.search.SearchResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                              Class clazz)
```

Class ElasticsearchRestTemplate

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

Constructor Detail

ElasticsearchRestTemplate

ElasticsearchRestTemplate

ElasticsearchRestTemplate

ElasticsearchRestTemplate

ElasticsearchRestTemplate

ElasticsearchRestTemplate

Method Detail

getClient

setSearchTimeout

addAlias

removeAlias

createIndex

createIndex

putMapping

putMapping

putMapping

putMapping

getMapping

getMapping

getElasticsearchConverter

queryForObject

queryForObject

queryForObject

queryForObject

queryForPage

queryForPage

queryForPage

queryForPage

queryForPage

queryForPage

query

queryForList

queryForList

queryForList

queryForIds

queryForPage

queryForPage

queryForPage

stream

stream

stream

count

count

count

count

multiGet

multiGet

index

update

bulkIndex

bulkUpdate

indexExists

indexExists

typeExists

deleteIndex

deleteIndex

delete

delete

delete

delete

delete

startScroll

startScroll

startScroll

startScroll

continueScroll

continueScroll

clearScroll

moreLikeThis

createIndex

createIndex