c

algolia.objects

IndexSettings

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, enablePersonalization: Option[Boolean] = None, attributesToTransliterate: Option[Seq[String]] = None, decompoundQuery: Option[Boolean] = 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, 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, renderingContent: Option[RenderingContent] = None, relevancyStrictness: Option[Int] = 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, enablePersonalization: Option[Boolean] = None, attributesToTransliterate: Option[Seq[String]] = None, decompoundQuery: Option[Boolean] = 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, 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, renderingContent: Option[RenderingContent] = None, relevancyStrictness: Option[Int] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val advancedSyntax: Option[Boolean]
  5. val advancedSyntaxFeatures: Option[Seq[String]]
  6. val allowCompressionOfIntegerArray: Option[Boolean]
  7. val allowTyposOnNumericTokens: Option[Boolean]
  8. val alternativesAsExact: Option[Seq[String]]
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val attributeCriteriaComputedByMinProximity: Option[Boolean]
  11. val attributeForDistinct: Option[String]
  12. val attributesForFaceting: Option[Seq[String]]
  13. val attributesToHighlight: Option[Seq[String]]
  14. val attributesToIndex: Option[Seq[AttributesToIndex]]
  15. val attributesToRetrieve: Option[Seq[String]]
  16. val attributesToSnippet: Option[Seq[String]]
  17. val attributesToTransliterate: Option[Seq[String]]
  18. val camelCaseAttributes: Option[Seq[String]]
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  20. val customNormalization: Option[Map[String, Map[String, String]]]
  21. val customRanking: Option[Seq[CustomRanking]]
  22. val decompoundQuery: Option[Boolean]
  23. val decompoundedAttributes: Option[Map[String, Seq[String]]]
  24. val disableExactOnAttributes: Option[Seq[String]]
  25. val disablePrefixOnAttributes: Option[Seq[String]]
  26. val disableTypoToleranceOnAttributes: Option[Seq[String]]
  27. val disableTypoToleranceOnWords: Option[Seq[String]]
  28. val distinct: Option[Distinct]
  29. val enablePersonalization: Option[Boolean]
  30. val enableRules: Option[Boolean]
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. val exactOnSingleWordQuery: Option[Seq[String]]
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. val highlightPostTag: Option[String]
  35. val highlightPreTag: Option[String]
  36. val hitsPerPage: Option[Int]
  37. val ignorePlurals: Option[IgnorePlurals]
  38. val indexLanguages: Option[Seq[String]]
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. val keepDiacriticsOnCharacters: Option[String]
  41. val maxValuesPerFacet: Option[Int]
  42. val minProximity: Option[Int]
  43. val minWordSizefor1Typo: Option[Int]
  44. val minWordSizefor2Typos: Option[Int]
  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. val numericAttributesForFiltering: Option[Seq[String]]
  49. val optionalWords: Option[Seq[String]]
  50. val paginationLimitedTo: Option[Int]
  51. val placeholders: Option[Map[String, Seq[String]]]
  52. val primary: Option[String]
  53. val queryLanguages: Option[Seq[String]]
  54. val queryType: Option[QueryType]
  55. val ranking: Option[Seq[Ranking]]
  56. val relevancyStrictness: Option[Int]
  57. val removeStopWords: Option[RemoveStopWords]
  58. val removeWordsIfNoResults: Option[String]
  59. val renderingContent: Option[RenderingContent]
  60. val replaceSynonymsInHighlight: Option[Boolean]
  61. val replicas: Option[Seq[String]]
  62. val restrictHighlightAndSnippetArrays: Option[Boolean]
  63. val searchableAttributes: Option[Seq[SearchableAttributes]]
  64. val separatorsToIndex: Option[String]
  65. val slaves: Option[Seq[String]]
  66. val snippetEllipsisText: Option[String]
  67. val sortFacetValuesBy: Option[String]
  68. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  69. val typoTolerance: Option[TypoTolerance]
  70. val unretrievableAttributes: Option[Seq[String]]
  71. val userData: Option[Any]
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    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