Package com.algolia.model.search

Class BaseIndexSettings

java.lang.Object
com.algolia.model.search.BaseIndexSettings
public class BaseIndexSettings extends Object
BaseIndexSettings

  • Constructor Details

    • BaseIndexSettings

      public BaseIndexSettings()

  • Method Details

    • setReplicas

      public BaseIndexSettings setReplicas(List<String> replicas)

    • addReplicas

      public BaseIndexSettings addReplicas(String replicasItem)

    • getReplicas

      @Nullable public List<String> getReplicas()
      Creates [replicas](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/), which are copies of a primary index with the same records but different settings.
      Returns:
      replicas

    • setPaginationLimitedTo

      public BaseIndexSettings setPaginationLimitedTo(Integer paginationLimitedTo)

    • getPaginationLimitedTo

      @Nullable public Integer getPaginationLimitedTo()
      Maximum number of hits accessible through pagination.
      Returns:
      paginationLimitedTo

    • setUnretrievableAttributes

      public BaseIndexSettings setUnretrievableAttributes(List<String> unretrievableAttributes)

    • addUnretrievableAttributes

      public BaseIndexSettings addUnretrievableAttributes(String unretrievableAttributesItem)

    • getUnretrievableAttributes

      @Nullable public List<String> getUnretrievableAttributes()
      Attributes that can't be retrieved at query time.
      Returns:
      unretrievableAttributes

    • setDisableTypoToleranceOnWords

      public BaseIndexSettings setDisableTypoToleranceOnWords(List<String> disableTypoToleranceOnWords)

    • addDisableTypoToleranceOnWords

      public BaseIndexSettings addDisableTypoToleranceOnWords(String disableTypoToleranceOnWordsItem)

    • getDisableTypoToleranceOnWords

      @Nullable public List<String> getDisableTypoToleranceOnWords()
      Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
      Returns:
      disableTypoToleranceOnWords

    • setAttributesToTransliterate

      public BaseIndexSettings setAttributesToTransliterate(List<String> attributesToTransliterate)

    • addAttributesToTransliterate

      public BaseIndexSettings addAttributesToTransliterate(String attributesToTransliterateItem)

    • getAttributesToTransliterate

      @Nullable public List<String> getAttributesToTransliterate()
      Attributes in your index to which [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead) applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.
      Returns:
      attributesToTransliterate

    • setCamelCaseAttributes

      public BaseIndexSettings setCamelCaseAttributes(List<String> camelCaseAttributes)

    • addCamelCaseAttributes

      public BaseIndexSettings addCamelCaseAttributes(String camelCaseAttributesItem)

    • getCamelCaseAttributes

      @Nullable public List<String> getCamelCaseAttributes()
      Attributes on which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
      Returns:
      camelCaseAttributes

    • setDecompoundedAttributes

      public BaseIndexSettings setDecompoundedAttributes(Object decompoundedAttributes)

    • getDecompoundedAttributes

      @Nullable public Object getDecompoundedAttributes()
      Attributes in your index to which [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding) applies.
      Returns:
      decompoundedAttributes

    • setIndexLanguages

      public BaseIndexSettings setIndexLanguages(List<String> indexLanguages)

    • addIndexLanguages

      public BaseIndexSettings addIndexLanguages(String indexLanguagesItem)

    • getIndexLanguages

      @Nullable public List<String> getIndexLanguages()
      Set the languages of your index, for language-specific processing steps such as [tokenization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/tokenization/) and [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
      Returns:
      indexLanguages

    • setDisablePrefixOnAttributes

      public BaseIndexSettings setDisablePrefixOnAttributes(List<String> disablePrefixOnAttributes)

    • addDisablePrefixOnAttributes

      public BaseIndexSettings addDisablePrefixOnAttributes(String disablePrefixOnAttributesItem)

    • getDisablePrefixOnAttributes

      @Nullable public List<String> getDisablePrefixOnAttributes()
      Attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
      Returns:
      disablePrefixOnAttributes

    • setAllowCompressionOfIntegerArray

      public BaseIndexSettings setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray)

    • getAllowCompressionOfIntegerArray

      @Nullable public Boolean getAllowCompressionOfIntegerArray()
      Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.
      Returns:
      allowCompressionOfIntegerArray

    • setNumericAttributesForFiltering

      public BaseIndexSettings setNumericAttributesForFiltering(List<String> numericAttributesForFiltering)

    • addNumericAttributesForFiltering

      public BaseIndexSettings addNumericAttributesForFiltering(String numericAttributesForFilteringItem)

    • getNumericAttributesForFiltering

      @Nullable public List<String> getNumericAttributesForFiltering()
      Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
      Returns:
      numericAttributesForFiltering

    • setSeparatorsToIndex

      public BaseIndexSettings setSeparatorsToIndex(String separatorsToIndex)

    • getSeparatorsToIndex

      @Nullable public String getSeparatorsToIndex()
      Controls which separators are added to an Algolia index as part of [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean). Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
      Returns:
      separatorsToIndex

    • setSearchableAttributes

      public BaseIndexSettings setSearchableAttributes(List<String> searchableAttributes)

    • addSearchableAttributes

      public BaseIndexSettings addSearchableAttributes(String searchableAttributesItem)

    • getSearchableAttributes

      @Nullable public List<String> getSearchableAttributes()
      [Attributes used for searching](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/), including determining [if matches at the beginning of a word are important (ordered) or not (unordered)](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/how-to/configuring-searchable-attributes-the-right-way/#understanding-word-position).
      Returns:
      searchableAttributes

    • setUserData

      public BaseIndexSettings setUserData(Object userData)

    • getUserData

      @Nullable public Object getUserData()
      Lets you store custom data in your indices.
      Returns:
      userData

    • setCustomNormalization

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

    • putCustomNormalization

      public BaseIndexSettings putCustomNormalization(String key, Map<String,String> customNormalizationItem)

    • getCustomNormalization

      @Nullable public Map<String,Map<String,String>> getCustomNormalization()
      A list of characters and their normalized replacements to override Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
      Returns:
      customNormalization

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object