Package com.algolia.search.models.rules

Class ConsequenceParams

java.lang.Object

com.algolia.search.models.indexing.SearchParameters<ConsequenceParams>

com.algolia.search.models.rules.ConsequenceParams

All Implemented Interfaces:

Serializable

public class ConsequenceParams
extends SearchParameters<ConsequenceParams>

Consequence parameter. More information:

See Also:

Algolia.com, Serialized Form

Field Summary

Fields inherited from class com.algolia.search.models.indexing.SearchParameters

advancedSyntax, advancedSyntaxFeatures, allowTyposOnNumericTokens, alternativesAsExact, analytics, analyticsTags, aroundLatLng, aroundLatLngViaIP, aroundPrecision, aroundRadius, attributesToHighlight, attributesToRetrieve, attributesToSnippet, clickAnalytics, customParameters, decompoundQuery, disableExactOnAttributes, disableTypoToleranceOnAttributes, distinct, enableABTest, enablePersonalization, enableReRanking, enableRules, exactOnSingleWordQuery, explain, facetFilters, facetingAfterDistinct, facets, filters, getRankingInfo, highlightPostTag, highlightPreTag, hitsPerPage, ignorePlurals, insideBoundingBox, insidePolygon, length, maxFacetHits, maxValuesPerFacet, minimumAroundRadius, minProximity, minWordSizefor1Typo, minWordSizefor2Typos, naturalLanguages, numericFilters, offset, optionalFilters, optionalWords, page, percentileComputation, personalizationImpact, queryLanguages, queryType, relevancyStrictness, removeStopWords, removeWordsIfNoResults, replaceSynonymsInHighlight, responseFields, restrictHighlightAndSnippetArrays, restrictIndices, restrictSearchableAttributes, restrictSources, ruleContexts, similarQuery, snippetEllipsisText, sortFacetValuesBy, sumOrFiltersScores, synonyms, tagFilters, typoTolerance, userToken, validUntil

Constructor Summary

Constructors

Constructor	Description
ConsequenceParams()

Method Summary

Modifier and Type	Method	Description
List<AutomaticFacetFilter>	getAutomaticFacetFilters()
List<AutomaticFacetFilter>	getAutomaticOptionalFacetFilters()
ConsequenceQuery	getConsequenceQuery()
String	getQuery()
RenderingContent	getRenderingContent()
ConsequenceParams	getThis()	To prevent unchecked cast warning.
ConsequenceParams	setAutomaticFacetFilters(List<AutomaticFacetFilter> automaticFacetFilters)
ConsequenceParams	setAutomaticOptionalFacetFilters(List<AutomaticFacetFilter> automaticOptionalFacetFilters)
ConsequenceParams	setConsequenceQuery(ConsequenceQuery consequenceQuery)	Providing a ConsequenceQuery will describe incremental edits to be made to the query.
ConsequenceParams	setQuery(String query)	When providing a string, it replaces the entire query string.
ConsequenceParams	setRenderingContent(RenderingContent renderingContent)

Methods inherited from class com.algolia.search.models.indexing.SearchParameters

