IndexSettings

Instance Constructors

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

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
val advancedSyntax: Option[Boolean]
val advancedSyntaxFeatures: Option[Seq[String]]
val allowCompressionOfIntegerArray: Option[Boolean]
val allowTyposOnNumericTokens: Option[Boolean]
val alternativesAsExact: Option[Seq[String]]
final def asInstanceOf[T0]: T0

Definition Classes
Any
val attributeCriteriaComputedByMinProximity: Option[Boolean]
val attributeForDistinct: Option[String]
val attributesForFaceting: Option[Seq[String]]
val attributesToHighlight: Option[Seq[String]]
val attributesToIndex: Option[Seq[AttributesToIndex]]
val attributesToRetrieve: Option[Seq[String]]
val attributesToSnippet: Option[Seq[String]]
val attributesToTransliterate: Option[Seq[String]]
val camelCaseAttributes: Option[Seq[String]]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
val customNormalization: Option[Map[String, Map[String, String]]]
val customRanking: Option[Seq[CustomRanking]]
val decompoundQuery: Option[Boolean]
val decompoundedAttributes: Option[Map[String, Seq[String]]]
val disableExactOnAttributes: Option[Seq[String]]
val disablePrefixOnAttributes: Option[Seq[String]]
val disableTypoToleranceOnAttributes: Option[Seq[String]]
val disableTypoToleranceOnWords: Option[Seq[String]]
val distinct: Option[Distinct]
val enablePersonalization: Option[Boolean]
val enableRules: Option[Boolean]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val exactOnSingleWordQuery: Option[Seq[String]]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
val highlightPostTag: Option[String]
val highlightPreTag: Option[String]
val hitsPerPage: Option[Int]
val ignorePlurals: Option[IgnorePlurals]
val indexLanguages: Option[Seq[String]]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val keepDiacriticsOnCharacters: Option[String]
val maxValuesPerFacet: Option[Int]
val minProximity: Option[Int]
val minWordSizefor1Typo: Option[Int]
val minWordSizefor2Typos: Option[Int]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
val numericAttributesForFiltering: Option[Seq[String]]
val optionalWords: Option[Seq[String]]
val paginationLimitedTo: Option[Int]
val placeholders: Option[Map[String, Seq[String]]]
val primary: Option[String]
val queryLanguages: Option[Seq[String]]
val queryType: Option[QueryType]
val ranking: Option[Seq[Ranking]]
val relevancyStrictness: Option[Int]
val removeStopWords: Option[RemoveStopWords]
val removeWordsIfNoResults: Option[String]
val renderingContent: Option[RenderingContent]
val replaceSynonymsInHighlight: Option[Boolean]
val replicas: Option[Seq[String]]
val restrictHighlightAndSnippetArrays: Option[Boolean]
val searchableAttributes: Option[Seq[SearchableAttributes]]
val separatorsToIndex: Option[String]
val slaves: Option[Seq[String]]
val snippetEllipsisText: Option[String]
val sortFacetValuesBy: Option[String]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val typoTolerance: Option[TypoTolerance]
val unretrievableAttributes: Option[Seq[String]]
val userData: Option[Any]
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package objects

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val advancedSyntax: Option[Boolean]

val advancedSyntaxFeatures: Option[Seq[String]]

val allowCompressionOfIntegerArray: Option[Boolean]

val allowTyposOnNumericTokens: Option[Boolean]

val alternativesAsExact: Option[Seq[String]]

final def asInstanceOf[T0]: T0

val attributeCriteriaComputedByMinProximity: Option[Boolean]

val attributeForDistinct: Option[String]

val attributesForFaceting: Option[Seq[String]]

val attributesToHighlight: Option[Seq[String]]

val attributesToIndex: Option[Seq[AttributesToIndex]]

val attributesToRetrieve: Option[Seq[String]]

val attributesToSnippet: Option[Seq[String]]

val attributesToTransliterate: Option[Seq[String]]

val camelCaseAttributes: Option[Seq[String]]

def clone(): AnyRef

val customNormalization: Option[Map[String, Map[String, String]]]

val customRanking: Option[Seq[CustomRanking]]

val decompoundQuery: Option[Boolean]

val decompoundedAttributes: Option[Map[String, Seq[String]]]

val disableExactOnAttributes: Option[Seq[String]]

val disablePrefixOnAttributes: Option[Seq[String]]

val disableTypoToleranceOnAttributes: Option[Seq[String]]

val disableTypoToleranceOnWords: Option[Seq[String]]

val distinct: Option[Distinct]

val enablePersonalization: Option[Boolean]

val enableRules: Option[Boolean]

final def eq(arg0: AnyRef): Boolean

val exactOnSingleWordQuery: Option[Seq[String]]

final def getClass(): Class[_]

val highlightPostTag: Option[String]

val highlightPreTag: Option[String]

val hitsPerPage: Option[Int]

val ignorePlurals: Option[IgnorePlurals]

val indexLanguages: Option[Seq[String]]

final def isInstanceOf[T0]: Boolean

val keepDiacriticsOnCharacters: Option[String]

val maxValuesPerFacet: Option[Int]

val minProximity: Option[Int]

val minWordSizefor1Typo: Option[Int]

val minWordSizefor2Typos: Option[Int]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numericAttributesForFiltering: Option[Seq[String]]

val optionalWords: Option[Seq[String]]

val paginationLimitedTo: Option[Int]

val placeholders: Option[Map[String, Seq[String]]]

val primary: Option[String]

val queryLanguages: Option[Seq[String]]

val queryType: Option[QueryType]

val ranking: Option[Seq[Ranking]]

val relevancyStrictness: Option[Int]

val removeStopWords: Option[RemoveStopWords]

val removeWordsIfNoResults: Option[String]

val renderingContent: Option[RenderingContent]

val replaceSynonymsInHighlight: Option[Boolean]

val replicas: Option[Seq[String]]

val restrictHighlightAndSnippetArrays: Option[Boolean]

val searchableAttributes: Option[Seq[SearchableAttributes]]

val separatorsToIndex: Option[String]

val slaves: Option[Seq[String]]

val snippetEllipsisText: Option[String]

val sortFacetValuesBy: Option[String]

final def synchronized[T0](arg0: ⇒ T0): T0

val typoTolerance: Option[TypoTolerance]

val unretrievableAttributes: Option[Seq[String]]

val userData: Option[Any]

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit