org.springframework.data.elasticsearch.annotations

Annotation Type Document

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Document

Identifies a domain object to be persisted to Elasticsearch.

Author:

Rizwan Idrees, Mohsin Husen, Mason Chan, Ivan Greene, Mark Paluch, Peter-Josef Meisch

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	indexName Name of the Elasticsearch index.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	createIndex Configuration whether to create an index on repository bootstrapping.
String	indexStoreType Index storage type for the index indexName().
String	refreshInterval Refresh interval for the index indexName().
short	replicas Number of replicas for the index indexName().
short	shards Number of shards for the index indexName().
boolean	useServerConfiguration Use server-side settings when creating the index.
org.elasticsearch.index.VersionType	versionType Configuration of version management.

Element Detail

indexName

public abstract String indexName

Name of the Elasticsearch index.

• Lowercase only
• , |, ` ` (space character), ,, #/li>
• Cannot start with -, _, +
• Cannot be . or ..
• Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit faster)

useServerConfiguration

public abstract boolean useServerConfiguration

Use server-side settings when creating the index.

Default:

false

shards

public abstract short shards

Number of shards for the index indexName(). Used for index creation.
With version 4.0, the default value is changed from 5 to 1 to reflect the change in the default settings of Elasticsearch which changed to 1 as well in Elasticsearch 7.0.

Default:

1

replicas

public abstract short replicas

Number of replicas for the index indexName(). Used for index creation.

Default:

1

refreshInterval

public abstract String refreshInterval

Refresh interval for the index indexName(). Used for index creation.

Default:

"1s"

indexStoreType

public abstract String indexStoreType

Index storage type for the index indexName(). Used for index creation.

Default:

"fs"

createIndex

public abstract boolean createIndex

Configuration whether to create an index on repository bootstrapping.

Default:

true

versionType

public abstract org.elasticsearch.index.VersionType versionType

Configuration of version management.

Default:

org.elasticsearch.index.VersionType.EXTERNAL