Package org.hibernate.search.backend.elasticsearch.lowlevel.index.settings.impl

Class IndexSettings

java.lang.Object

org.hibernate.search.backend.elasticsearch.lowlevel.index.settings.impl.IndexSettings

public class IndexSettings
extends Object

Settings for an Elasticsearch index.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KNN_ATTRIBUTE
static final String	MAX_RESULT_WINDOW_ATTRIBUTE
static final int	MAX_RESULT_WINDOW_DEFAULT

Constructor Summary

Constructors

Constructor	Description
IndexSettings()
IndexSettings(Analysis analysis, Integer maxResultWindow, Map<String,com.google.gson.JsonElement> extraAttributes)

Method Summary

Modifier and Type	Method	Description
IndexSettings	diff(Map<String,com.google.gson.JsonElement> extraAttributesToRemove)	Remove all entries from extraAttributes that are present with the exact same values on extraAttributesToRemove parameter.
Analysis	getAnalysis()
Map<String,com.google.gson.JsonElement>	getExtraAttributes()
Boolean	getKnn()
Integer	getMaxResultWindow()
void	merge(IndexSettings other)	Merge these (custom) settings with settings generated by Hibernate Search.
void	setAnalysis(Analysis analysis)
void	setKnn(Boolean knn)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

MAX_RESULT_WINDOW_ATTRIBUTE

public static final String MAX_RESULT_WINDOW_ATTRIBUTE

See Also:

• Constant Field Values

KNN_ATTRIBUTE

public static final String KNN_ATTRIBUTE

See Also:

• Constant Field Values

MAX_RESULT_WINDOW_DEFAULT

public static final int MAX_RESULT_WINDOW_DEFAULT

See Also:

• Constant Field Values

Constructor Details

IndexSettings

public IndexSettings()

IndexSettings

public IndexSettings(Analysis analysis,
 Integer maxResultWindow,
 Map<String,com.google.gson.JsonElement> extraAttributes)

Method Details

getAnalysis

public Analysis getAnalysis()

setAnalysis

public void setAnalysis(Analysis analysis)

getMaxResultWindow

public Integer getMaxResultWindow()

getKnn

public Boolean getKnn()

setKnn

public void setKnn(Boolean knn)

getExtraAttributes

public Map<String,com.google.gson.JsonElement> getExtraAttributes()

toString

public String toString()

Overrides:

toString in class Object

merge

public void merge(IndexSettings other)

Merge these (custom) settings with settings generated by Hibernate Search.

Any conflict of definition will be solved in favor of this.

Parameters:

other - The other index settings

diff

public IndexSettings diff(Map<String,com.google.gson.JsonElement> extraAttributesToRemove)

Remove all entries from extraAttributes that are present with the exact same values on extraAttributesToRemove parameter.

Parameters:

extraAttributesToRemove - Other index settings extra attributes