Package com.algolia.search.models.settings

Class IndexSettings

java.lang.Object

com.algolia.search.models.settings.IndexSettings

All Implemented Interfaces:

Serializable

public class IndexSettings
extends Object
implements Serializable

Here is the list of parameters you can use with the set settings method. Parameters that can be overridden at search time also have the search scope. More information:

See Also:

Algolia.com, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	relevancyStrictness

Constructor Summary

Constructors

Constructor	Description
IndexSettings()

Method Summary

Modifier and Type	Method	Description
Boolean	getAdvancedSyntax()
List<String>	getAdvancedSyntaxFeatures()
Boolean	getAllowCompressionOfIntegerArray()
Boolean	getAllowTyposOnNumericTokens()
List<String>	getAlternativesAsExact()
Boolean	getAttributeCriteriaComputedByMinProximity()
String	getAttributeForDistinct()
List<String>	getAttributesForFaceting()
List<String>	getAttributesToHighlight()
List<String>	getAttributesToRetrieve()
List<String>	getAttributesToSnippet()
List<String>	getAttributesToTransliterate()
List<String>	getCamelCaseAttributes()
Map<String,Map<String,String>>	getCustomNormalization()
List<String>	getCustomRanking()
Map<String,Object>	getCustomSettings()
Map<String,List<String>>	getDecompoundedAttributes()
Boolean	getDecompoundQuery()
List<String>	getDisableExactOnAttributes()
List<String>	getDisablePrefixOnAttributes()
List<String>	getDisableTypoToleranceOnAttributes()
List<String>	getDisableTypoToleranceOnWords()
Distinct	getDistinct()
Boolean	getEnablePersonalization()
Boolean	getEnableRules()
String	getExactOnSingleWordQuery()
String	getHighlightPostTag()
String	getHighlightPreTag()
Long	getHitsPerPage()
IgnorePlurals	getIgnorePlurals()
List<String>	getIndexLanguages()
String	getKeepDiacriticsOnCharacters()
Integer	getMaxFacetHits()
Long	getMaxValuesPerFacet()
Integer	getMinProximity()
Integer	getMinWordSizefor1Typo()
Integer	getMinWordSizefor2Typos()
List<String>	getNumericAttributesForFiltering()
List<String>	getOptionalWords()
Long	getPaginationLimitedTo()
String	getPrimary()
List<String>	getQueryLanguages()
String	getQueryType()
List<String>	getRanking()
Integer	getRelevancyStrictness()
RemoveStopWords	getRemoveStopWords()
String	getRemoveWordsIfNoResults()
RenderingContent	getRenderingContent()
Boolean	getReplaceSynonymsInHighlight()
List<String>	getReplicas()
List<String>	getResponseFields()
Boolean	getRestrictHighlightAndSnippetArrays()
List<String>	getSearchableAttributes()
String	getSeparatorsToIndex()
String	getSnippetEllipsisText()
String	getSortFacetValuesBy()
TypoTolerance	getTypoTolerance()
List<String>	getUnretrievableAttributes()
Map<String,Object>	getUserData()
IndexSettings	setAdvancedSyntax(Boolean advancedSyntax)
IndexSettings	setAdvancedSyntaxFeatures(List<String> advancedSyntaxFeatures)
IndexSettings	setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray)
IndexSettings	setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)
IndexSettings	setAlternativesAsExact(List<String> alternativesAsExact)
IndexSettings	setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity)
IndexSettings	setAttributeForDistinct(String attributeForDistinct)
IndexSettings	setAttributesForFaceting(List<String> attributesForFaceting)
IndexSettings	setAttributesToHighlight(List<String> attributesToHighlight)
IndexSettings	setAttributesToIndex(List<String> attributesToIndex)
IndexSettings	setAttributesToRetrieve(List<String> attributesToRetrieve)
IndexSettings	setAttributesToSnippet(List<String> attributesToSnippet)
IndexSettings	setAttributesToTransliterate(List<String> attributesToTransliterate)
IndexSettings	setCamelCaseAttributes(List<String> camelCaseAttributes)
IndexSettings	setCustomNormalization(Map<String,Map<String,String>> customNormalization)
IndexSettings	setCustomRanking(List<String> customRanking)
IndexSettings	setCustomSetting(String key, Object value)
IndexSettings	setCustomSettings(Map<String,Object> customSettings)
IndexSettings	setDecompoundedAttributes(Map<String,List<String>> decompoundedAttributes)
IndexSettings	setDecompoundQuery(Boolean decompoundQuery)
IndexSettings	setDisableExactOnAttributes(List<String> disableExactOnAttributes)
IndexSettings	setDisablePrefixOnAttributes(List<String> disablePrefixOnAttributes)
IndexSettings	setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)
IndexSettings	setDisableTypoToleranceOnWords(List<String> disableTypoToleranceOnWords)
IndexSettings	setDistinct(Distinct distinct)
IndexSettings	setDistinct(Boolean distinct)
IndexSettings	setDistinct(Integer distinct)
IndexSettings	setEnablePersonalization(Boolean enablePersonalization)
IndexSettings	setEnableRules(Boolean enableRules)
IndexSettings	setExactOnSingleWordQuery(String exactOnSingleWordQuery)
IndexSettings	setHighlightPostTag(String highlightPostTag)
IndexSettings	setHighlightPreTag(String highlightPreTag)
IndexSettings	setHitsPerPage(Integer hitsPerPage)
IndexSettings	setHitsPerPage(Long hitsPerPage)
IndexSettings	setIgnorePlurals(IgnorePlurals ignorePlurals)
IndexSettings	setIgnorePlurals(Boolean ignorePlurals)
IndexSettings	setIgnorePlurals(List<String> ignorePlurals)
IndexSettings	setIndexLanguages(List<String> indexLanguages)
IndexSettings	setKeepDiacriticsOnCharacters(String keepDiacriticsOnCharacters)
IndexSettings	setMaxFacetHits(Integer maxFacetHits)
IndexSettings	setMaxValuesPerFacet(Integer maxValuesPerFacet)
IndexSettings	setMaxValuesPerFacet(Long maxValuesPerFacet)
IndexSettings	setMinProximity(Integer minProximity)
IndexSettings	setMinWordSizefor1Typo(Integer minWordSizefor1Typo)
IndexSettings	setMinWordSizefor2Typos(Integer minWordSizefor2Typos)
IndexSettings	setNumericAttributesForFiltering(List<String> numericAttributesForFiltering)
IndexSettings	setNumericAttributesToIndex(List<String> numericAttributesToIndex)
IndexSettings	setOptionalWords(List<String> optionalWords)
IndexSettings	setPaginationLimitedTo(Integer paginationLimitedTo)
IndexSettings	setPaginationLimitedTo(Long paginationLimitedTo)
IndexSettings	setQueryLanguages(List<String> queryLanguages)
IndexSettings	setQueryType(String queryType)
IndexSettings	setRanking(List<String> ranking)
IndexSettings	setRelevancyStrictness(Integer relevancyStrictness)
IndexSettings	setRemoveStopWords(RemoveStopWords removeStopWords)
IndexSettings	setRemoveStopWords(Boolean removeStopWords)
IndexSettings	setRemoveStopWords(List<String> removeStopWords)
IndexSettings	setRemoveWordsIfNoResults(String removeWordsIfNoResults)
IndexSettings	setRenderingContent(RenderingContent renderingContent)
IndexSettings	setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)
IndexSettings	setReplicas(List<String> replicas)
IndexSettings	setResponseFields(List<String> responseFields)
IndexSettings	setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)
IndexSettings	setSearchableAttributes(List<String> searchableAttributes)
IndexSettings	setSeparatorsToIndex(String separatorsToIndex)
IndexSettings	setSlaves(List<String> slaves)
IndexSettings	setSnippetEllipsisText(String snippetEllipsisText)
IndexSettings	setSortFacetValuesBy(String sortFacetValuesBy)
IndexSettings	setTypoTolerance(TypoTolerance typoTolerance)
IndexSettings	setUnretrievableAttributes(List<String> unretrievableAttributes)
IndexSettings	setUserData(Map<String,Object> userData)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

