QueryBase (algoliasearch-common 2.21.1 API)

java.lang.Object
- com.algolia.search.objects.QueryBase<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConsequenceParams, Query
```
public abstract class QueryBase<T extends QueryBase<?>>
extends Object
implements Serializable
```
QueryBase contains all the members of a Query and their associated getters and setters used for Jackson to serialize/deserialize. Note that all those parameters can also be set for the ConsequenceParams (used in the Query Rules context). This is why both Query and ConsequenceParams concrete classes inherit from QueryBase. The T parametric type is used to let us use chaining for the builder pattern i.e. making sure that we can write for instance:
```
   Query q = new Query().setFilters(...); ConsequenceParams q = new
   ConsequenceParams().setFilters(...);
 
```
without having to rewrite the setters in both concrete classes even though their returned type is different.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QueryBase.QueryType

static class QueryBase.RemoveWordsType

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryBase.QueryType`
`static class`	`QueryBase.RemoveWordsType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`advancedSyntax`
`protected Boolean`	`allowTyposOnNumericTokens`
`protected List<String>`	`alternativesAsExact`
`protected Boolean`	`analytics`
`protected String`	`analyticsTags`
`protected String`	`aroundLatLng`
`protected Boolean`	`aroundLatLngViaIP`
`protected Integer`	`aroundPrecision`
`protected AroundRadius`	`aroundRadius`
`protected List<String>`	`attributesToHighlight`
`protected List<String>`	`attributesToRetrieve`
`protected List<String>`	`attributesToSnippet`
`protected Boolean`	`clickAnalytics`
`protected String`	`cursor`
`protected Map<String,Object>`	`customParameters`
`protected List<String>`	`disableExactOnAttributes`
`protected List<String>`	`disableTypoToleranceOnAttributes`
`protected Distinct`	`distinct`
`protected Boolean`	`enablePersonalization`
`protected Boolean`	`enableRules`
`protected String`	`exactOnSingleWordQuery`
`protected FacetFilters`	`facetFilters`
`protected Boolean`	`facetingAfterDistinct`
`protected String`	`facets`
`protected String`	`filters`
`protected Boolean`	`getRankingInfo`
`protected String`	`highlightPostTag`
`protected String`	`highlightPreTag`
`protected Long`	`hitsPerPage`
`protected IgnorePlurals`	`ignorePlurals`
`protected List<String>`	`insideBoundingBox`
`protected List<String>`	`insidePolygon`
`protected Long`	`length`
`protected Long`	`maxFacetHits`
`protected Long`	`maxValuesPerFacet`
`protected Integer`	`minimumAroundRadius`
`protected Integer`	`minProximity`
`protected Integer`	`minWordSizefor1Typo`
`protected Integer`	`minWordSizefor2Typos`
`protected List<String>`	`numericFilters`
`protected Long`	`offset`
`protected List<String>`	`optionalWords`
`protected Long`	`page`
`protected Boolean`	`percentileComputation`
`protected String`	`query`
`protected List<String>`	`queryLanguages`
`protected String`	`queryType`
`protected RemoveStopWords`	`removeStopWords`
`protected QueryBase.RemoveWordsType`	`removeWordsIfNoResults`
`protected Boolean`	`replaceSynonymsInHighlight`
`protected List<String>`	`responseFields`
`protected Boolean`	`restrictHighlightAndSnippetArrays`
`protected List<String>`	`restrictIndices`
`protected List<String>`	`restrictSearchableAttributes`
`protected String`	`restrictSources`
`protected List<String>`	`ruleContexts`
`protected String`	`snippetEllipsisText`
`protected String`	`sortFacetValuesBy`
`protected Boolean`	`synonyms`
`protected List<String>`	`tagFilters`
`protected TypoTolerance`	`typoTolerance`
`protected String`	`userToken`
`protected Integer`	`validUntil`

Constructor Summary

Constructors
Constructor and Description

QueryBase()

