ElasticsearchOperations (Spring Data Elasticsearch 4.0.0.RELEASE API)

All Superinterfaces:

DocumentOperations, SearchOperations

All Known Implementing Classes:

AbstractElasticsearchTemplate, ElasticsearchRestTemplate, ElasticsearchTemplate
```
public interface ElasticsearchOperations
extends DocumentOperations, SearchOperations
```
ElasticsearchOperations. Since 4.0 this interface only contains common helper functions, the other methods have been moved to the different interfaces that are extended by ElasticsearchOperations. The interfaces now reflect the REST API structure of Elasticsearch.

Author:

Rizwan Idrees, Mohsin Husen, Kevin Leturc, Zetang Zeng, Dmitriy Yakovlev, Peter-Josef Meisch

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default boolean`	`addAlias(AliasQuery query, IndexCoordinates index)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)` and `IndexOperations.addAlias(AliasQuery)`
`default boolean`	`createIndex(Class<?> clazz)` Deprecated. since 4.0, use `IndexOperations.create()`
`default boolean`	`createIndex(Class<?> clazz, Object settings)` Deprecated. since 4.0, use `IndexOperations.create(Document)`
`default boolean`	`createIndex(String indexName)` Deprecated. since 4.0, use `IndexOperations.create()`
`default boolean`	`createIndex(String indexName, Object settings)` Deprecated. since 4.0, use `IndexOperations.create(Document)`
`default boolean`	`deleteIndex(Class<?> clazz)` Deprecated. since 4.0, use `IndexOperations.delete()`
`default boolean`	`deleteIndex(IndexCoordinates index)` Deprecated. since 4.0 use `indexOps(IndexCoordinates)` and `IndexOperations.delete()`
`default boolean`	`deleteIndex(String indexName)` Deprecated. since 4.0, use `IndexOperations.delete()`
`default Document`	`getDocument(Object object)` Deprecated. since 4.0, helper method for deprecated functions
`ElasticsearchConverter`	`getElasticsearchConverter()`
`IndexCoordinates`	`getIndexCoordinatesFor(Class<?> clazz)`
`default Map<String,Object>`	`getMapping(Class<?> clazz)` Deprecated. since 4.0, use `indexOps(Class)` and `IndexOperations.getMapping()`
`default Map<String,Object>`	`getMapping(IndexCoordinates index)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)` and `IndexOperations.getMapping()`
`default Map<String,Object>`	`getSetting(Class<?> clazz)` Deprecated. since 4.0, use `indexOps(Class)` and `IndexOperations.getSettings()`
`default Map<String,Object>`	`getSetting(String indexName)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)` and `IndexOperations.getSettings()` )}
`default Map<String,Object>`	`getSettings(Class<?> clazz, boolean includeDefaults)` Deprecated. since 4.0 use `indexOps(Class)` and `IndexOperations.getSettings(boolean)` ()}
`default Map<String,Object>`	`getSettings(String indexName, boolean includeDefaults)` Deprecated. since 4.0 use `indexOps(IndexCoordinates)` and `IndexOperations.getSettings(boolean)` ()}
`default boolean`	`indexExists(Class<?> clazz)` Deprecated. since 4.0, use `indexOps(Class)` and `IndexOperations.exists()`
`default boolean`	`indexExists(String indexName)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)` and `IndexOperations.exists()`
`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 class
`default boolean`	`putMapping(Class<?> clazz)` Deprecated. since 4.0, use `indexOps(Class)`, `IndexOperations.createMapping(Class)` and `IndexOperations.putMapping(Document)`
`default boolean`	`putMapping(Class<?> clazz, Object mappings)` Deprecated. since 4.0, use `indexOps(Class)` and `IndexOperations.putMapping(Document)`
`default boolean`	`putMapping(IndexCoordinates index, Class<?> clazz)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)`, `IndexOperations.createMapping(Class)` and `IndexOperations.putMapping(Document)`
`default boolean`	`putMapping(IndexCoordinates index, Object mappings)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)` and `IndexOperations.putMapping(Document)`
`default List<org.elasticsearch.cluster.metadata.AliasMetaData>`	`queryForAlias(String indexName)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)` and `IndexOperations.queryForAlias()`
`default void`	`refresh(Class<?> clazz)` Deprecated. since 4.0, use `indexOps(Class)` and `IndexOperations.refresh()` instead}
`default void`	`refresh(IndexCoordinates index)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)` and `IndexOperations.refresh()` instead}
`default boolean`	`removeAlias(AliasQuery query, IndexCoordinates index)` Deprecated. since 4.0, use `indexOps(IndexCoordinates)` `IndexOperations.removeAlias(AliasQuery)`
`default String`	`stringIdRepresentation(Object id)` gets the String representation for an id.