relevancyStrictness

protected Integer relevancyStrictness

Constructor Detail

IndexSettings

public IndexSettings()

Method Detail

getAttributesForFaceting

public List<String> getAttributesForFaceting()

setAttributesForFaceting

public IndexSettings setAttributesForFaceting(List<String> attributesForFaceting)

getAttributeForDistinct

public String getAttributeForDistinct()

setAttributeForDistinct

public IndexSettings setAttributeForDistinct(String attributeForDistinct)

getRanking

public List<String> getRanking()

setRanking

public IndexSettings setRanking(List<String> ranking)

getCustomRanking

public List<String> getCustomRanking()

setCustomRanking

public IndexSettings setCustomRanking(List<String> customRanking)

getSeparatorsToIndex

public String getSeparatorsToIndex()

setSeparatorsToIndex

public IndexSettings setSeparatorsToIndex(String separatorsToIndex)

getUnretrievableAttributes

public List<String> getUnretrievableAttributes()

setUnretrievableAttributes

public IndexSettings setUnretrievableAttributes(List<String> unretrievableAttributes)

getAllowCompressionOfIntegerArray

public Boolean getAllowCompressionOfIntegerArray()

setAllowCompressionOfIntegerArray

public IndexSettings setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray)

getDisableTypoToleranceOnWords