Constructors
Constructor and Description
`QueryBase()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`T`	`addCustomParameter(String key, String value)`
`Boolean`	`getAdvancedSyntax()`
`Boolean`	`getAllowTyposOnNumericTokens()`
`List<String>`	`getAlternativesAsExact()`
`Boolean`	`getAnalytics()`
`String`	`getAnalyticsTags()`
`String`	`getAroundLatLng()`
`Boolean`	`getAroundLatLngViaIP()`
`Integer`	`getAroundPrecision()`
`AroundRadius`	`getAroundRadius()`
`List<String>`	`getAttributesToHighlight()`
`List<String>`	`getAttributesToRetrieve()`
`List<String>`	`getAttributesToSnippet()`
`Boolean`	`getClickAnalytics()`
`String`	`getCursor()`
`Map<String,Object>`	`getCustomParameters()`
`List<String>`	`getDisableExactOnAttributes()`
`List<String>`	`getDisableTypoToleranceOnAttributes()`
`Distinct`	`getDistinct()`
`Boolean`	`getEnablePersonalization()`
`Boolean`	`getEnableRules()`
`String`	`getExactOnSingleWordQuery()`
`FacetFilters`	`getFacetFilters()`
`Boolean`	`getFacetingAfterDistinct()`
`String`	`getFacets()`
`String`	`getFilters()`
`Boolean`	`getGetRankingInfo()`
`String`	`getHighlightPostTag()`
`String`	`getHighlightPreTag()`
`Long`	`getHitsPerPage()`
`IgnorePlurals`	`getIgnorePlurals()`
`List<String>`	`getInsideBoundingBox()`
`List<String>`	`getInsidePolygon()`
`Long`	`getLength()`
`Long`	`getMaxFacetHits()`
`Long`	`getMaxValuesPerFacet()`
`Integer`	`getMinimumAroundRadius()`
`Integer`	`getMinProximity()`
`Integer`	`getMinWordSizefor1Typo()`
`Integer`	`getMinWordSizefor2Typos()`
`List<String>`	`getNumericFilters()`
`Long`	`getOffset()`
`List<String>`	`getOptionalWords()`
`Long`	`getPage()`
`Boolean`	`getPercentileComputation()`
`List<String>`	`getQueryLanguages()`
`String`	`getQueryType()`
`RemoveStopWords`	`getRemoveStopWords()`
`QueryBase.RemoveWordsType`	`getRemoveWordsIfNoResults()`
`Boolean`	`getReplaceSynonymsInHighlight()`
`List<String>`	`getResponseFields()`
`Boolean`	`getRestrictHighlightAndSnippetArrays()`
`List<String>`	`getRestrictIndices()`
`List<String>`	`getRestrictSearchableAttributes()`
`String`	`getRestrictSources()`
`List<String>`	`getRuleContexts()`
`String`	`getSnippetEllipsisText()`
`String`	`getSortFacetValuesBy()`
`Boolean`	`getSynonyms()`
`List<String>`	`getTagFilters()`
`TypoTolerance`	`getTypoTolerance()`
`String`	`getUserToken()`
`Integer`	`getValidUntil()`
`T`	`setAdvancedSyntax(Boolean advancedSyntax)`
`T`	`setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)`
`T`	`setAlternativesAsExact(List<String> alternativesAsExact)`
`T`	`setAnalytics(Boolean analytics)`
`T`	`setAnalyticsTags(String analyticsTags)`
`T`	`setAroundLatLng(String aroundLatLng)`
`T`	`setAroundLatLngViaIP(Boolean aroundLatLngViaIP)`
`T`	`setAroundPrecision(Integer aroundPrecision)`
`T`	`setAroundRadius(AroundRadius aroundRadius)`
`T`	`setAttributesToHighlight(List<String> attributesToHighlight)`
`T`	`setAttributesToRetrieve(List<String> attributesToRetrieve)`
`T`	`setAttributesToSnippet(List<String> attributesToSnippet)`
`T`	`setClickAnalytics(Boolean clickAnalytics)`
`T`	`setCursor(String cursor)`
`T`	`setCustomParameters(Map<String,Object> customParameters)`
`T`	`setDisableExactOnAttributes(List<String> disableExactOnAttributes)`
`T`	`setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)`
`T`	`setDistinct(Distinct distinct)`
`T`	`setEnablePersonalization(Boolean enablePersonalization)`
`T`	`setEnableRules(Boolean enableRules)`
`T`	`setExactOnSingleWordQuery(String exactOnSingleWordQuery)`
`T`	`setFacetFilters(FacetFilters facetFilters)`
`T`	`setFacetFilters(List<String> facetFilters)` Deprecated.
`T`	`setFacetingAfterDistinct(Boolean facetingAfterDistinct)`
`T`	`setFacets(String facets)`
`T`	`setFilters(String filters)`
`T`	`setGetRankingInfo(Boolean getRankingInfo)`
`T`	`setHighlightPostTag(String highlightPostTag)`
`T`	`setHighlightPreTag(String highlightPreTag)`
`T`	`setHitsPerPage(Integer hitsPerPage)`
`T`	`setHitsPerPage(Long hitsPerPage)`
`T`	`setIgnorePlurals(IgnorePlurals ignorePlurals)`
`T`	`setInsideBoundingBox(List<String> insideBoundingBox)`
`T`	`setInsidePolygon(List<String> insidePolygon)`
`T`	`setLength(Integer length)`
`T`	`setLength(Long length)`
`T`	`setMaxFacetHits(Integer maxFacetHits)`
`T`	`setMaxFacetHits(Long maxFacetHits)`
`T`	`setMaxValuesPerFacet(Integer maxValuesPerFacet)`
`T`	`setMaxValuesPerFacet(Long maxValuesPerFacet)`
`T`	`setMinimumAroundRadius(Integer minimumAroundRadius)`
`T`	`setMinProximity(Integer minProximity)`
`T`	`setMinWordSizefor1Typo(Integer minWordSizefor1Typo)`
`T`	`setMinWordSizefor2Typos(Integer minWordSizefor2Typos)`
`T`	`setNumericFilters(List<String> numericFilters)`
`T`	`setOffset(Integer offset)`
`T`	`setOffset(Long offset)`
`T`	`setOptionalWords(List<String> optionalWords)`
`T`	`setPage(Integer page)`
`T`	`setPage(Long page)`
`T`	`setPercentileComputation(Boolean percentileComputation)`
`T`	`setQuery(String query)`
`T`	`setQueryLanguages(List<String> queryLanguages)`
`T`	`setQueryType(String queryType)`
`T`	`setRemoveStopWords(RemoveStopWords removeStopWords)`
`T`	`setRemoveWordsIfNoResults(QueryBase.RemoveWordsType removeWordsIfNoResults)`
`T`	`setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)`
`T`	`setResponseFields(List<String> responseFields)`
`T`	`setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)`
`T`	`setRestrictIndices(List<String> restrictIndices)`
`T`	`setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)`
`T`	`setRestrictSources(String restrictSources)`
`T`	`setRuleContexts(List<String> ruleContexts)`
`T`	`setSnippetEllipsisText(String snippetEllipsisText)`
`T`	`setSortFacetValuesBy(String sortFacetValuesBy)`
`T`	`setSynonyms(Boolean synonyms)`
`T`	`setTagFilters(List<String> tagFilters)`
`T`	`setTypoTolerance(TypoTolerance typoTolerance)`
`T`	`setUserToken(String userToken)`
`T`	`setValidUntil(Integer validUntil)`
`String`	`toParam()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

distinct
```
protected Distinct distinct
```

getRankingInfo
```
protected Boolean getRankingInfo
```

numericFilters
```
protected List<String> numericFilters
```

tagFilters
```
protected List<String> tagFilters
```

clickAnalytics
```
protected Boolean clickAnalytics
```

analytics
```
protected Boolean analytics
```

analyticsTags
```
protected String analyticsTags
```

synonyms
```
protected Boolean synonyms
```

replaceSynonymsInHighlight

protected Boolean replaceSynonymsInHighlight

minProximity
```
protected Integer minProximity
```

responseFields
```
protected List<String> responseFields
```

maxFacetHits
```
protected Long maxFacetHits
```

percentileComputation

protected Boolean percentileComputation

queryLanguages
```
protected List<String> queryLanguages
```

attributesToRetrieve

protected List<String> attributesToRetrieve

restrictSearchableAttributes

protected List<String> restrictSearchableAttributes

filters
```
protected String filters
```

facets
```
protected String facets
```

maxValuesPerFacet
```
protected Long maxValuesPerFacet
```

facetFilters
```
protected FacetFilters facetFilters
```

facetingAfterDistinct

protected Boolean facetingAfterDistinct

sortFacetValuesBy
```
protected String sortFacetValuesBy
```

aroundLatLng
```
protected String aroundLatLng
```

aroundLatLngViaIP
```
protected Boolean aroundLatLngViaIP
```

aroundRadius
```
protected AroundRadius aroundRadius
```

aroundPrecision
```
protected Integer aroundPrecision
```

minimumAroundRadius
```
protected Integer minimumAroundRadius
```

insideBoundingBox

protected List<String> insideBoundingBox

insidePolygon
```
protected List<String> insidePolygon
```

attributesToHighlight

protected List<String> attributesToHighlight

attributesToSnippet

protected List<String> attributesToSnippet

highlightPreTag
```
protected String highlightPreTag
```

highlightPostTag
```
protected String highlightPostTag
```

snippetEllipsisText
```
protected String snippetEllipsisText
```

restrictHighlightAndSnippetArrays

protected Boolean restrictHighlightAndSnippetArrays

page
```
protected Long page
```

hitsPerPage
```
protected Long hitsPerPage
```

offset
```
protected Long offset
```

length
```
protected Long length
```

enableRules
```
protected Boolean enableRules
```

ruleContexts
```
protected List<String> ruleContexts
```

queryType
```
protected String queryType
```

removeWordsIfNoResults

protected QueryBase.RemoveWordsType removeWordsIfNoResults

advancedSyntax
```
protected Boolean advancedSyntax
```

optionalWords
```
protected List<String> optionalWords
```

removeStopWords

protected RemoveStopWords removeStopWords

disableExactOnAttributes

protected List<String> disableExactOnAttributes

exactOnSingleWordQuery

protected String exactOnSingleWordQuery

alternativesAsExact

protected List<String> alternativesAsExact

query
```
protected String query
```

minWordSizefor1Typo
```
protected Integer minWordSizefor1Typo
```

minWordSizefor2Typos
```
protected Integer minWordSizefor2Typos
```

typoTolerance
```
protected TypoTolerance typoTolerance
```

allowTyposOnNumericTokens

protected Boolean allowTyposOnNumericTokens

ignorePlurals
```
protected IgnorePlurals ignorePlurals
```

disableTypoToleranceOnAttributes

protected List<String> disableTypoToleranceOnAttributes

userToken
```
protected String userToken
```

validUntil
```
protected Integer validUntil
```

restrictIndices
```
protected List<String> restrictIndices
```

restrictSources
```
protected String restrictSources
```

cursor
```
protected String cursor
```

enablePersonalization

protected Boolean enablePersonalization

customParameters

protected Map<String,Object> customParameters

Constructor Detail
- QueryBase
```
public QueryBase()
```

Method Detail

toParam
```
public String toParam()
```

setAroundRadius

public T setAroundRadius(AroundRadius aroundRadius)

addCustomParameter

public T addCustomParameter(String key,
                            String value)

getDistinct
```
public Distinct getDistinct()
```

setDistinct

public T setDistinct(Distinct distinct)

getGetRankingInfo
```
public Boolean getGetRankingInfo()
```

setGetRankingInfo

public T setGetRankingInfo(Boolean getRankingInfo)

getNumericFilters

public List<String> getNumericFilters()

setNumericFilters

public T setNumericFilters(List<String> numericFilters)

getTagFilters
```
public List<String> getTagFilters()
```

setTagFilters

public T setTagFilters(List<String> tagFilters)

getClickAnalytics
```
public Boolean getClickAnalytics()
```

setClickAnalytics

public T setClickAnalytics(Boolean clickAnalytics)

getAnalytics
```
public Boolean getAnalytics()
```

setAnalytics

public T setAnalytics(Boolean analytics)

getAnalyticsTags
```
public String getAnalyticsTags()
```

setAnalyticsTags

public T setAnalyticsTags(String analyticsTags)

getSynonyms
```
public Boolean getSynonyms()
```

setSynonyms

public T setSynonyms(Boolean synonyms)

getReplaceSynonymsInHighlight

public Boolean getReplaceSynonymsInHighlight()

setReplaceSynonymsInHighlight

public T setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

getMinProximity
```
public Integer getMinProximity()
```

setMinProximity

public T setMinProximity(Integer minProximity)

getResponseFields

public List<String> getResponseFields()

setResponseFields

public T setResponseFields(List<String> responseFields)

getMaxFacetHits
```
public Long getMaxFacetHits()
```

setMaxFacetHits

public T setMaxFacetHits(Long maxFacetHits)

setMaxFacetHits

public T setMaxFacetHits(Integer maxFacetHits)

getPercentileComputation

public Boolean getPercentileComputation()

setPercentileComputation

public T setPercentileComputation(Boolean percentileComputation)

getQueryLanguages

public List<String> getQueryLanguages()

setQueryLanguages

public T setQueryLanguages(List<String> queryLanguages)

getAttributesToRetrieve

public List<String> getAttributesToRetrieve()

setAttributesToRetrieve

public T setAttributesToRetrieve(List<String> attributesToRetrieve)

getRestrictSearchableAttributes

public List<String> getRestrictSearchableAttributes()

setRestrictSearchableAttributes

public T setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)

getFilters
```
public String getFilters()
```

setFilters
```
public T setFilters(String filters)
```

getFacets
```
public String getFacets()
```

setFacets
```
public T setFacets(String facets)
```

getMaxValuesPerFacet
```
public Long getMaxValuesPerFacet()
```

setMaxValuesPerFacet

public T setMaxValuesPerFacet(Long maxValuesPerFacet)

setMaxValuesPerFacet

public T setMaxValuesPerFacet(Integer maxValuesPerFacet)

getFacetFilters
```
public FacetFilters getFacetFilters()
```

setFacetFilters

@Deprecated
public T setFacetFilters(List<String> facetFilters)

Deprecated.

setFacetFilters

public T setFacetFilters(FacetFilters facetFilters)

getFacetingAfterDistinct

public Boolean getFacetingAfterDistinct()

setFacetingAfterDistinct

public T setFacetingAfterDistinct(Boolean facetingAfterDistinct)

getAroundLatLng
```
public String getAroundLatLng()
```

setAroundLatLng

public T setAroundLatLng(String aroundLatLng)

getAroundLatLngViaIP
```
public Boolean getAroundLatLngViaIP()
```

setAroundLatLngViaIP

public T setAroundLatLngViaIP(Boolean aroundLatLngViaIP)

getAroundRadius
```
public AroundRadius getAroundRadius()
```

getAroundPrecision
```
public Integer getAroundPrecision()
```

setAroundPrecision

public T setAroundPrecision(Integer aroundPrecision)

getMinimumAroundRadius

public Integer getMinimumAroundRadius()

setMinimumAroundRadius

public T setMinimumAroundRadius(Integer minimumAroundRadius)

getInsideBoundingBox

public List<String> getInsideBoundingBox()

setInsideBoundingBox

public T setInsideBoundingBox(List<String> insideBoundingBox)

getInsidePolygon

public List<String> getInsidePolygon()

setInsidePolygon

public T setInsidePolygon(List<String> insidePolygon)

getAttributesToHighlight

public List<String> getAttributesToHighlight()

setAttributesToHighlight

public T setAttributesToHighlight(List<String> attributesToHighlight)

getAttributesToSnippet

public List<String> getAttributesToSnippet()

setAttributesToSnippet

public T setAttributesToSnippet(List<String> attributesToSnippet)

getHighlightPreTag
```
public String getHighlightPreTag()
```

setHighlightPreTag

public T setHighlightPreTag(String highlightPreTag)

getHighlightPostTag
```
public String getHighlightPostTag()
```

setHighlightPostTag

public T setHighlightPostTag(String highlightPostTag)

getSnippetEllipsisText

public String getSnippetEllipsisText()

setSnippetEllipsisText

public T setSnippetEllipsisText(String snippetEllipsisText)

getRestrictHighlightAndSnippetArrays

public Boolean getRestrictHighlightAndSnippetArrays()

setRestrictHighlightAndSnippetArrays

public T setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)

getPage
```
public Long getPage()
```

setPage
```
public T setPage(Long page)
```

setPage
```
public T setPage(Integer page)
```

getHitsPerPage
```
public Long getHitsPerPage()
```

setHitsPerPage

public T setHitsPerPage(Long hitsPerPage)

setHitsPerPage

public T setHitsPerPage(Integer hitsPerPage)

getOffset
```
public Long getOffset()
```

setOffset
```
public T setOffset(Long offset)
```

setOffset
```
public T setOffset(Integer offset)
```

getLength
```
public Long getLength()
```

setLength
```
public T setLength(Long length)
```

setLength
```
public T setLength(Integer length)
```

getQueryType
```
public String getQueryType()
```

setQueryType

public T setQueryType(String queryType)

getRemoveWordsIfNoResults

public QueryBase.RemoveWordsType getRemoveWordsIfNoResults()

setRemoveWordsIfNoResults

public T setRemoveWordsIfNoResults(QueryBase.RemoveWordsType removeWordsIfNoResults)

getAdvancedSyntax
```
public Boolean getAdvancedSyntax()
```

setAdvancedSyntax

public T setAdvancedSyntax(Boolean advancedSyntax)

getOptionalWords

public List<String> getOptionalWords()

setOptionalWords

public T setOptionalWords(List<String> optionalWords)

getRemoveStopWords

public RemoveStopWords getRemoveStopWords()

setRemoveStopWords

public T setRemoveStopWords(RemoveStopWords removeStopWords)

getDisableExactOnAttributes

