com.algolia.search.objects

Class IndexSettings

java.lang.Object

com.algolia.search.objects.IndexSettings

public class IndexSettings
extends Object

Constructor Summary

Constructors

Constructor and Description
IndexSettings()

Method Summary

Modifier and Type	Method and Description
Boolean	getAdvancedSyntax()
Boolean	getAllowCompressionOfIntegerArray()
Boolean	getAllowTyposOnNumericTokens()
String	getAttributeForDistinct()
List<String>	getAttributesForFaceting()
List<String>	getAttributesToHighlight()
List<String>	getAttributesToIndex() Deprecated.
List<String>	getAttributesToRetrieve()
List<String>	getAttributesToSnippet()
List<String>	getCustomRanking()
List<String>	getDisableTypoToleranceOnAttributes()
List<String>	getDisableTypoToleranceOnWords()
Integer	getDistinct()
String	getHighlightPostTag()
String	getHighlightPreTag()
Integer	getHitsPerPage()
Boolean	getIgnorePlurals()
Integer	getMaxValuesPerFacet()
Integer	getMinProximity()
Integer	getMinWordSizefor1Typo()
Integer	getMinWordSizefor2Typos()
List<String>	getNumericAttributesToIndex()
List<String>	getOptionalWords()
String	getQueryType()
List<String>	getRanking()
Boolean	getRemoveStopWords()
String	getRemoveWordsIfNoResults()
Boolean	getReplaceSynonymsInHighlight()
List<String>	getReplicas()
List<String>	getSearchableAttributes()
String	getSeparatorsToIndex()
List<String>	getSlaves()
String	getSnippetEllipsisText()
String	getTypoTolerance()
List<String>	getUnretrievableAttributes()
IndexSettings	setAdvancedSyntax(Boolean advancedSyntax)
IndexSettings	setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray)
IndexSettings	setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)
IndexSettings	setAttributeForDistinct(String attributeForDistinct)
IndexSettings	setAttributesForFaceting(List<String> attributesForFaceting)
IndexSettings	setAttributesToHighlight(List<String> attributesToHighlight)
IndexSettings	setAttributesToIndex(List<String> attributesToIndex) Deprecated.
IndexSettings	setAttributesToRetrieve(List<String> attributesToRetrieve)
IndexSettings	setAttributesToSnippet(List<String> attributesToSnippet)
IndexSettings	setCustomRanking(List<String> customRanking)
IndexSettings	setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)
IndexSettings	setDisableTypoToleranceOnWords(List<String> disableTypoToleranceOnWords)
IndexSettings	setDistinct(Integer distinct)
IndexSettings	setHighlightPostTag(String highlightPostTag)
IndexSettings	setHighlightPreTag(String highlightPreTag)
IndexSettings	setHitsPerPage(Integer hitsPerPage)
IndexSettings	setIgnorePlurals(Boolean ignorePlurals)
IndexSettings	setMaxValuesPerFacet(Integer maxValuesPerFacet)
IndexSettings	setMinProximity(Integer minProximity)
IndexSettings	setMinWordSizefor1Typo(Integer minWordSizefor1Typo)
IndexSettings	setMinWordSizefor2Typos(Integer minWordSizefor2Typos)
IndexSettings	setNumericAttributesToIndex(List<String> numericAttributesToIndex)
IndexSettings	setOptionalWords(List<String> optionalWords)
IndexSettings	setQueryType(String queryType)
IndexSettings	setRanking(List<String> ranking)
IndexSettings	setRemoveStopWords(Boolean removeStopWords)
IndexSettings	setRemoveWordsIfNoResults(String removeWordsIfNoResults)
IndexSettings	setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)
IndexSettings	setReplicas(List<String> replicas)
IndexSettings	setSearchableAttributes(List<String> searchableAttributes)
IndexSettings	setSeparatorsToIndex(String separatorsToIndex)
IndexSettings	setSlaves(List<String> slaves)
IndexSettings	setSnippetEllipsisText(String snippetEllipsisText)
IndexSettings	setTypoTolerance(String typoTolerance)
IndexSettings	setUnretrievableAttributes(List<String> unretrievableAttributes)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexSettings

public IndexSettings()

Method Detail

getAttributesToIndex

@Deprecated
public List<String> getAttributesToIndex()

Deprecated.

Deprecated: Use getSearchableAttributes

getNumericAttributesToIndex

public List<String> getNumericAttributesToIndex()

getAttributesForFaceting

public List<String> getAttributesForFaceting()

getAttributeForDistinct

public String getAttributeForDistinct()

getRanking

public List<String> getRanking()

getCustomRanking

public List<String> getCustomRanking()

getSeparatorsToIndex

public String getSeparatorsToIndex()

getSlaves

public List<String> getSlaves()

getUnretrievableAttributes

public List<String> getUnretrievableAttributes()

