objects

Type Members

1. sealed trait AbstractSynonym extends AnyRef

   

2. sealed trait Acl extends AnyRef

   

3. case class ApiKey(validity: Option[Int] = None, maxQueriesPerIPPerHour: Option[Int] = None, maxHitsPerQuery: Option[Int] = None, acl: Option[Seq[Acl]] = None, indexes: Option[Seq[String]] = None, referers: Option[Seq[String]] = None, queryParameters: Option[String] = None, description: Option[String] = None, restrictSources: Option[String] = None) extends Product with Serializable

   

4. case class AroundLatLng(lat: String, lng: String) extends Product with Serializable

   

5. sealed trait AroundRadius extends AnyRef

   

6. sealed trait AttributesToIndex extends AnyRef

   

   Use SearchableAttributes

   Use SearchableAttributes

   Annotations

   @Deprecated

7. case class AutomaticFacetFilters(facet: String, disjunctive: Option[Boolean] = None, score: Option[Int] = None) extends Product with Serializable

   

8. case class Condition(pattern: String, anchoring: String, context: Option[String] = None) extends Product with Serializable

   

9. case class Consequence(params: Option[Map[String, Any]] = None, promote: Option[Iterable[ConsequencePromote]] = None, hide: Option[Iterable[ConsequenceHide]] = None, userData: Option[Map[String, Any]] = None) extends Product with Serializable

   

10. case class ConsequenceHide(objectID: String) extends Product with Serializable

    

11. case class ConsequencePromote(objectID: String, position: Int) extends Product with Serializable

    

12. sealed trait CustomRanking extends AnyRef

    

13. sealed trait Distinct extends AnyRef

    

14. case class Edit(type: String, delete: String, insert: Option[String] = None) extends Product with Serializable

    

15. sealed trait IgnorePlurals extends AnyRef

    

16. 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, attributeCriteriaComputedByMinProximity: Option[Boolean] = None, primary: Option[String] = None, userData: Option[Any] = 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

    

17. case class InsideBoundingBox(p1Lat: String, p1Lng: String, p2Lat: String, p2Lng: String) extends Product with Serializable

    

18. case class InsidePolygon(p1Lat: String, p1Lng: String, p2Lat: String, p2Lng: String, p3Lat: String, p3Lng: String) extends Product with Serializable

    

19. sealed trait NumericAttributesToIndex extends AnyRef

    

    Annotations

    @Deprecated

20. case class Query(distinct: Option[Distinct] = None, getRankingInfo: Option[Boolean] = None, numericFilters: Option[Seq[String]] = None, tagFilters: Option[Seq[String]] = None, analytics: Option[Boolean] = None, analyticsTags: Option[Seq[String]] = None, synonyms: Option[Boolean] = None, replaceSynonymsInHighlight: Option[Boolean] = None, minProximity: Option[Int] = None, responseFields: Option[Seq[String]] = None, maxFacetHits: Option[Int] = None, percentileComputation: Option[Boolean] = None, queryLanguages: Option[Seq[String]] = None, enableABTest: Option[Boolean] = None, attributesToRetrieve: Option[Seq[String]] = None, restrictSearchableAttributes: Option[Seq[String]] = None, filters: Option[String] = None, facets: Option[Seq[String]] = None, maxValuesPerFacet: Option[Int] = None, facetFilters: Option[Seq[String]] = None, facetingAfterDistinct: Option[Boolean] = None, sortFacetValuesBy: Option[String] = None, aroundLatLng: Option[AroundLatLng] = None, aroundLatLngViaIP: Option[Boolean] = None, aroundRadius: Option[AroundRadius] = None, aroundPrecision: Option[Int] = None, minimumAroundRadius: Option[Int] = None, insideBoundingBox: Option[Seq[InsideBoundingBox]] = None, insidePolygon: Option[Seq[InsidePolygon]] = 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, page: Option[Int] = None, hitsPerPage: Option[Int] = None, offset: Option[Int] = None, length: Option[Int] = None, enableRules: Option[Boolean] = None, ruleContexts: Option[Seq[String]] = None, queryType: Option[QueryType] = None, removeWordsIfNoResults: Option[RemoveWordsIfNoResults] = None, advancedSyntax: Option[Boolean] = None, advancedSyntaxFeatures: Option[Seq[String]] = None, optionalWords: Option[Seq[String]] = None, removeStopWords: Option[RemoveStopWords] = None, disableExactOnAttributes: Option[Seq[String]] = None, exactOnSingleWordQuery: Option[Seq[String]] = None, alternativesAsExact: Option[Seq[String]] = None, query: Option[String] = None, facetQuery: Option[String] = None, similarQuery: Option[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, userToken: Option[String] = None, validUntil: Option[Int] = None, restrictIndices: Option[Seq[String]] = None, restrictSources: Option[String] = None, cursor: Option[String] = None, enablePersonalization: Option[Boolean] = None, customParameters: Option[Map[String, String]] = None) extends Product with Serializable

    

21. case class QueryRules(query: String, anchoring: Option[String] = None, context: Option[String] = None, page: Option[Int] = None, hitsPerPage: Option[Int] = None, nbPages: Option[Int] = None) extends Product with Serializable

    

22. case class QuerySynonyms(query: String, types: Option[Seq[SynonymType]] = None, page: Option[Int] = None, hitsPerPage: Option[Int] = None) extends Product with Serializable

    

23. sealed trait QueryType extends AnyRef

    

24. sealed trait Ranking extends AnyRef

    

25. sealed trait RemoveStopWords extends AnyRef

    

26. sealed trait RemoveWordsIfNoResults extends AnyRef

    

27. case class RequestOptions(forwardedFor: Option[String] = None, extraHeaders: Option[Map[String, String]] = None, extraQueryParameters: Option[Map[String, String]] = None) extends Product with Serializable

    

28. case class Rule(objectID: String, enabled: Option[Boolean] = None, condition: Condition, consequence: Consequence, validity: Option[Iterable[TimeRange]] = None, description: Option[String] = None) extends Product with Serializable

    

29. case class Score(score: Int) extends Product with Serializable

    

30. case class ScoreType(score: Int, type: String) extends Product with Serializable

    

31. sealed trait SearchableAttributes extends AnyRef

    

32. case class Strategy(eventsScoring: Option[Map[String, ScoreType]] = None, facetsScoring: Option[Map[String, Score]] = None) extends Product with Serializable

    

33. sealed trait SynonymType extends AnyRef

    

34. case class TimeRange(from: ZonedDateTime, until: ZonedDateTime) extends Product with Serializable

    

35. sealed trait TypoTolerance extends AnyRef