ElasticsearchPersistentEntity (Spring Data Elasticsearch 4.1.3 API)

All Superinterfaces:

Iterable<ElasticsearchPersistentProperty>, PersistentEntity<T,ElasticsearchPersistentProperty>

All Known Implementing Classes:

SimpleElasticsearchPersistentEntity
```
public interface ElasticsearchPersistentEntity<T>
extends PersistentEntity<T,ElasticsearchPersistentProperty>
```
ElasticsearchPersistentEntity

Author:

Rizwan Idrees, Mohsin Husen, Mark Paluch, Sascha Woo, Oliver Gierke, Ivan Greene, Peter-Josef Meisch, Roman Puchkovskiy, Subhobrata Dey

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Document`	`getDefaultSettings()` returns the default settings for an index.
`IndexCoordinates`	`getIndexCoordinates()`
`String`	`getIndexStoreType()`
`ElasticsearchPersistentProperty`	`getJoinFieldProperty()` Returns the `JoinField` property of the `ElasticsearchPersistentEntity`.
`ElasticsearchPersistentProperty`	`getParentIdProperty()` Deprecated. since 4.1, not supported anymore by Elasticsearch
`String`	`getParentType()` Deprecated. since 4.1, not supported anymore by Elasticsearch
`ElasticsearchPersistentProperty`	`getPersistentPropertyWithFieldName(String fieldName)` returns the `ElasticsearchPersistentProperty` with the given fieldName (may be set by the `Field` annotation.
`String`	`getRefreshInterval()`
`short`	`getReplicas()`
`default ElasticsearchPersistentProperty`	`getRequiredSeqNoPrimaryTermProperty()` Returns the `SeqNoPrimaryTerm` property of the `ElasticsearchPersistentEntity` or throws an IllegalStateException in case no such property is available on the entity.
`ElasticsearchPersistentProperty`	`getScoreProperty()` Deprecated. since 4.0
`ElasticsearchPersistentProperty`	`getSeqNoPrimaryTermProperty()` Returns the `SeqNoPrimaryTerm` property of the `ElasticsearchPersistentEntity`.
`short`	`getShards()`
`ElasticsearchPersistentProperty`	`getVersionProperty()`
`org.elasticsearch.index.VersionType`	`getVersionType()`
`boolean`	`hasJoinFieldProperty()` Returns whether the `ElasticsearchPersistentEntity` has a `JoinField` property.
`boolean`	`hasScoreProperty()` Deprecated. since 4.0
`boolean`	`hasSeqNoPrimaryTermProperty()` Returns whether the `ElasticsearchPersistentEntity` has a `SeqNoPrimaryTerm` property.
`boolean`	`isCreateIndexAndMapping()`
`boolean`	`isUseServerConfiguration()`
`String`	`settingPath()`

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - getIndexCoordinates
```
IndexCoordinates getIndexCoordinates()
```
  - getShards
```
short getShards()
```
  - getReplicas
```
short getReplicas()
```
  - isUseServerConfiguration
```
boolean isUseServerConfiguration()
```
  - getRefreshInterval
```
@Nullable
String getRefreshInterval()
```
  - getIndexStoreType
```
@Nullable
String getIndexStoreType()
```
  - getVersionProperty
```
ElasticsearchPersistentProperty getVersionProperty()
```
    Specified by:
    
    getVersionProperty in interface PersistentEntity<T,ElasticsearchPersistentProperty>
  - getParentType
```
@Deprecated
 @Nullable
String getParentType()
```
    Deprecated. since 4.1, not supported anymore by Elasticsearch
  - getParentIdProperty
```
@Deprecated
 @Nullable
ElasticsearchPersistentProperty getParentIdProperty()
```
    Deprecated. since 4.1, not supported anymore by Elasticsearch
  - settingPath
```
@Nullable
String settingPath()
```
  - getVersionType
```
@Nullable
org.elasticsearch.index.VersionType getVersionType()
```
  - isCreateIndexAndMapping
```
boolean isCreateIndexAndMapping()
```
  - hasScoreProperty
```
@Deprecated
boolean hasScoreProperty()
```
    Deprecated. since 4.0
    
    Returns whether the ElasticsearchPersistentEntity has a score property. If this call returns true, getScoreProperty() will return a non-null value.
    
    Returns:
    
    false when ElasticsearchPersistentEntity does not define a score property.
    
    Since:
    
    3.1
  - getScoreProperty
```
@Nullable
 @Deprecated