public List<String> getDisableExactOnAttributes()

setDisableExactOnAttributes

public T setDisableExactOnAttributes(List<String> disableExactOnAttributes)

getExactOnSingleWordQuery

public String getExactOnSingleWordQuery()

setExactOnSingleWordQuery

public T setExactOnSingleWordQuery(String exactOnSingleWordQuery)

getAlternativesAsExact

public List<String> getAlternativesAsExact()

setAlternativesAsExact

public T setAlternativesAsExact(List<String> alternativesAsExact)

getMinWordSizefor1Typo

public Integer getMinWordSizefor1Typo()

setMinWordSizefor1Typo

public T setMinWordSizefor1Typo(Integer minWordSizefor1Typo)

getMinWordSizefor2Typos

public Integer getMinWordSizefor2Typos()

setMinWordSizefor2Typos

public T setMinWordSizefor2Typos(Integer minWordSizefor2Typos)

getTypoTolerance

public TypoTolerance getTypoTolerance()

setTypoTolerance

public T setTypoTolerance(TypoTolerance typoTolerance)

getAllowTyposOnNumericTokens

public Boolean getAllowTyposOnNumericTokens()

setAllowTyposOnNumericTokens

public T setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

getIgnorePlurals

public IgnorePlurals getIgnorePlurals()

setIgnorePlurals

public T setIgnorePlurals(IgnorePlurals ignorePlurals)

getDisableTypoToleranceOnAttributes

public List<String> getDisableTypoToleranceOnAttributes()

setDisableTypoToleranceOnAttributes

public T setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

getUserToken
```
public String getUserToken()
```

setUserToken

public T setUserToken(String userToken)

getValidUntil
```
public Integer getValidUntil()
```

setValidUntil

public T setValidUntil(Integer validUntil)

getRestrictIndices

public List<String> getRestrictIndices()

setRestrictIndices

public T setRestrictIndices(List<String> restrictIndices)

getRestrictSources
```
public String getRestrictSources()
```

setRestrictSources

public T setRestrictSources(String restrictSources)

getCursor
```
public String getCursor()
```

setCursor
```
public T setCursor(String cursor)
```

getEnableRules
```
public Boolean getEnableRules()
```

setEnableRules

public T setEnableRules(Boolean enableRules)

getRuleContexts
```
public List<String> getRuleContexts()
```

getEnablePersonalization

public Boolean getEnablePersonalization()

setEnablePersonalization

public T setEnablePersonalization(Boolean enablePersonalization)

setRuleContexts

public T setRuleContexts(List<String> ruleContexts)

setQuery
```
public T setQuery(String query)
```

getSortFacetValuesBy
```
public String getSortFacetValuesBy()
```

setSortFacetValuesBy

public T setSortFacetValuesBy(String sortFacetValuesBy)

getCustomParameters

public Map<String,Object> getCustomParameters()

setCustomParameters

public T setCustomParameters(Map<String,Object> customParameters)

toString
```
public String toString()
```
Overrides:

toString in class Object

Class QueryBase<T extends QueryBase<?>>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

distinct

getRankingInfo

numericFilters

tagFilters

clickAnalytics

analytics

analyticsTags

synonyms

replaceSynonymsInHighlight

minProximity

responseFields

maxFacetHits

percentileComputation

queryLanguages

attributesToRetrieve

restrictSearchableAttributes

filters

facets

maxValuesPerFacet

facetFilters

facetingAfterDistinct

sortFacetValuesBy

aroundLatLng

aroundLatLngViaIP

aroundRadius

aroundPrecision

minimumAroundRadius

insideBoundingBox

insidePolygon

attributesToHighlight

attributesToSnippet

highlightPreTag

highlightPostTag

snippetEllipsisText

restrictHighlightAndSnippetArrays

page

hitsPerPage

offset

length

enableRules

ruleContexts

queryType

removeWordsIfNoResults

advancedSyntax

optionalWords

removeStopWords

disableExactOnAttributes

exactOnSingleWordQuery

alternativesAsExact

query

minWordSizefor1Typo

minWordSizefor2Typos

typoTolerance

allowTyposOnNumericTokens

ignorePlurals

disableTypoToleranceOnAttributes

userToken

validUntil

restrictIndices

restrictSources

cursor

enablePersonalization

customParameters

Constructor Detail

QueryBase

Method Detail

toParam

setAroundRadius

addCustomParameter

getDistinct

setDistinct

getGetRankingInfo

setGetRankingInfo