org.springframework.data.elasticsearch.annotations

Annotation Type Setting

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

Elasticsearch Setting

Author:

Mohsin Husen, Peter-Josef Meisch

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	indexStoreType Index storage type for the index.
String	refreshInterval Refresh interval for the index.
short	replicas Number of replicas for the index.
String	settingPath Resource path for a settings configuration
short	shards Number of shards for the index.
String[]	sortFields fields to define an index sorting
Setting.SortMissing[]	sortMissingValues defines the missing value for sortFields().
Setting.SortMode[]	sortModes defines the mode for sortFields().
Setting.SortOrder[]	sortOrders defines the order for sortFields().
boolean	useServerConfiguration Use server-side settings when creating the index.

Element Detail

settingPath

public abstract String settingPath

Resource path for a settings configuration

Default:

""

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. 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. Used for index creation.

Default:

1

refreshInterval

public abstract String refreshInterval

Refresh interval for the index. Used for index creation.

Default:

"1s"

indexStoreType

public abstract String indexStoreType

Index storage type for the index. Used for index creation.

Default:

"fs"

sortFields

public abstract String[] sortFields

fields to define an index sorting

Since:

4.2

Default:

{}

sortOrders

public abstract Setting.SortOrder[] sortOrders

defines the order for sortFields(). If present, it must have the same number of elements

Since:

4.2

Default:

{}

sortModes

public abstract Setting.SortMode[] sortModes

defines the mode for sortFields(). If present, it must have the same number of elements

Since:

4.2

Default:

{}

sortMissingValues

public abstract Setting.SortMissing[] sortMissingValues

defines the missing value for sortFields(). If present, it must have the same number of elements

Since:

4.2

Default:

{}