public List<String> getDisableTypoToleranceOnWords()

setDisableTypoToleranceOnWords

public IndexSettings setDisableTypoToleranceOnWords(List<String> disableTypoToleranceOnWords)

getDisableTypoToleranceOnAttributes

public List<String> getDisableTypoToleranceOnAttributes()

setDisableTypoToleranceOnAttributes

public IndexSettings setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

getMinWordSizefor1Typo

public Integer getMinWordSizefor1Typo()

setMinWordSizefor1Typo

public IndexSettings setMinWordSizefor1Typo(Integer minWordSizefor1Typo)

getMinWordSizefor2Typos

public Integer getMinWordSizefor2Typos()

setMinWordSizefor2Typos

public IndexSettings setMinWordSizefor2Typos(Integer minWordSizefor2Typos)

getHitsPerPage

public Long getHitsPerPage()

setHitsPerPage

public IndexSettings setHitsPerPage(Integer hitsPerPage)

setHitsPerPage

public IndexSettings setHitsPerPage(Long hitsPerPage)

getAttributesToRetrieve

public List<String> getAttributesToRetrieve()

setAttributesToRetrieve

public IndexSettings setAttributesToRetrieve(List<String> attributesToRetrieve)

getCamelCaseAttributes

public List<String> getCamelCaseAttributes()

setCamelCaseAttributes

public IndexSettings setCamelCaseAttributes(List<String> camelCaseAttributes)

getDecompoundedAttributes

public Map<String,List<String>> getDecompoundedAttributes()

setDecompoundedAttributes

public IndexSettings setDecompoundedAttributes(Map<String,List<String>> decompoundedAttributes)

getPrimary

public String getPrimary()

getUserData

public Map<String,Object> getUserData()

setUserData

public IndexSettings setUserData(Map<String,Object> userData)

getAttributesToHighlight

public List<String> getAttributesToHighlight()

setAttributesToHighlight

public IndexSettings setAttributesToHighlight(List<String> attributesToHighlight)

getAttributesToSnippet

public List<String> getAttributesToSnippet()

setAttributesToSnippet

public IndexSettings setAttributesToSnippet(List<String> attributesToSnippet)

getQueryType

public String getQueryType()

setQueryType

public IndexSettings setQueryType(String queryType)

getMinProximity

public Integer getMinProximity()

setMinProximity