Methods inherited from interface org.springframework.data.elasticsearch.core.DocumentOperations
bulkIndex, bulkIndex, bulkUpdate, bulkUpdate, delete, delete, delete, delete, delete, delete, exists, exists, get, get, get, index, multiGet, queryForObject, save, save, save, save, save, update

Methods inherited from interface org.springframework.data.elasticsearch.core.SearchOperations
count, count, count, moreLikeThis, multiSearch, multiSearch, queryForIds, queryForList, queryForList, queryForList, queryForObject, queryForPage, queryForPage, queryForPage, search, search, search, search, searchForStream, searchForStream, searchOne, searchOne, stream, suggest

- Method Detail
  - indexOps
```
IndexOperations indexOps(Class<?> clazz)
```
    get an IndexOperations that is bound to the given class
    
    Returns:
    
    IndexOperations
  - indexOps
```
IndexOperations indexOps(IndexCoordinates index)
```
    get an IndexOperations that is bound to the given class
    
    Returns:
    
    IndexOperations
  - getElasticsearchConverter
```
ElasticsearchConverter getElasticsearchConverter()
```
  - getIndexCoordinatesFor
```
IndexCoordinates getIndexCoordinatesFor(Class<?> clazz)
```
  - createIndex
```
@Deprecated
default boolean createIndex(String indexName)
```
    Deprecated. since 4.0, use IndexOperations.create()
    
    Create an index for given indexName .
    
    Parameters:
    
    indexName - the name of the index
    
    Returns:
    
    true if the index was created
  - createIndex
```
@Deprecated
default boolean createIndex(String indexName,
                                        Object settings)
```
    Deprecated. since 4.0, use IndexOperations.create(Document)
    
    Create an index for given indexName and Settings.
    
    Parameters:
    
    indexName - the name of the index
    
    settings - the index settings
    
    Returns:
    
    true if the index was created
  - createIndex
```
@Deprecated
default boolean createIndex(Class<?> clazz)
```
    Deprecated. since 4.0, use IndexOperations.create()
    
    Create an index for a class if it does not already exist.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
    
    Returns:
    
    true if the index was created
  - createIndex
```
@Deprecated
default boolean createIndex(Class<?> clazz,
                                        Object settings)
```
    Deprecated. since 4.0, use IndexOperations.create(Document)
    
    Create an index for given class and Settings.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
    
    settings - the index settings
    
    Returns:
    
    true if the index was created
  - deleteIndex
```
@Deprecated
default boolean deleteIndex(Class<?> clazz)
```
    Deprecated. since 4.0, use IndexOperations.delete()
    
    Deletes an index for given entity.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
    
    Returns:
    
    true if the index was deleted
  - deleteIndex
```
@Deprecated
default boolean deleteIndex(String indexName)
```
    Deprecated. since 4.0, use IndexOperations.delete()
    
    Deletes an index.
    
    Parameters:
    
    indexName - the name of the index to delete
    
    Returns:
    
    true if the index was deleted
  - deleteIndex
```
@Deprecated
default boolean deleteIndex(IndexCoordinates index)
```
    Deprecated. since 4.0 use indexOps(IndexCoordinates) and IndexOperations.delete()
    
    Deletes an index for an IndexCoordinate
    
    Parameters:
    
    index - the index to delete
    
    Returns:
    
    true if the index was deleted
  - indexExists
```
@Deprecated
default boolean indexExists(String indexName)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates) and IndexOperations.exists()
    
    check if index exists.
    
    Parameters:
    
    indexName - the name of the index
    
    Returns:
    
    true if the index exists
  - indexExists
```
@Deprecated
default boolean indexExists(Class<?> clazz)
```
    Deprecated. since 4.0, use indexOps(Class) and IndexOperations.exists()
    
    check if index is exists.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
    
    Returns:
    
    true if the index exists
  - putMapping
```
@Deprecated
default boolean putMapping(Class<?> clazz)
```
    Deprecated. since 4.0, use indexOps(Class), IndexOperations.createMapping(Class) and IndexOperations.putMapping(Document)
    
    Create mapping for a class and store it to the index.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
    
    Returns:
    
    true if the mapping could be stored
  - putMapping
```
@Deprecated
default boolean putMapping(IndexCoordinates index,
                                       Class<?> clazz)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates), IndexOperations.createMapping(Class) and IndexOperations.putMapping(Document)
    
    Create mapping for the given class and put the mapping to the given index.
    
    Parameters:
    
    index - the index to store the mapping to
    
    clazz - The entity class, must be annotated with Document
    
    Returns:
    
    true if the mapping could be stored
  - putMapping
```
@Deprecated
default boolean putMapping(IndexCoordinates index,
                                       Object mappings)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates) and IndexOperations.putMapping(Document)
    
    Stores a mapping to an index.
    
    Parameters:
    
    index - the index to store the mapping to
    
    mappings - can be a JSON String or a Map
    
    Returns:
    
    true if the mapping could be stored
  - putMapping
```
@Deprecated
default boolean putMapping(Class<?> clazz,
                                       Object mappings)