ElasticsearchPersistentProperty getScoreProperty()
```
    Deprecated. since 4.0
    
    Returns the score property of the ElasticsearchPersistentEntity. Can be null in case no score property is available on the entity.
    
    Returns:
    
    the score ElasticsearchPersistentProperty of the PersistentEntity or null if not defined.
    
    Since:
    
    3.1
  - getPersistentPropertyWithFieldName
```
@Nullable
ElasticsearchPersistentProperty getPersistentPropertyWithFieldName(String fieldName)
```
    returns the ElasticsearchPersistentProperty with the given fieldName (may be set by the Field annotation.
    
    Parameters:
    
    fieldName - to field name for the search, must not be null
    
    Returns:
    
    the found property, otherwise null
    
    Since:
    
    4.0
  - hasSeqNoPrimaryTermProperty
```
boolean hasSeqNoPrimaryTermProperty()
```
    Returns whether the ElasticsearchPersistentEntity has a SeqNoPrimaryTerm property. If this call returns true, getSeqNoPrimaryTermProperty() will return a non-null value.
    
    Returns:
    
    false when ElasticsearchPersistentEntity does not define a SeqNoPrimaryTerm property.
    
    Since:
    
    4.0
  - hasJoinFieldProperty
```
boolean hasJoinFieldProperty()
```
    Returns whether the ElasticsearchPersistentEntity has a JoinField property. If this call returns true, getJoinFieldProperty() will return a non-null value.
    
    Returns:
    
    false when ElasticsearchPersistentEntity does not define a JoinField property.
    
    Since:
    
    4.1
  - getSeqNoPrimaryTermProperty
```
@Nullable
ElasticsearchPersistentProperty getSeqNoPrimaryTermProperty()
```
    Returns the SeqNoPrimaryTerm property of the ElasticsearchPersistentEntity. Can be null in case no such property is available on the entity.
    
    Returns:
    
    the SeqNoPrimaryTerm ElasticsearchPersistentProperty of the PersistentEntity or null if not defined.
    
    Since:
    
    4.0
  - getJoinFieldProperty
```
@Nullable
ElasticsearchPersistentProperty getJoinFieldProperty()
```
    Returns the JoinField property of the ElasticsearchPersistentEntity. Can be null in case no such property is available on the entity.
    
    Returns:
    
    the JoinField ElasticsearchPersistentProperty of the PersistentEntity or null if not defined.
    
    Since:
    
    4.1
  - getRequiredSeqNoPrimaryTermProperty
```
default ElasticsearchPersistentProperty getRequiredSeqNoPrimaryTermProperty()
```
    Returns the SeqNoPrimaryTerm property of the ElasticsearchPersistentEntity or throws an IllegalStateException in case no such property is available on the entity.
    
    Returns:
    
    the SeqNoPrimaryTerm ElasticsearchPersistentProperty of the PersistentEntity.
    
    Since:
    
    4.0
  - getDefaultSettings
```
Document getDefaultSettings()
```
    returns the default settings for an index.
    
    Returns:
    
    settings as Document
    
    Since:
    
    4.1

Interface ElasticsearchPersistentEntity<T>

Method Summary

Methods inherited from interface org.springframework.data.mapping.PersistentEntity

Methods inherited from interface java.lang.Iterable

Method Detail

getIndexCoordinates

getShards

getReplicas

isUseServerConfiguration

getRefreshInterval

getIndexStoreType

getVersionProperty

getParentType

getParentIdProperty

settingPath

getVersionType

isCreateIndexAndMapping

hasScoreProperty

getScoreProperty

getPersistentPropertyWithFieldName

hasSeqNoPrimaryTermProperty

hasJoinFieldProperty

getSeqNoPrimaryTermProperty

getJoinFieldProperty

getRequiredSeqNoPrimaryTermProperty

getDefaultSettings