Package io.constructor.client
Class RecommendationsRequest
java.lang.Object
io.constructor.client.RecommendationsRequest
Constructor.io Recommendations Request
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintgetPodId()getTerm()voidvoidsetFormatOptions(Map<String, String> formatOptions) voidsetHiddenFields(List<String> hiddenFields) voidsetItemIds(List<String> itemIds) voidsetNumResults(int numResults) voidvoidsetPreFilterExpression(String preFilterExpression) voidsetSection(String section) voidvoidsetVariationsMap(VariationsMap variationsMap)
-
Constructor Details
-
RecommendationsRequest
Creates a recommendations request- Parameters:
podId- the pod id to retrieve results from- Throws:
IllegalArgumentException
-
-
Method Details
-
setPodId
- Parameters:
podId- the pod id to set
-
getPodId
- Returns:
- the pod id
-
setTerm
- Parameters:
term- the term to set (required for query recommendations pods)
-
getTerm
- Returns:
- the term
-
setNumResults
public void setNumResults(int numResults) - Parameters:
numResults- the num results to set
-
getNumResults
public int getNumResults()- Returns:
- the num results
-
setItemIds
- Parameters:
itemIds- the item id's to set
-
getItemIds
- Returns:
- the item id's
-
setSection
- Parameters:
section- the section to set
-
getSection
- Returns:
- the section
-
setVariationsMap
- Parameters:
variationsMap- the variationsMap to set
-
getVariationsMap
- Returns:
- the variations map
-
setFacets
- Parameters:
facets- the facets to set
-
getFacets
- Returns:
- the facets
-
setPreFilterExpression
- Parameters:
preFilterExpression- the faceting expression to scope recommendation results (JSON-encoded query string). Please refer to https://docs.constructor.com/reference/shared-filter-expressions
-
getPreFilterExpression
- Returns:
- the prefilter expression
-
setFormatOptions
- Parameters:
formatOptions- the formatOptions to set. Please refer to https://docs.constructor.com/reference/v1-recommendations-get-pod-results for details
-
getFormatOptions
- Returns:
- the format options
-
setHiddenFields
- Parameters:
hiddenFields- the hiddenFields to set
-
getHiddenFields
- Returns:
- the hidden fields
-