Query

Instance Constructors

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, decompoundQuery: Option[Boolean] = None, enableReRanking: 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, 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 allowTyposOnNumericTokens: Option[Boolean]
val alternativesAsExact: Option[Seq[String]]
val analytics: Option[Boolean]
val analyticsTags: Option[Seq[String]]
val aroundLatLng: Option[AroundLatLng]
val aroundLatLngViaIP: Option[Boolean]
val aroundPrecision: Option[Int]
val aroundRadius: Option[AroundRadius]
final def asInstanceOf[T0]: T0

Definition Classes
Any
val attributesToHighlight: Option[Seq[String]]
val attributesToRetrieve: Option[Seq[String]]
val attributesToSnippet: Option[Seq[String]]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
val cursor: Option[String]
val customParameters: Option[Map[String, String]]
val decompoundQuery: Option[Boolean]
val disableExactOnAttributes: Option[Seq[String]]
val disableTypoToleranceOnAttributes: Option[Seq[String]]
val distinct: Option[Distinct]
val enableABTest: Option[Boolean]
val enablePersonalization: Option[Boolean]
val enableReRanking: Option[Boolean]
val enableRules: Option[Boolean]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val exactOnSingleWordQuery: Option[Seq[String]]
val explain: Option[Seq[String]]
val facetFilters: Option[Seq[String]]
val facetingAfterDistinct: Option[Boolean]
val facets: Option[Seq[String]]
val filters: Option[String]
final def getClass(): Class[_]

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

Definition Classes
Any
val length: Option[Int]
val maxFacetHits: Option[Int]
val maxValuesPerFacet: Option[Int]
val minProximity: Option[Int]
val minWordSizefor1Typo: Option[Int]
val minWordSizefor2Typos: Option[Int]
val minimumAroundRadius: Option[Int]
val naturalLanguages: Option[Seq[String]]
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 numericFilters: Option[Seq[String]]
val offset: Option[Int]
val optionalWords: Option[Seq[String]]
val page: Option[Int]
val percentileComputation: Option[Boolean]
val query: Option[String]
val queryLanguages: Option[Seq[String]]
val queryType: Option[QueryType]
val relevancyStrictness: Option[Int]
val removeStopWords: Option[RemoveStopWords]
val removeWordsIfNoResults: Option[RemoveWordsIfNoResults]
val replaceSynonymsInHighlight: Option[Boolean]
val responseFields: Option[Seq[String]]
val restrictHighlightAndSnippetArrays: Option[Boolean]
val restrictIndices: Option[Seq[String]]
val restrictSearchableAttributes: Option[Seq[String]]
val restrictSources: Option[String]
val ruleContexts: Option[Seq[String]]
val similarQuery: Option[String]
val snippetEllipsisText: Option[String]
val sortFacetValuesBy: Option[String]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val synonyms: Option[Boolean]
val tagFilters: Option[Seq[String]]
def toParam: String
def toQueryParam: Map[String, String]
val typoTolerance: Option[TypoTolerance]
val userToken: Option[String]
val validUntil: Option[Int]
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 allowTyposOnNumericTokens: Option[Boolean]

val alternativesAsExact: Option[Seq[String]]

val analytics: Option[Boolean]

val analyticsTags: Option[Seq[String]]

val aroundLatLng: Option[AroundLatLng]

val aroundLatLngViaIP: Option[Boolean]

val aroundPrecision: Option[Int]

val aroundRadius: Option[AroundRadius]

final def asInstanceOf[T0]: T0

val attributesToHighlight: Option[Seq[String]]

val attributesToRetrieve: Option[Seq[String]]

val attributesToSnippet: Option[Seq[String]]

def clone(): AnyRef

val cursor: Option[String]

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

val decompoundQuery: Option[Boolean]

val disableExactOnAttributes: Option[Seq[String]]

val disableTypoToleranceOnAttributes: Option[Seq[String]]

val distinct: Option[Distinct]

val enableABTest: Option[Boolean]

val enablePersonalization: Option[Boolean]

val enableReRanking: Option[Boolean]

val enableRules: Option[Boolean]

final def eq(arg0: AnyRef): Boolean

val exactOnSingleWordQuery: Option[Seq[String]]

val explain: Option[Seq[String]]

val facetFilters: Option[Seq[String]]

val facetingAfterDistinct: Option[Boolean]

val facets: Option[Seq[String]]

val filters: Option[String]

final def getClass(): Class[_]

val getRankingInfo: Option[Boolean]

val highlightPostTag: Option[String]

val highlightPreTag: Option[String]

val hitsPerPage: Option[Int]

val ignorePlurals: Option[IgnorePlurals]

val insideBoundingBox: Option[Seq[InsideBoundingBox]]

val insidePolygon: Option[Seq[InsidePolygon]]

final def isInstanceOf[T0]: Boolean

val length: Option[Int]

val maxFacetHits: Option[Int]

val maxValuesPerFacet: Option[Int]

val minProximity: Option[Int]

val minWordSizefor1Typo: Option[Int]

val minWordSizefor2Typos: Option[Int]

val minimumAroundRadius: Option[Int]

val naturalLanguages: Option[Seq[String]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numericFilters: Option[Seq[String]]

val offset: Option[Int]

val optionalWords: Option[Seq[String]]

val page: Option[Int]

val percentileComputation: Option[Boolean]

val query: Option[String]

val queryLanguages: Option[Seq[String]]

val queryType: Option[QueryType]

val relevancyStrictness: Option[Int]

val removeStopWords: Option[RemoveStopWords]

val removeWordsIfNoResults: Option[RemoveWordsIfNoResults]

val replaceSynonymsInHighlight: Option[Boolean]

val responseFields: Option[Seq[String]]

val restrictHighlightAndSnippetArrays: Option[Boolean]

val restrictIndices: Option[Seq[String]]

val restrictSearchableAttributes: Option[Seq[String]]

val restrictSources: Option[String]

val ruleContexts: Option[Seq[String]]

val similarQuery: Option[String]

val snippetEllipsisText: Option[String]

val sortFacetValuesBy: Option[String]