getAdvancedSyntax, getAdvancedSyntaxFeatures, getAllowTyposOnNumericTokens, getAlternativesAsExact, getAnalytics, getAnalyticsTags, getAroundLatLng, getAroundLatLngViaIP, getAroundPrecision, getAroundRadius, getAttributesToHighlight, getAttributesToRetrieve, getAttributesToSnippet, getClickAnalytics, getCustomParameters, getDecompoundQuery, getDisableExactOnAttributes, getDisableTypoToleranceOnAttributes, getDistinct, getEnableABTest, getEnablePersonalization, getEnableReRanking, getEnableRules, getExactOnSingleWordQuery, getExplain, getFacetFilters, getFacetingAfterDistinct, getFacets, getFilters, getGetRankingInfo, getHighlightPostTag, getHighlightPreTag, getHitsPerPage, getIgnorePlurals, getInsideBoundingBox, getInsidePolygon, getLength, getMaxFacetHits, getMaxValuesPerFacet, getMinimumAroundRadius, getMinProximity, getMinWordSizefor1Typo, getMinWordSizefor2Typos, getNaturalLanguages, getNumericFilters, getOffset, getOptionalFilters, getOptionalWords, getPage, getPercentileComputation, getPersonalizationImpact, getQueryLanguages, getQueryType, getRelevancyStrictness, getRemoveStopWords, getRemoveWordsIfNoResults, getReplaceSynonymsInHighlight, getResponseFields, getRestrictHighlightAndSnippetArrays, getRestrictIndices, getRestrictSearchableAttributes, getRestrictSources, getRuleContexts, getSimilarQuery, getSnippetEllipsisText, getSortFacetValuesBy, getSumOrFiltersScores, getSynonyms, getTagFilters, getTypoTolerance, getUserToken, getValidUntil, setAdvancedSyntax, setAdvancedSyntaxFeatures, setAllowTyposOnNumericTokens, setAlternativesAsExact, setAnalytics, setAnalyticsTags, setAroundLatLng, setAroundLatLngViaIP, setAroundPrecision, setAroundRadius, setAttributesToHighlight, setAttributesToRetrieve, setAttributesToSnippet, setClickAnalytics, setCustomParameter, setCustomParameters, setDecompoundQuery, setDisableExactOnAttributes, setDisableTypoToleranceOnAttributes, setDistinct, setEnableABTest, setEnablePersonalization, setEnableReRanking, setEnableRules, setExactOnSingleWordQuery, setExplain, setFacetFilters, setFacetingAfterDistinct, setFacets, setFilters, setGetRankingInfo, setHighlightPostTag, setHighlightPreTag, setHitsPerPage, setIgnorePlurals, setInsideBoundingBox, setInsidePolygon, setLength, setMaxFacetHits, setMaxValuesPerFacet, setMinimumAroundRadius, setMinProximity, setMinWordSizefor1Typo, setMinWordSizefor2Typos, setNaturalLanguages, setNumericFilters, setOffset, setOptionalFilters, setOptionalWords, setPage, setPercentileComputation, setPersonalizationImpact, setQueryLanguages, setQueryType, setRelevancyStrictness, setRemoveStopWords, setRemoveWordsIfNoResults, setReplaceSynonymsInHighlight, setResponseFields, setRestrictHighlightAndSnippetArrays, setRestrictIndices, setRestrictSearchableAttributes, setRestrictSources, setRuleContexts, setSimilarQuery, setSnippetEllipsisText, setSortFacetValuesBy, setSumOrFiltersScores, setSynonyms, setTagFilters, setTypoTolerance, setUserToken, setValidUntil, toParam

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsequenceParams

public ConsequenceParams()

Method Detail

getConsequenceQuery

public ConsequenceQuery getConsequenceQuery()

setConsequenceQuery

public ConsequenceParams setConsequenceQuery(ConsequenceQuery consequenceQuery)

Providing a ConsequenceQuery will describe incremental edits to be made to the query.

Important NOTE: Setting a ConsequenceQuery will override regular "query" if set. Both can't be set at the same time.

getQuery

public String getQuery()

Overrides:

getQuery in class SearchParameters<ConsequenceParams>

setQuery

public ConsequenceParams setQuery(String query)

When providing a string, it replaces the entire query string.

Important NOTE: Setting a Query String will override any ConsequenceQuery set before. Both can't be set at the same time.

Overrides:

setQuery in class SearchParameters<ConsequenceParams>

getThis

public ConsequenceParams getThis()

Description copied from class: SearchParameters

To prevent unchecked cast warning.

Specified by:

getThis in class SearchParameters<ConsequenceParams>

getAutomaticFacetFilters

public List<AutomaticFacetFilter> getAutomaticFacetFilters()

setAutomaticFacetFilters

public ConsequenceParams setAutomaticFacetFilters(List<AutomaticFacetFilter> automaticFacetFilters)

getAutomaticOptionalFacetFilters

public List<AutomaticFacetFilter> getAutomaticOptionalFacetFilters()

setAutomaticOptionalFacetFilters

public ConsequenceParams setAutomaticOptionalFacetFilters(List<AutomaticFacetFilter> automaticOptionalFacetFilters)

getRenderingContent

public RenderingContent getRenderingContent()

setRenderingContent

public ConsequenceParams setRenderingContent(RenderingContent renderingContent)