IndexSettings (algoliasearch-common 2.15.2 API)

java.lang.Object
- com.algolia.search.objects.IndexSettings

public class IndexSettings
extends Object

Constructor Summary

Constructors
Constructor Description

IndexSettings()

Constructors
Constructor	Description
`IndexSettings()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Boolean`	`getAdvancedSyntax()`
`Boolean`	`getAllowCompressionOfIntegerArray()`
`Boolean`	`getAllowTyposOnNumericTokens()`
`List<String>`	`getAlternativesAsExact()`
`String`	`getAttributeForDistinct()`
`List<String>`	`getAttributesForFaceting()`
`List<String>`	`getAttributesToHighlight()`
`List<String>`	`getAttributesToIndex()`	Deprecated.
`List<String>`	`getAttributesToRetrieve()`
`List<String>`	`getAttributesToSnippet()`
`List<String>`	`getCustomRanking()`
`Map<String,Object>`	`getCustomSettings()`
`List<String>`	`getDisableExactOnAttributes()`
`List<String>`	`getDisablePrefixOnAttributes()`
`List<String>`	`getDisableTypoToleranceOnAttributes()`
`List<String>`	`getDisableTypoToleranceOnWords()`
`Distinct`	`getDistinct()`
`Boolean`	`getEnableRules()`
`String`	`getExactOnSingleWordQuery()`
`String`	`getHighlightPostTag()`
`String`	`getHighlightPreTag()`
`Long`	`getHitsPerPage()`
`IgnorePlurals`	`getIgnorePlurals()`
`Integer`	`getMaxFacetHits()`
`Long`	`getMaxValuesPerFacet()`
`Integer`	`getMinProximity()`
`Integer`	`getMinWordSizefor1Typo()`
`Integer`	`getMinWordSizefor2Typos()`
`List<String>`	`getNumericAttributesForFiltering()`
`List<String>`	`getNumericAttributesToIndex()`	Deprecated.
`List<String>`	`getOptionalWords()`
`Long`	`getPaginationLimitedTo()`
`Map<String,List<String>>`	`getPlaceholders()`
`String`	`getQueryType()`
`List<String>`	`getRanking()`
`RemoveStopWords`	`getRemoveStopWords()`
`String`	`getRemoveWordsIfNoResults()`
`Boolean`	`getReplaceSynonymsInHighlight()`
`List<String>`	`getReplicas()`
`List<String>`	`getResponseFields()`
`Boolean`	`getRestrictHighlightAndSnippetArrays()`
`List<String>`	`getSearchableAttributes()`
`String`	`getSeparatorsToIndex()`
`List<String>`	`getSlaves()`	Deprecated.
`String`	`getSnippetEllipsisText()`
`String`	`getSortFacetValuesBy()`
`TypoTolerance`	`getTypoTolerance()`
`List<String>`	`getUnretrievableAttributes()`
`IndexSettings`	`setAdvancedSyntax(Boolean advancedSyntax)`
`IndexSettings`	`setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray)`
`IndexSettings`	`setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)`
`IndexSettings`	`setAlternativesAsExact(List<String> alternativesAsExact)`
`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`	`setCustomSetting(String key, Object value)`
`IndexSettings`	`setCustomSettings(Map<String,Object> customSettings)`
`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`	`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`	`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)`	Deprecated.
`IndexSettings`	`setOptionalWords(List<String> optionalWords)`
`IndexSettings`	`setPaginationLimitedTo(Integer paginationLimitedTo)`
`IndexSettings`	`setPaginationLimitedTo(Long paginationLimitedTo)`
`IndexSettings`	`setPlaceholders(Map<String,List<String>> placeholders)`
`IndexSettings`	`setQueryType(String queryType)`
`IndexSettings`	`setRanking(List<String> ranking)`
`IndexSettings`	`setRemoveStopWords(RemoveStopWords removeStopWords)`
`IndexSettings`	`setRemoveStopWords(Boolean removeStopWords)`
`IndexSettings`	`setRemoveStopWords(List<String> removeStopWords)`
`IndexSettings`	`setRemoveWordsIfNoResults(String removeWordsIfNoResults)`
`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)`	Deprecated.
`IndexSettings`	`setSnippetEllipsisText(String snippetEllipsisText)`
`IndexSettings`	`setSortFacetValuesBy(String sortFacetValuesBy)`
`IndexSettings`	`setTypoTolerance(TypoTolerance typoTolerance)`
`IndexSettings`	`setUnretrievableAttributes(List<String> unretrievableAttributes)`
`IndexSettings`	`setVersion(Integer version)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- IndexSettings
```
public IndexSettings()
```

Method Detail

getAttributesToIndex
```
@Deprecated
public List<String> getAttributesToIndex()
```
Deprecated.

Deprecated: Use getSearchableAttributes

setAttributesToIndex

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

Deprecated.

Deprecated: Use setSearchableAttributes

getNumericAttributesToIndex
```
@Deprecated
public List<String> getNumericAttributesToIndex()
```
Deprecated.

Deprecated: Use getNumericAttributesForFiltering

setNumericAttributesToIndex

@Deprecated
public IndexSettings setNumericAttributesToIndex(List<String> numericAttributesToIndex)

Deprecated.

Deprecated: Use setNumericAttributesForFiltering

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)

getSlaves

@Deprecated
public List<String> getSlaves()

Deprecated.

setSlaves

@Deprecated
public IndexSettings setSlaves(List<String> slaves)

Deprecated.

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(Long hitsPerPage)

setHitsPerPage

public IndexSettings setHitsPerPage(Integer hitsPerPage)

getAttributesToRetrieve

public List<String> getAttributesToRetrieve()

setAttributesToRetrieve

public IndexSettings setAttributesToRetrieve(List<String> attributesToRetrieve)

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)

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(IgnorePlurals ignorePlurals)

setIgnorePlurals

public IndexSettings setIgnorePlurals(Boolean ignorePlurals)

setIgnorePlurals

public IndexSettings setIgnorePlurals(List<String> ignorePlurals)

getAdvancedSyntax
```
public Boolean getAdvancedSyntax()
```

setAdvancedSyntax

public IndexSettings setAdvancedSyntax(Boolean advancedSyntax)

getReplaceSynonymsInHighlight

public Boolean getReplaceSynonymsInHighlight()

setReplaceSynonymsInHighlight

public IndexSettings setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

getMaxValuesPerFacet
```
public Long getMaxValuesPerFacet()
```

setMaxValuesPerFacet

public IndexSettings setMaxValuesPerFacet(Long maxValuesPerFacet)

setMaxValuesPerFacet

public IndexSettings setMaxValuesPerFacet(Integer maxValuesPerFacet)

getDistinct
```
public Distinct getDistinct()
```

setDistinct

public IndexSettings setDistinct(Distinct distinct)

setDistinct

public IndexSettings setDistinct(Integer distinct)

setDistinct

public IndexSettings setDistinct(Boolean distinct)

getTypoTolerance

public TypoTolerance getTypoTolerance()

setTypoTolerance

public IndexSettings setTypoTolerance(TypoTolerance typoTolerance)

getRemoveStopWords

public RemoveStopWords getRemoveStopWords()

setRemoveStopWords

public IndexSettings setRemoveStopWords(RemoveStopWords removeStopWords)

setRemoveStopWords

public IndexSettings setRemoveStopWords(Boolean removeStopWords)

setRemoveStopWords

public IndexSettings setRemoveStopWords(List<String> 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)

getSearchableAttributes

public List<String> getSearchableAttributes()

setSearchableAttributes

public IndexSettings setSearchableAttributes(List<String> searchableAttributes)

getPlaceholders

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

setPlaceholders

public IndexSettings setPlaceholders(Map<String,List<String>> placeholders)

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(Long paginationLimitedTo)

setPaginationLimitedTo

public IndexSettings setPaginationLimitedTo(Integer paginationLimitedTo)

getNumericAttributesForFiltering

public List<String> getNumericAttributesForFiltering()

setNumericAttributesForFiltering

public IndexSettings setNumericAttributesForFiltering(List<String> numericAttributesForFiltering)

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)

setCustomSetting

public IndexSettings setCustomSetting(String key,
                                      Object value)

getCustomSettings

public Map<String,Object> getCustomSettings()

setCustomSettings

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

setVersion

public IndexSettings setVersion(Integer version)

toString
```
public String toString()
```
Overrides:

toString in class Object

Class IndexSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IndexSettings

Method Detail

getAttributesToIndex

setAttributesToIndex

getNumericAttributesToIndex

setNumericAttributesToIndex

getAttributesForFaceting

setAttributesForFaceting

getAttributeForDistinct

setAttributeForDistinct

getRanking

setRanking

getCustomRanking

setCustomRanking

getSeparatorsToIndex

setSeparatorsToIndex

getSlaves

setSlaves

getUnretrievableAttributes

setUnretrievableAttributes

getAllowCompressionOfIntegerArray

setAllowCompressionOfIntegerArray

getDisableTypoToleranceOnWords

setDisableTypoToleranceOnWords

getDisableTypoToleranceOnAttributes

setDisableTypoToleranceOnAttributes

getMinWordSizefor1Typo

setMinWordSizefor1Typo

getMinWordSizefor2Typos

setMinWordSizefor2Typos

getHitsPerPage

setHitsPerPage

setHitsPerPage

getAttributesToRetrieve

setAttributesToRetrieve

getAttributesToHighlight

setAttributesToHighlight

getAttributesToSnippet

setAttributesToSnippet

getQueryType

setQueryType

getMinProximity

setMinProximity

getHighlightPreTag

setHighlightPreTag

getHighlightPostTag

setHighlightPostTag

getOptionalWords

setOptionalWords

getAllowTyposOnNumericTokens

setAllowTyposOnNumericTokens

getIgnorePlurals

setIgnorePlurals

setIgnorePlurals

setIgnorePlurals

getAdvancedSyntax

setAdvancedSyntax

getReplaceSynonymsInHighlight

setReplaceSynonymsInHighlight

getMaxValuesPerFacet

setMaxValuesPerFacet

setMaxValuesPerFacet

getDistinct

setDistinct

setDistinct

setDistinct

getTypoTolerance

setTypoTolerance

getRemoveStopWords

setRemoveStopWords

setRemoveStopWords

setRemoveStopWords

getSnippetEllipsisText

setSnippetEllipsisText

getRemoveWordsIfNoResults