Package com.algolia.api

Class RecommendClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.RecommendClient

public class RecommendClient
extends ApiClient

Field Summary

Fields inherited from class com.algolia.ApiClient

json

Constructor Summary

Constructors

Constructor	Description
RecommendClient(String appId, String apiKey)
RecommendClient(String appId, String apiKey, ClientOptions options)

Method Summary

Modifier and Type	Method	Description
Object	del(String path)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
DeletedAtResponse	deleteRecommendRule(String indexName, RecommendModels model, String objectID)	Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
DeletedAtResponse	deleteRecommendRule(String indexName, RecommendModels model, String objectID, RequestOptions requestOptions)	Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
CompletableFuture<DeletedAtResponse>	deleteRecommendRuleAsync(String indexName, RecommendModels model, String objectID)	(asynchronously) Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
CompletableFuture<DeletedAtResponse>	deleteRecommendRuleAsync(String indexName, RecommendModels model, String objectID, RequestOptions requestOptions)	(asynchronously) Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
Object	get(String path)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
GetRecommendationsResponse	getRecommendations(GetRecommendationsParams getRecommendationsParams)	Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
GetRecommendationsResponse	getRecommendations(GetRecommendationsParams getRecommendationsParams, RequestOptions requestOptions)	Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
CompletableFuture<GetRecommendationsResponse>	getRecommendationsAsync(GetRecommendationsParams getRecommendationsParams)	(asynchronously) Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
CompletableFuture<GetRecommendationsResponse>	getRecommendationsAsync(GetRecommendationsParams getRecommendationsParams, RequestOptions requestOptions)	(asynchronously) Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
RuleResponse	getRecommendRule(String indexName, RecommendModels model, String objectID)	Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
RuleResponse	getRecommendRule(String indexName, RecommendModels model, String objectID, RequestOptions requestOptions)	Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
CompletableFuture<RuleResponse>	getRecommendRuleAsync(String indexName, RecommendModels model, String objectID)	(asynchronously) Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
CompletableFuture<RuleResponse>	getRecommendRuleAsync(String indexName, RecommendModels model, String objectID, RequestOptions requestOptions)	(asynchronously) Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
GetRecommendTaskResponse	getRecommendStatus(String indexName, RecommendModels model, Long taskID)	Some operations, such as deleting a Recommend rule, will respond with a `taskID` value.
GetRecommendTaskResponse	getRecommendStatus(String indexName, RecommendModels model, Long taskID, RequestOptions requestOptions)	Some operations, such as deleting a Recommend rule, will respond with a `taskID` value.
CompletableFuture<GetRecommendTaskResponse>	getRecommendStatusAsync(String indexName, RecommendModels model, Long taskID)	(asynchronously) Some operations, such as deleting a Recommend rule, will respond with a `taskID` value.
CompletableFuture<GetRecommendTaskResponse>	getRecommendStatusAsync(String indexName, RecommendModels model, Long taskID, RequestOptions requestOptions)	(asynchronously) Some operations, such as deleting a Recommend rule, will respond with a `taskID` value.
Object	post(String path)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	put(String path)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
SearchRecommendRulesResponse	searchRecommendRules(String indexName, RecommendModels model)	List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
SearchRecommendRulesResponse	searchRecommendRules(String indexName, RecommendModels model, SearchRecommendRulesParams searchRecommendRulesParams)	List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
SearchRecommendRulesResponse	searchRecommendRules(String indexName, RecommendModels model, SearchRecommendRulesParams searchRecommendRulesParams, RequestOptions requestOptions)	List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
SearchRecommendRulesResponse	searchRecommendRules(String indexName, RecommendModels model, RequestOptions requestOptions)	List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
CompletableFuture<SearchRecommendRulesResponse>	searchRecommendRulesAsync(String indexName, RecommendModels model)	(asynchronously) List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
CompletableFuture<SearchRecommendRulesResponse>	searchRecommendRulesAsync(String indexName, RecommendModels model, SearchRecommendRulesParams searchRecommendRulesParams)	(asynchronously) List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
CompletableFuture<SearchRecommendRulesResponse>	searchRecommendRulesAsync(String indexName, RecommendModels model, SearchRecommendRulesParams searchRecommendRulesParams, RequestOptions requestOptions)	(asynchronously) List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
CompletableFuture<SearchRecommendRulesResponse>	searchRecommendRulesAsync(String indexName, RecommendModels model, RequestOptions requestOptions)	(asynchronously) List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).

Methods inherited from class com.algolia.ApiClient

addAlgoliaAgent, addDefaultHeader, buildCall, buildRequest, buildUrl, escapeString, executeAsync, executeAsync, executeAsync, getConnectTimeout, getReadTimeout, getWriteTimeout, isDebugging, parameterToString, processHeaderParams, removeAlgoliaAgent, serialize, setConnectTimeout, setHosts, setLogLevel, setReadTimeout, setWriteTimeout

Methods inherited from class java.lang.Object

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

Constructor Details

RecommendClient

public RecommendClient(String appId,
 String apiKey)

RecommendClient

public RecommendClient(String appId,
 String apiKey,
 ClientOptions options)

Method Details

del

public Object del(String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(String path,
 Map<String,Object> parameters)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(String path,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(String path)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Returns:

CompletableFuture