Class

algolia.objects

Query

Related Doc: package objects

Permalink

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, explain: Option[Seq[String]] = None, naturalLanguages: Option[Seq[String]] = 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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Query
  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 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, explain: Option[Seq[String]] = None, naturalLanguages: Option[Seq[String]] = 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)

    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 allowTyposOnNumericTokens: Option[Boolean]

    Permalink

  7. val alternativesAsExact: Option[Seq[String]]

    Permalink

  8. val analytics: Option[Boolean]

    Permalink

  9. val analyticsTags: Option[Seq[String]]

    Permalink

  10. val aroundLatLng: Option[AroundLatLng]

    Permalink

  11. val aroundLatLngViaIP: Option[Boolean]

    Permalink

  12. val aroundPrecision: Option[Int]

    Permalink

  13. val aroundRadius: Option[AroundRadius]

    Permalink

  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  15. val attributesToHighlight: Option[Seq[String]]

    Permalink

  16. val attributesToRetrieve: Option[Seq[String]]

    Permalink

  17. val attributesToSnippet: Option[Seq[String]]

    Permalink

  18. def clone(): AnyRef

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

  19. val cursor: Option[String]

    Permalink

  20. val customParameters: Option[Map[String, String]]

    Permalink

  21. val disableExactOnAttributes: Option[Seq[String]]

    Permalink

  22. val disableTypoToleranceOnAttributes: Option[Seq[String]]

    Permalink

  23. val distinct: Option[Distinct]

    Permalink

  24. val enableABTest: Option[Boolean]

    Permalink

  25. val enablePersonalization: Option[Boolean]

    Permalink

  26. val enableRules: Option[Boolean]

    Permalink

  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  28. val exactOnSingleWordQuery: Option[Seq[String]]

    Permalink

  29. val explain: Option[Seq[String]]

    Permalink

  30. val facetFilters: Option[Seq[String]]

    Permalink

  31. val facetingAfterDistinct: Option[Boolean]

    Permalink

  32. val facets: Option[Seq[String]]

    Permalink

  33. val filters: Option[String]

    Permalink

  34. def finalize(): Unit

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

  35. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  36. val getRankingInfo: Option[Boolean]

    Permalink

  37. val highlightPostTag: Option[String]

    Permalink

  38. val highlightPreTag: Option[String]

    Permalink

  39. val hitsPerPage: Option[Int]

    Permalink

  40. val ignorePlurals: Option[IgnorePlurals]

    Permalink

  41. val insideBoundingBox: Option[Seq[InsideBoundingBox]]

    Permalink

  42. val insidePolygon: Option[Seq[InsidePolygon]]

    Permalink

  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  44. val length: Option[Int]

    Permalink

  45. val maxFacetHits: Option[Int]

    Permalink

  46. val maxValuesPerFacet: Option[Int]

    Permalink

  47. val minProximity: Option[Int]

    Permalink

  48. val minWordSizefor1Typo: Option[Int]

    Permalink

  49. val minWordSizefor2Typos: Option[Int]

    Permalink

  50. val minimumAroundRadius: Option[Int]

    Permalink

  51. val naturalLanguages: Option[Seq[String]]

    Permalink

  52. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  53. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  54. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  55. val numericFilters: Option[Seq[String]]

    Permalink

  56. val offset: Option[Int]

    Permalink

  57. val optionalWords: Option[Seq[String]]

    Permalink

  58. val page: Option[Int]

    Permalink

  59. val percentileComputation: Option[Boolean]

    Permalink

  60. val query: Option[String]

    Permalink

  61. val queryLanguages: Option[Seq[String]]

    Permalink

  62. val queryType: Option[QueryType]

    Permalink

  63. val removeStopWords: Option[RemoveStopWords]

    Permalink

  64. val removeWordsIfNoResults: Option[RemoveWordsIfNoResults]

    Permalink

  65. val replaceSynonymsInHighlight: Option[Boolean]

    Permalink

  66. val responseFields: Option[Seq[String]]

    Permalink

  67. val restrictHighlightAndSnippetArrays: Option[Boolean]

    Permalink

  68. val restrictIndices: Option[Seq[String]]

    Permalink

  69. val restrictSearchableAttributes: Option[Seq[String]]

    Permalink

  70. val restrictSources: Option[String]

    Permalink

  71. val ruleContexts: Option[Seq[String]]

    Permalink

  72. val similarQuery: Option[String]

    Permalink

  73. val snippetEllipsisText: Option[String]

    Permalink

  74. val sortFacetValuesBy: Option[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  76. val synonyms: Option[Boolean]

    Permalink

  77. val tagFilters: Option[Seq[String]]

    Permalink

  78. def toParam: String

    Permalink

  79. def toQueryParam: Map[String, String]

    Permalink

  80. val typoTolerance: Option[TypoTolerance]

    Permalink

  81. val userToken: Option[String]

    Permalink

  82. val validUntil: Option[Int]

    Permalink

  83. final def wait(): Unit

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

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

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

  85. final def wait(arg0: Long): Unit

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped