Class

algolia.objects

IndexSettings

Related Doc: package objects

Permalink

case class IndexSettings(attributeForDistinct: Option[String] = None, distinct: Option[Distinct] = None, replaceSynonymsInHighlight: Option[Boolean] = None, placeholders: Option[Map[String, Seq[String]]] = None, minProximity: Option[Int] = None, keepDiacriticsOnCharacters: Option[String] = None, queryLanguages: Option[Seq[String]] = None, indexLanguages: Option[Seq[String]] = None, attributeCriteriaComputedByMinProximity: Option[Boolean] = None, primary: Option[String] = None, userData: Option[Any] = None, customNormalization: Option[Map[String, Map[String, String]]] = None, attributesToIndex: Option[Seq[AttributesToIndex]] = None, searchableAttributes: Option[Seq[SearchableAttributes]] = None, attributesForFaceting: Option[Seq[String]] = None, unretrievableAttributes: Option[Seq[String]] = None, attributesToRetrieve: Option[Seq[String]] = None, camelCaseAttributes: Option[Seq[String]] = None, decompoundedAttributes: Option[Map[String, Seq[String]]] = None, maxValuesPerFacet: Option[Int] = None, sortFacetValuesBy: Option[String] = None, attributesToHighlight: Option[Seq[String]] = None, attributesToSnippet: Option[Seq[String]] = None, highlightPreTag: Option[String] = None, highlightPostTag: Option[String] = None, snippetEllipsisText: Option[String] = None, restrictHighlightAndSnippetArrays: Option[Boolean] = None, hitsPerPage: Option[Int] = None, paginationLimitedTo: Option[Int] = None, numericAttributesForFiltering: Option[Seq[String]] = None, numericAttributesToIndex: Option[Seq[NumericAttributesToIndex]] = None, allowCompressionOfIntegerArray: Option[Boolean] = None, enableRules: Option[Boolean] = None, queryType: Option[QueryType] = None, removeWordsIfNoResults: Option[String] = None, advancedSyntax: Option[Boolean] = None, advancedSyntaxFeatures: Option[Seq[String]] = None, optionalWords: Option[Seq[String]] = None, removeStopWords: Option[RemoveStopWords] = None, disablePrefixOnAttributes: Option[Seq[String]] = None, disableExactOnAttributes: Option[Seq[String]] = None, exactOnSingleWordQuery: Option[Seq[String]] = None, alternativesAsExact: Option[Seq[String]] = None, ranking: Option[Seq[Ranking]] = None, customRanking: Option[Seq[CustomRanking]] = None, slaves: Option[Seq[String]] = None, replicas: Option[Seq[String]] = None, minWordSizefor1Typo: Option[Int] = None, minWordSizefor2Typos: Option[Int] = None, typoTolerance: Option[TypoTolerance] = None, allowTyposOnNumericTokens: Option[Boolean] = None, ignorePlurals: Option[IgnorePlurals] = None, disableTypoToleranceOnAttributes: Option[Seq[String]] = None, disableTypoToleranceOnWords: Option[Seq[String]] = None, separatorsToIndex: Option[String] = None) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IndexSettings
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IndexSettings(attributeForDistinct: Option[String] = None, distinct: Option[Distinct] = None, replaceSynonymsInHighlight: Option[Boolean] = None, placeholders: Option[Map[String, Seq[String]]] = None, minProximity: Option[Int] = None, keepDiacriticsOnCharacters: Option[String] = None, queryLanguages: Option[Seq[String]] = None, indexLanguages: Option[Seq[String]] = None, attributeCriteriaComputedByMinProximity: Option[Boolean] = None, primary: Option[String] = None, userData: Option[Any] = None, customNormalization: Option[Map[String, Map[String, String]]] = None, attributesToIndex: Option[Seq[AttributesToIndex]] = None, searchableAttributes: Option[Seq[SearchableAttributes]] = None, attributesForFaceting: Option[Seq[String]] = None, unretrievableAttributes: Option[Seq[String]] = None, attributesToRetrieve: Option[Seq[String]] = None, camelCaseAttributes: Option[Seq[String]] = None, decompoundedAttributes: Option[Map[String, Seq[String]]] = None, maxValuesPerFacet: Option[Int] = None, sortFacetValuesBy: Option[String] = None, attributesToHighlight: Option[Seq[String]] = None, attributesToSnippet: Option[Seq[String]] = None, highlightPreTag: Option[String] = None, highlightPostTag: Option[String] = None, snippetEllipsisText: Option[String] = None, restrictHighlightAndSnippetArrays: Option[Boolean] = None, hitsPerPage: Option[Int] = None, paginationLimitedTo: Option[Int] = None, numericAttributesForFiltering: Option[Seq[String]] = None, numericAttributesToIndex: Option[Seq[NumericAttributesToIndex]] = None, allowCompressionOfIntegerArray: Option[Boolean] = None, enableRules: Option[Boolean] = None, queryType: Option[QueryType] = None, removeWordsIfNoResults: Option[String] = None, advancedSyntax: Option[Boolean] = None, advancedSyntaxFeatures: Option[Seq[String]] = None, optionalWords: Option[Seq[String]] = None, removeStopWords: Option[RemoveStopWords] = None, disablePrefixOnAttributes: Option[Seq[String]] = None, disableExactOnAttributes: Option[Seq[String]] = None, exactOnSingleWordQuery: Option[Seq[String]] = None, alternativesAsExact: Option[Seq[String]] = None, ranking: Option[Seq[Ranking]] = None, customRanking: Option[Seq[CustomRanking]] = None, slaves: Option[Seq[String]] = None, replicas: Option[Seq[String]] = None, minWordSizefor1Typo: Option[Int] = None, minWordSizefor2Typos: Option[Int] = None, typoTolerance: Option[TypoTolerance] = None, allowTyposOnNumericTokens: Option[Boolean] = None, ignorePlurals: Option[IgnorePlurals] = None, disableTypoToleranceOnAttributes: Option[Seq[String]] = None, disableTypoToleranceOnWords: Option[Seq[String]] = None, separatorsToIndex: Option[String] = None)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val advancedSyntax: Option[Boolean]

    Permalink
  5. val advancedSyntaxFeatures: Option[Seq[String]]

    Permalink
  6. val allowCompressionOfIntegerArray: Option[Boolean]

    Permalink
  7. val allowTyposOnNumericTokens: Option[Boolean]

    Permalink
  8. val alternativesAsExact: Option[Seq[String]]

    Permalink
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. val attributeCriteriaComputedByMinProximity: Option[Boolean]

    Permalink
  11. val attributeForDistinct: Option[String]

    Permalink
  12. val attributesForFaceting: Option[Seq[String]]

    Permalink
  13. val attributesToHighlight: Option[Seq[String]]

    Permalink
  14. val attributesToIndex: Option[Seq[AttributesToIndex]]

    Permalink
  15. val attributesToRetrieve: Option[Seq[String]]

    Permalink
  16. val attributesToSnippet: Option[Seq[String]]

    Permalink
  17. val camelCaseAttributes: Option[Seq[String]]

    Permalink
  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  19. val customNormalization: Option[Map[String, Map[String, String]]]

    Permalink
  20. val customRanking: Option[Seq[CustomRanking]]

    Permalink
  21. val decompoundedAttributes: Option[Map[String, Seq[String]]]

    Permalink
  22. val disableExactOnAttributes: Option[Seq[String]]

    Permalink
  23. val disablePrefixOnAttributes: Option[Seq[String]]

    Permalink
  24. val disableTypoToleranceOnAttributes: Option[Seq[String]]

    Permalink
  25. val disableTypoToleranceOnWords: Option[Seq[String]]

    Permalink
  26. val distinct: Option[Distinct]

    Permalink
  27. val enableRules: Option[Boolean]

    Permalink
  28. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. val exactOnSingleWordQuery: Option[Seq[String]]

    Permalink
  30. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  31. val highlightPostTag: Option[String]

    Permalink
  32. val highlightPreTag: Option[String]

    Permalink
  33. val hitsPerPage: Option[Int]

    Permalink
  34. val ignorePlurals: Option[IgnorePlurals]

    Permalink
  35. val indexLanguages: Option[Seq[String]]

    Permalink
  36. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  37. val keepDiacriticsOnCharacters: Option[String]

    Permalink
  38. val maxValuesPerFacet: Option[Int]

    Permalink
  39. val minProximity: Option[Int]

    Permalink
  40. val minWordSizefor1Typo: Option[Int]

    Permalink
  41. val minWordSizefor2Typos: Option[Int]

    Permalink
  42. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  43. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  44. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  45. val numericAttributesForFiltering: Option[Seq[String]]

    Permalink
  46. val numericAttributesToIndex: Option[Seq[NumericAttributesToIndex]]

    Permalink
  47. val optionalWords: Option[Seq[String]]

    Permalink
  48. val paginationLimitedTo: Option[Int]

    Permalink
  49. val placeholders: Option[Map[String, Seq[String]]]

    Permalink
  50. val primary: Option[String]

    Permalink
  51. val queryLanguages: Option[Seq[String]]

    Permalink
  52. val queryType: Option[QueryType]

    Permalink
  53. val ranking: Option[Seq[Ranking]]

    Permalink
  54. val removeStopWords: Option[RemoveStopWords]

    Permalink
  55. val removeWordsIfNoResults: Option[String]

    Permalink
  56. val replaceSynonymsInHighlight: Option[Boolean]

    Permalink
  57. val replicas: Option[Seq[String]]

    Permalink
  58. val restrictHighlightAndSnippetArrays: Option[Boolean]

    Permalink
  59. val searchableAttributes: Option[Seq[SearchableAttributes]]

    Permalink
  60. val separatorsToIndex: Option[String]

    Permalink
  61. val slaves: Option[Seq[String]]

    Permalink
  62. val snippetEllipsisText: Option[String]

    Permalink
  63. val sortFacetValuesBy: Option[String]

    Permalink
  64. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  65. val typoTolerance: Option[TypoTolerance]

    Permalink
  66. val unretrievableAttributes: Option[Seq[String]]

    Permalink
  67. val userData: Option[Any]

    Permalink
  68. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped