Package com.algolia.api

Class PersonalizationClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.PersonalizationClient

public class PersonalizationClient
extends ApiClient

Field Summary

Fields inherited from class com.algolia.ApiClient

json

Constructor Summary

Constructors

Constructor	Description
PersonalizationClient(String appId, String apiKey, String region)
PersonalizationClient(String appId, String apiKey, String region, 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.
DeleteUserProfileResponse	deleteUserProfile(String userToken)	Delete the user profile and all its associated data.
DeleteUserProfileResponse	deleteUserProfile(String userToken, RequestOptions requestOptions)	Delete the user profile and all its associated data.
CompletableFuture<DeleteUserProfileResponse>	deleteUserProfileAsync(String userToken)	(asynchronously) Delete the user profile and all its associated data.
CompletableFuture<DeleteUserProfileResponse>	deleteUserProfileAsync(String userToken, RequestOptions requestOptions)	(asynchronously) Delete the user profile and all its associated data.
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.
PersonalizationStrategyParams	getPersonalizationStrategy()	The strategy contains information on the events and facets that impact user profiles and personalized search results.
PersonalizationStrategyParams	getPersonalizationStrategy(RequestOptions requestOptions)	The strategy contains information on the events and facets that impact user profiles and personalized search results.
CompletableFuture<PersonalizationStrategyParams>	getPersonalizationStrategyAsync()	(asynchronously) The strategy contains information on the events and facets that impact user profiles and personalized search results.
CompletableFuture<PersonalizationStrategyParams>	getPersonalizationStrategyAsync(RequestOptions requestOptions)	(asynchronously) The strategy contains information on the events and facets that impact user profiles and personalized search results.
GetUserTokenResponse	getUserTokenProfile(String userToken)	Get the user profile built from Personalization strategy.
GetUserTokenResponse	getUserTokenProfile(String userToken, RequestOptions requestOptions)	Get the user profile built from Personalization strategy.
CompletableFuture<GetUserTokenResponse>	getUserTokenProfileAsync(String userToken)	(asynchronously) Get the user profile built from Personalization strategy.
CompletableFuture<GetUserTokenResponse>	getUserTokenProfileAsync(String userToken, RequestOptions requestOptions)	(asynchronously) Get the user profile built from Personalization strategy.
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.
SetPersonalizationStrategyResponse	setPersonalizationStrategy(PersonalizationStrategyParams personalizationStrategyParams)	A strategy defines the events and facets that impact user profiles and personalized search results.
SetPersonalizationStrategyResponse	setPersonalizationStrategy(PersonalizationStrategyParams personalizationStrategyParams, RequestOptions requestOptions)	A strategy defines the events and facets that impact user profiles and personalized search results.
CompletableFuture<SetPersonalizationStrategyResponse>	setPersonalizationStrategyAsync(PersonalizationStrategyParams personalizationStrategyParams)	(asynchronously) A strategy defines the events and facets that impact user profiles and personalized search results.
CompletableFuture<SetPersonalizationStrategyResponse>	setPersonalizationStrategyAsync(PersonalizationStrategyParams personalizationStrategyParams, RequestOptions requestOptions)	(asynchronously) A strategy defines the events and facets that impact user profiles and personalized search results.

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

PersonalizationClient

public PersonalizationClient(String appId,
 String apiKey,
 String region)

PersonalizationClient

public PersonalizationClient(String appId,
 String apiKey,
 String region,
 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