getAllowCompressionOfIntegerArray

public Boolean getAllowCompressionOfIntegerArray()

getDisableTypoToleranceOnWords

public List<String> getDisableTypoToleranceOnWords()

getDisableTypoToleranceOnAttributes

public List<String> getDisableTypoToleranceOnAttributes()

getMinWordSizefor1Typo

public Integer getMinWordSizefor1Typo()

getMinWordSizefor2Typos

public Integer getMinWordSizefor2Typos()

getHitsPerPage

public Integer getHitsPerPage()

getAttributesToRetrieve

public List<String> getAttributesToRetrieve()

getAttributesToHighlight

public List<String> getAttributesToHighlight()

getAttributesToSnippet

public List<String> getAttributesToSnippet()

getQueryType

public String getQueryType()

getMinProximity

public Integer getMinProximity()

getHighlightPreTag

public String getHighlightPreTag()

getHighlightPostTag

public String getHighlightPostTag()

getOptionalWords

public List<String> getOptionalWords()

getAllowTyposOnNumericTokens

public Boolean getAllowTyposOnNumericTokens()

getIgnorePlurals

public Boolean getIgnorePlurals()

getAdvancedSyntax

public Boolean getAdvancedSyntax()

getReplaceSynonymsInHighlight

public Boolean getReplaceSynonymsInHighlight()

getMaxValuesPerFacet

public Integer getMaxValuesPerFacet()

getDistinct

public Integer getDistinct()

getTypoTolerance

public String getTypoTolerance()

getRemoveStopWords

public Boolean getRemoveStopWords()

getSnippetEllipsisText

public String getSnippetEllipsisText()

setAttributesToIndex

@Deprecated
public IndexSettings setAttributesToIndex(List<String> attributesToIndex)

Deprecated.

Deprecated: Use setSearchableAttributes

setNumericAttributesToIndex

public IndexSettings setNumericAttributesToIndex(List<String> numericAttributesToIndex)

setAttributesForFaceting

public IndexSettings setAttributesForFaceting(List<String> attributesForFaceting)

setAttributeForDistinct

public IndexSettings setAttributeForDistinct(String attributeForDistinct)

setRanking

public IndexSettings setRanking(List<String> ranking)

setCustomRanking

public IndexSettings setCustomRanking(List<String> customRanking)

setSeparatorsToIndex

public IndexSettings setSeparatorsToIndex(String separatorsToIndex)

setSlaves

public IndexSettings setSlaves(List<String> slaves)

setUnretrievableAttributes

public IndexSettings setUnretrievableAttributes(List<String> unretrievableAttributes)

setAllowCompressionOfIntegerArray

public IndexSettings setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray)

setDisableTypoToleranceOnWords

public IndexSettings setDisableTypoToleranceOnWords(List<String> disableTypoToleranceOnWords)

setDisableTypoToleranceOnAttributes

public IndexSettings setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

setMinWordSizefor1Typo

public IndexSettings setMinWordSizefor1Typo(Integer minWordSizefor1Typo)

setMinWordSizefor2Typos

public IndexSettings setMinWordSizefor2Typos(Integer minWordSizefor2Typos)

setHitsPerPage

public IndexSettings setHitsPerPage(Integer hitsPerPage)

setAttributesToRetrieve

public IndexSettings setAttributesToRetrieve(List<String> attributesToRetrieve)

setAttributesToHighlight

public IndexSettings setAttributesToHighlight(List<String> attributesToHighlight)

setAttributesToSnippet

public IndexSettings setAttributesToSnippet(List<String> attributesToSnippet)

setQueryType

public IndexSettings setQueryType(String queryType)

setMinProximity

public IndexSettings setMinProximity(Integer minProximity)

setHighlightPreTag

public IndexSettings setHighlightPreTag(String highlightPreTag)

setHighlightPostTag

public IndexSettings setHighlightPostTag(String highlightPostTag)

setOptionalWords

public IndexSettings setOptionalWords(List<String> optionalWords)

setAllowTyposOnNumericTokens

public IndexSettings setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

setIgnorePlurals

public IndexSettings setIgnorePlurals(Boolean ignorePlurals)

setAdvancedSyntax

public IndexSettings setAdvancedSyntax(Boolean advancedSyntax)

setReplaceSynonymsInHighlight

public IndexSettings setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

setMaxValuesPerFacet

public IndexSettings setMaxValuesPerFacet(Integer maxValuesPerFacet)

setDistinct

public IndexSettings setDistinct(Integer distinct)

setTypoTolerance

public IndexSettings setTypoTolerance(String typoTolerance)

setRemoveStopWords

public IndexSettings setRemoveStopWords(Boolean removeStopWords)

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)

getSearchableAttributes

public List<String> getSearchableAttributes()

setSearchableAttributes

public IndexSettings setSearchableAttributes(List<String> searchableAttributes)