```
    Deprecated. since 4.0, use indexOps(Class) and IndexOperations.putMapping(Document)
    
    Create mapping for a class Stores a mapping to an index.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
    
    mappings - can be a JSON String or a Map
    
    Returns:
    
    true if the mapping could be stored
  - getMapping
```
@Deprecated
default Map<String,Object> getMapping(Class<?> clazz)
```
    Deprecated. since 4.0, use indexOps(Class) and IndexOperations.getMapping()
    
    Get mapping for an index defined by a class.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document.
    
    Returns:
    
    the mapping
  - getMapping
```
@Deprecated
default Map<String,Object> getMapping(IndexCoordinates index)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates) and IndexOperations.getMapping()
    
    Get mapping for a given index.
    
    Parameters:
    
    index - the index to read the mapping from
    
    Returns:
    
    the mapping
  - addAlias
```
@Deprecated
default boolean addAlias(AliasQuery query,
                                     IndexCoordinates index)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates) and IndexOperations.addAlias(AliasQuery)
    
    Add an alias.
    
    Parameters:
    
    query - query defining the alias
    
    index - the index for which to add an alias
    
    Returns:
    
    true if the alias was created
  - removeAlias
```
@Deprecated
default boolean removeAlias(AliasQuery query,
                                        IndexCoordinates index)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates) IndexOperations.removeAlias(AliasQuery)
    
    Remove an alias.
    
    Parameters:
    
    query - query defining the alias
    
    index - the index for which to remove an alias
    
    Returns:
    
    true if the alias was removed
  - queryForAlias
```
@Deprecated
default List<org.elasticsearch.cluster.metadata.AliasMetaData> queryForAlias(String indexName)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates) and IndexOperations.queryForAlias()
    
    Get the alias informations for a specified index.
    
    Parameters:
    
    indexName - the name of the index
    
    Returns:
    
    alias information
  - getSetting
```
@Deprecated
default Map<String,Object> getSetting(String indexName)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates) and IndexOperations.getSettings() )}
    
    Get settings for a given indexName.
    
    Parameters:
    
    indexName - the name of the index
    
    Returns:
    
    the settings
  - getSetting
```
@Deprecated
default Map<String,Object> getSetting(Class<?> clazz)
```
    Deprecated. since 4.0, use indexOps(Class) and IndexOperations.getSettings()
    
    Get settings for a given class.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
    
    Returns:
    
    the settings
  - getSettings
```
@Deprecated
default Map<String,Object> getSettings(String indexName,
                                                   boolean includeDefaults)
```
    Deprecated. since 4.0 use indexOps(IndexCoordinates) and IndexOperations.getSettings(boolean) ()}
    
    Get settings for a given indexName.
    
    Parameters:
    
    indexName - the name of the index
    
    includeDefaults - whether or not to include all the default settings
    
    Returns:
    
    the settings
  - getSettings
```
default Map<String,Object> getSettings(Class<?> clazz,
                                       boolean includeDefaults)
```
    Deprecated. since 4.0 use indexOps(Class) and IndexOperations.getSettings(boolean) ()}
    
    Get settings for a given class.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
    
    includeDefaults - whether or not to include all the default settings
    
    Returns:
    
    the settings
  - refresh
```
@Deprecated
default void refresh(IndexCoordinates index)
```
    Deprecated. since 4.0, use indexOps(IndexCoordinates) and IndexOperations.refresh() instead}
    
    Refresh the index(es).
    
    Parameters:
    
    index - the index to refresh
  - refresh
```
@Deprecated
default void refresh(Class<?> clazz)
```
    Deprecated. since 4.0, use indexOps(Class) and IndexOperations.refresh() instead}
    
    Refresh the index.
    
    Parameters:
    
    clazz - The entity class, must be annotated with Document
  - getDocument
```
@Deprecated
 @Nullable
default Document getDocument(Object object)
```
    Deprecated. since 4.0, helper method for deprecated functions
    
    converts an object to a Document
    
    Parameters:
    
    object -
    
    Returns:
  - stringIdRepresentation
```
@Nullable
default String stringIdRepresentation(@Nullable
                                                Object id)
```
    gets the String representation for an id.
    
    Parameters:
    
    id -
    
    Returns:
    
    Since:
    
    4.0

Interface ElasticsearchOperations

Method Summary

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

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

Method Detail

indexOps

indexOps

getElasticsearchConverter

getIndexCoordinatesFor

createIndex

createIndex

createIndex

createIndex

deleteIndex

deleteIndex

deleteIndex

indexExists

indexExists

putMapping

putMapping

putMapping

putMapping

getMapping

getMapping

addAlias

removeAlias

queryForAlias

getSetting

getSetting

getSettings

getSettings

refresh

refresh

getDocument

stringIdRepresentation