public IndexSettings setMinProximity(Integer minProximity)

getAttributeCriteriaComputedByMinProximity

public Boolean getAttributeCriteriaComputedByMinProximity()

setAttributeCriteriaComputedByMinProximity

public IndexSettings setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity)

getHighlightPreTag

public String getHighlightPreTag()

setHighlightPreTag

public IndexSettings setHighlightPreTag(String highlightPreTag)

getHighlightPostTag

public String getHighlightPostTag()

setHighlightPostTag

public IndexSettings setHighlightPostTag(String highlightPostTag)

getOptionalWords

public List<String> getOptionalWords()

setOptionalWords

public IndexSettings setOptionalWords(List<String> optionalWords)

getAllowTyposOnNumericTokens

public Boolean getAllowTyposOnNumericTokens()

setAllowTyposOnNumericTokens

public IndexSettings setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

getIgnorePlurals

public IgnorePlurals getIgnorePlurals()

setIgnorePlurals

public IndexSettings setIgnorePlurals(List<String> ignorePlurals)

setIgnorePlurals

public IndexSettings setIgnorePlurals(IgnorePlurals ignorePlurals)

setIgnorePlurals

public IndexSettings setIgnorePlurals(Boolean ignorePlurals)

getAdvancedSyntax

public Boolean getAdvancedSyntax()

setAdvancedSyntax

public IndexSettings setAdvancedSyntax(Boolean advancedSyntax)

getAdvancedSyntaxFeatures

public List<String> getAdvancedSyntaxFeatures()

setAdvancedSyntaxFeatures

public IndexSettings setAdvancedSyntaxFeatures(List<String> advancedSyntaxFeatures)

getReplaceSynonymsInHighlight

public Boolean getReplaceSynonymsInHighlight()

setReplaceSynonymsInHighlight

public IndexSettings setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

getMaxValuesPerFacet

public Long getMaxValuesPerFacet()

setMaxValuesPerFacet

public IndexSettings setMaxValuesPerFacet(Integer maxValuesPerFacet)

setMaxValuesPerFacet

public IndexSettings setMaxValuesPerFacet(Long maxValuesPerFacet)

getDistinct

public Distinct getDistinct()

setDistinct

public IndexSettings setDistinct(Boolean distinct)

setDistinct

public IndexSettings setDistinct(Distinct distinct)

setDistinct

public IndexSettings setDistinct(Integer distinct)

getTypoTolerance

public TypoTolerance getTypoTolerance()

setTypoTolerance

public IndexSettings setTypoTolerance(TypoTolerance typoTolerance)

getRemoveStopWords

public RemoveStopWords getRemoveStopWords()

setRemoveStopWords

public IndexSettings setRemoveStopWords(List<String> removeStopWords)

setRemoveStopWords

public IndexSettings setRemoveStopWords(RemoveStopWords removeStopWords)

setRemoveStopWords

public IndexSettings setRemoveStopWords(Boolean removeStopWords)

getSnippetEllipsisText

public String getSnippetEllipsisText()

setSnippetEllipsisText

public IndexSettings setSnippetEllipsisText(String snippetEllipsisText)

getRemoveWordsIfNoResults

public String getRemoveWordsIfNoResults()

setRemoveWordsIfNoResults

public IndexSettings setRemoveWordsIfNoResults(String removeWordsIfNoResults)

getReplicas

public List<String> getReplicas()

setReplicas

public IndexSettings setReplicas(List<String> replicas)

setSlaves

public IndexSettings setSlaves(List<String> slaves)

getSearchableAttributes

public List<String> getSearchableAttributes()

setSearchableAttributes

public IndexSettings setSearchableAttributes(List<String> searchableAttributes)

setAttributesToIndex

public IndexSettings setAttributesToIndex(List<String> attributesToIndex)

getResponseFields

public List<String> getResponseFields()

setResponseFields

public IndexSettings setResponseFields(List<String> responseFields)

getMaxFacetHits

