Query (algoliasearch-common 2.13.1 API)

java.lang.Object
- com.algolia.search.objects.Query

Direct Known Subclasses:

ConsequenceParams
```
public class Query
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Query.QueryType

static class Query.RemoveWordsType

static class Query.TypoTolerance

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

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 Object`	`aroundRadius`
`protected List<String>`	`attributesToHighlight`
`protected List<String>`	`attributesToRetrieve`
`protected List<String>`	`attributesToSnippet`
`protected String`	`cursor`
`protected Map<String,String>`	`customParameters`
`protected List<String>`	`disableExactOnAttributes`
`protected List<String>`	`disableTypoToleranceOnAttributes`
`protected Distinct`	`distinct`
`protected Boolean`	`enableRules`
`protected String`	`exactOnSingleWordQuery`
`protected List<String>`	`facetFilters`
`protected Boolean`	`facetingAfterDistinct`
`protected String`	`facets`
`protected String`	`filters`
`protected Boolean`	`getRankingInfo`
`protected String`	`highlightPostTag`
`protected String`	`highlightPreTag`
`protected Integer`	`hitsPerPage`
`protected IgnorePlurals`	`ignorePlurals`
`protected List<String>`	`insideBoundingBox`
`protected List<String>`	`insidePolygon`
`protected Integer`	`length`
`protected Integer`	`maxFacetHits`
`protected Integer`	`maxValuesPerFacet`
`protected Integer`	`minimumAroundRadius`
`protected Integer`	`minProximity`
`protected Integer`	`minWordSizefor1Typo`
`protected Integer`	`minWordSizefor2Typos`
`protected List<String>`	`numericFilters`
`protected Integer`	`offset`
`protected List<String>`	`optionalWords`
`protected Integer`	`page`
`protected Boolean`	`percentileComputation`
`protected String`	`query`
`protected String`	`queryType`
`protected RemoveStopWords`	`removeStopWords`
`protected Query.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 Boolean`	`synonyms`
`protected List<String>`	`tagFilters`
`protected Query.TypoTolerance`	`typoTolerance`
`protected String`	`userToken`
`protected Integer`	`validUntil`

Constructor Summary

Constructors
Constructor and Description

Query()

Query(String query)

Constructors
Constructor and Description
`Query()`
`Query(String query)`

Method Summary

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

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 Integer maxFacetHits
```

percentileComputation

protected Boolean percentileComputation

attributesToRetrieve

protected List<String> attributesToRetrieve

restrictSearchableAttributes

protected List<String> restrictSearchableAttributes

filters
```
protected String filters
```

facets
```
protected String facets
```

maxValuesPerFacet
```
protected Integer maxValuesPerFacet
```

facetFilters
```
protected List<String> facetFilters
```

facetingAfterDistinct

protected Boolean facetingAfterDistinct

aroundLatLng
```
protected String aroundLatLng
```

aroundLatLngViaIP
```
protected Boolean aroundLatLngViaIP
```

aroundRadius
```
protected Object 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 Integer page
```

hitsPerPage
```
protected Integer hitsPerPage
```

offset
```
protected Integer offset
```

length
```
protected Integer length
```

enableRules
```
protected Boolean enableRules
```

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

queryType
```
protected String queryType
```

removeWordsIfNoResults

protected Query.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 Query.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
```

customParameters

protected Map<String,String> customParameters

Constructor Detail

Query
```
public Query()
```

Query
```
public Query(String query)
```

Method Detail

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

setAroundRadius

public Query setAroundRadius(Integer aroundRadius)

setAroundRadiusAll
```
public Query setAroundRadiusAll()
```

addCustomParameter

public Query addCustomParameter(String key,
                                String value)

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

setDistinct

public Query setDistinct(Distinct distinct)

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

setGetRankingInfo

public Query setGetRankingInfo(Boolean getRankingInfo)

getNumericFilters

public List<String> getNumericFilters()

setNumericFilters

public Query setNumericFilters(List<String> numericFilters)

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

setTagFilters

public Query setTagFilters(List<String> tagFilters)

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

setAnalytics

public Query setAnalytics(Boolean analytics)

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

setAnalyticsTags

public Query setAnalyticsTags(String analyticsTags)

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

setSynonyms

public Query setSynonyms(Boolean synonyms)

getReplaceSynonymsInHighlight

public Boolean getReplaceSynonymsInHighlight()

setReplaceSynonymsInHighlight

public Query setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

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

setMinProximity

public Query setMinProximity(Integer minProximity)

getResponseFields

public List<String> getResponseFields()

setResponseFields

public Query setResponseFields(List<String> responseFields)

getMaxFacetHits
```
public Integer getMaxFacetHits()
```

setMaxFacetHits

public Query setMaxFacetHits(Integer maxFacetHits)

getPercentileComputation

public Boolean getPercentileComputation()

setPercentileComputation

public Query setPercentileComputation(Boolean percentileComputation)

getAttributesToRetrieve

public List<String> getAttributesToRetrieve()

setAttributesToRetrieve

public Query setAttributesToRetrieve(List<String> attributesToRetrieve)

getRestrictSearchableAttributes

public List<String> getRestrictSearchableAttributes()

setRestrictSearchableAttributes

public Query setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)

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

setFilters

public Query setFilters(String filters)

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

setFacets

public Query setFacets(String facets)

getMaxValuesPerFacet
```
public Integer getMaxValuesPerFacet()
```

setMaxValuesPerFacet

public Query setMaxValuesPerFacet(Integer maxValuesPerFacet)

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

setFacetFilters

public Query setFacetFilters(List<String> facetFilters)

getFacetingAfterDistinct

public Boolean getFacetingAfterDistinct()

setFacetingAfterDistinct

public Query setFacetingAfterDistinct(Boolean facetingAfterDistinct)

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

setAroundLatLng

public Query setAroundLatLng(String aroundLatLng)

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

setAroundLatLngViaIP

public Query setAroundLatLngViaIP(Boolean aroundLatLngViaIP)

getAroundRadius
```
public Object getAroundRadius()
```

setAroundRadius

public Query setAroundRadius(Object aroundRadius)

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

setAroundPrecision

public Query setAroundPrecision(Integer aroundPrecision)

getMinimumAroundRadius

public Integer getMinimumAroundRadius()

setMinimumAroundRadius

public Query setMinimumAroundRadius(Integer minimumAroundRadius)

getInsideBoundingBox

public List<String> getInsideBoundingBox()

setInsideBoundingBox

public Query setInsideBoundingBox(List<String> insideBoundingBox)

getInsidePolygon

public List<String> getInsidePolygon()

setInsidePolygon

public Query setInsidePolygon(List<String> insidePolygon)

getAttributesToHighlight

public List<String> getAttributesToHighlight()

setAttributesToHighlight

public Query setAttributesToHighlight(List<String> attributesToHighlight)

getAttributesToSnippet

public List<String> getAttributesToSnippet()

setAttributesToSnippet

public Query setAttributesToSnippet(List<String> attributesToSnippet)

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

setHighlightPreTag

public Query setHighlightPreTag(String highlightPreTag)

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

setHighlightPostTag

public Query setHighlightPostTag(String highlightPostTag)

getSnippetEllipsisText

public String getSnippetEllipsisText()

setSnippetEllipsisText

public Query setSnippetEllipsisText(String snippetEllipsisText)

getRestrictHighlightAndSnippetArrays

public Boolean getRestrictHighlightAndSnippetArrays()

setRestrictHighlightAndSnippetArrays

public Query setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)

getPage
```
public Integer getPage()
```

setPage
```
public Query setPage(Integer page)
```

getHitsPerPage
```
public Integer getHitsPerPage()
```

setHitsPerPage

public Query setHitsPerPage(Integer hitsPerPage)

getOffset
```
public Integer getOffset()
```

setOffset

public Query setOffset(Integer offset)

getLength
```
public Integer getLength()
```

setLength

public Query setLength(Integer length)

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

setQueryType

public Query setQueryType(String queryType)

getRemoveWordsIfNoResults

public Query.RemoveWordsType getRemoveWordsIfNoResults()

setRemoveWordsIfNoResults

public Query setRemoveWordsIfNoResults(Query.RemoveWordsType removeWordsIfNoResults)

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

setAdvancedSyntax

public Query setAdvancedSyntax(Boolean advancedSyntax)

getOptionalWords

public List<String> getOptionalWords()

setOptionalWords

public Query setOptionalWords(List<String> optionalWords)

getRemoveStopWords

public RemoveStopWords getRemoveStopWords()

setRemoveStopWords

public Query setRemoveStopWords(RemoveStopWords removeStopWords)

getDisableExactOnAttributes

public List<String> getDisableExactOnAttributes()

setDisableExactOnAttributes

public Query setDisableExactOnAttributes(List<String> disableExactOnAttributes)

getExactOnSingleWordQuery

public String getExactOnSingleWordQuery()

setExactOnSingleWordQuery

public Query setExactOnSingleWordQuery(String exactOnSingleWordQuery)

getAlternativesAsExact

public List<String> getAlternativesAsExact()

setAlternativesAsExact

public Query setAlternativesAsExact(List<String> alternativesAsExact)

getMinWordSizefor1Typo

public Integer getMinWordSizefor1Typo()

setMinWordSizefor1Typo

public Query setMinWordSizefor1Typo(Integer minWordSizefor1Typo)

getMinWordSizefor2Typos

public Integer getMinWordSizefor2Typos()

setMinWordSizefor2Typos

public Query setMinWordSizefor2Typos(Integer minWordSizefor2Typos)

getTypoTolerance

public Query.TypoTolerance getTypoTolerance()

setTypoTolerance

public Query setTypoTolerance(Query.TypoTolerance typoTolerance)

getAllowTyposOnNumericTokens

public Boolean getAllowTyposOnNumericTokens()

setAllowTyposOnNumericTokens

public Query setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

getIgnorePlurals

public IgnorePlurals getIgnorePlurals()

setIgnorePlurals

public Query setIgnorePlurals(IgnorePlurals ignorePlurals)

getDisableTypoToleranceOnAttributes

public List<String> getDisableTypoToleranceOnAttributes()

setDisableTypoToleranceOnAttributes

public Query setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

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

setUserToken

public Query setUserToken(String userToken)

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

setValidUntil

public Query setValidUntil(Integer validUntil)

getRestrictIndices

public List<String> getRestrictIndices()

setRestrictIndices

public Query setRestrictIndices(List<String> restrictIndices)

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

setRestrictSources

public Query setRestrictSources(String restrictSources)

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

setCursor

public Query setCursor(String cursor)

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

setEnableRules

public Query setEnableRules(Boolean enableRules)

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

setRuleContexts

public Query setRuleContexts(List<String> ruleContexts)

setQuery
```
public Query setQuery(String query)
```

getCustomParameters

public Map<String,String> getCustomParameters()

setCustomParameters

public Query setCustomParameters(Map<String,String> customParameters)

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

toString in class Object

Class Query

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

distinct

getRankingInfo

numericFilters

tagFilters

analytics

analyticsTags

synonyms

replaceSynonymsInHighlight

minProximity

responseFields

maxFacetHits

percentileComputation

attributesToRetrieve

restrictSearchableAttributes

filters

facets

maxValuesPerFacet

facetFilters

facetingAfterDistinct

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

customParameters

Constructor Detail

Query

Query

Method Detail

toParam

setAroundRadius

setAroundRadiusAll

addCustomParameter

getDistinct

setDistinct

getGetRankingInfo

setGetRankingInfo

getNumericFilters

setNumericFilters