public Integer getMaxFacetHits()

setMaxFacetHits

public IndexSettings setMaxFacetHits(Integer maxFacetHits)

getRestrictHighlightAndSnippetArrays

public Boolean getRestrictHighlightAndSnippetArrays()

setRestrictHighlightAndSnippetArrays

public IndexSettings setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)

getPaginationLimitedTo

public Long getPaginationLimitedTo()

setPaginationLimitedTo

public IndexSettings setPaginationLimitedTo(Integer paginationLimitedTo)

setPaginationLimitedTo

public IndexSettings setPaginationLimitedTo(Long paginationLimitedTo)

getNumericAttributesForFiltering

public List<String> getNumericAttributesForFiltering()

setNumericAttributesForFiltering

public IndexSettings setNumericAttributesForFiltering(List<String> numericAttributesForFiltering)

setNumericAttributesToIndex

public IndexSettings setNumericAttributesToIndex(List<String> numericAttributesToIndex)

getDisablePrefixOnAttributes

public List<String> getDisablePrefixOnAttributes()

setDisablePrefixOnAttributes

public IndexSettings setDisablePrefixOnAttributes(List<String> disablePrefixOnAttributes)

getDisableExactOnAttributes

public List<String> getDisableExactOnAttributes()

setDisableExactOnAttributes

public IndexSettings setDisableExactOnAttributes(List<String> disableExactOnAttributes)

getExactOnSingleWordQuery

public String getExactOnSingleWordQuery()

setExactOnSingleWordQuery

public IndexSettings setExactOnSingleWordQuery(String exactOnSingleWordQuery)

getAlternativesAsExact

public List<String> getAlternativesAsExact()

setAlternativesAsExact

public IndexSettings setAlternativesAsExact(List<String> alternativesAsExact)

getEnableRules

public Boolean getEnableRules()

setEnableRules

public IndexSettings setEnableRules(Boolean enableRules)

getSortFacetValuesBy

public String getSortFacetValuesBy()

setSortFacetValuesBy

public IndexSettings setSortFacetValuesBy(String sortFacetValuesBy)

getKeepDiacriticsOnCharacters

public String getKeepDiacriticsOnCharacters()

setKeepDiacriticsOnCharacters

public IndexSettings setKeepDiacriticsOnCharacters(String keepDiacriticsOnCharacters)

getQueryLanguages

public List<String> getQueryLanguages()

setQueryLanguages

public IndexSettings setQueryLanguages(List<String> queryLanguages)

getCustomNormalization

public Map<String,Map<String,String>> getCustomNormalization()

setCustomNormalization

public IndexSettings setCustomNormalization(Map<String,Map<String,String>> customNormalization)

getIndexLanguages

public List<String> getIndexLanguages()

setIndexLanguages

public IndexSettings setIndexLanguages(List<String> indexLanguages)

setCustomSetting

public IndexSettings setCustomSetting(String key,
                                      Object value)

getCustomSettings

public Map<String,Object> getCustomSettings()

setCustomSettings

public IndexSettings setCustomSettings(Map<String,Object> customSettings)

getEnablePersonalization

public Boolean getEnablePersonalization()

setEnablePersonalization

public IndexSettings setEnablePersonalization(Boolean enablePersonalization)

getAttributesToTransliterate

public List<String> getAttributesToTransliterate()

setAttributesToTransliterate

public IndexSettings setAttributesToTransliterate(List<String> attributesToTransliterate)

getDecompoundQuery

public Boolean getDecompoundQuery()

setDecompoundQuery

public IndexSettings setDecompoundQuery(Boolean decompoundQuery)

getRelevancyStrictness

public Integer getRelevancyStrictness()

setRelevancyStrictness

public IndexSettings setRelevancyStrictness(Integer relevancyStrictness)

getRenderingContent

public RenderingContent getRenderingContent()

setRenderingContent

public IndexSettings setRenderingContent(RenderingContent renderingContent)

toString

public String toString()

Overrides:

toString in class Object