Package com.algolia.api

Class PersonalizationClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.PersonalizationClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class PersonalizationClient
extends ApiClient

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

close, executeAsync, executeAsync

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(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                   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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(@Nonnull
 String path,
 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)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(@Nonnull
 String path)
                                   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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteUserProfile

public DeleteUserProfileResponse deleteUserProfile(@Nonnull
 String userToken,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteUserProfile

public DeleteUserProfileResponse deleteUserProfile(@Nonnull
 String userToken)
                                            throws AlgoliaRuntimeException

Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteUserProfileAsync

public CompletableFuture<DeleteUserProfileResponse> deleteUserProfileAsync(@Nonnull
 String userToken,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteUserProfileAsync

public CompletableFuture<DeleteUserProfileResponse> deleteUserProfileAsync(@Nonnull
 String userToken)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

get

public Object get(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

get

public Object get(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

get

public Object get(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

get

public Object get(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAsync

public CompletableFuture<Object> getAsync(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAsync

public CompletableFuture<Object> getAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                   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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAsync

public CompletableFuture<Object> getAsync(@Nonnull
 String path,
 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)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAsync

public CompletableFuture<Object> getAsync(@Nonnull
 String path)
                                   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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPersonalizationStrategy

public PersonalizationStrategyParams getPersonalizationStrategy(RequestOptions requestOptions)
                                                         throws AlgoliaRuntimeException

The strategy contains information on the events and facets that impact user profiles and personalized search results.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPersonalizationStrategy

public PersonalizationStrategyParams getPersonalizationStrategy()
                                                         throws AlgoliaRuntimeException

The strategy contains information on the events and facets that impact user profiles and personalized search results.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPersonalizationStrategyAsync

public CompletableFuture<PersonalizationStrategyParams> getPersonalizationStrategyAsync(RequestOptions requestOptions)
                                                                                 throws AlgoliaRuntimeException

(asynchronously) The strategy contains information on the events and facets that impact user profiles and personalized search results.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPersonalizationStrategyAsync

public CompletableFuture<PersonalizationStrategyParams> getPersonalizationStrategyAsync()
                                                                                 throws AlgoliaRuntimeException

(asynchronously) The strategy contains information on the events and facets that impact user profiles and personalized search results.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserTokenProfile

public GetUserTokenResponse getUserTokenProfile(@Nonnull
 String userToken,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserTokenProfile

public GetUserTokenResponse getUserTokenProfile(@Nonnull
 String userToken)
                                         throws AlgoliaRuntimeException

Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserTokenProfileAsync

public CompletableFuture<GetUserTokenResponse> getUserTokenProfileAsync(@Nonnull
 String userToken,
 RequestOptions requestOptions)
                                                                 throws AlgoliaRuntimeException

(asynchronously) Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserTokenProfileAsync

public CompletableFuture<GetUserTokenResponse> getUserTokenProfileAsync(@Nonnull
 String userToken)
                                                                 throws AlgoliaRuntimeException

(asynchronously) Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

post

public Object post(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 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)

body - Parameters to send with the custom request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

post

public Object post(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
            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)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

post

public Object post(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

post

public Object post(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

postAsync

public CompletableFuture<Object> postAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 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)

body - Parameters to send with the custom request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

postAsync

public CompletableFuture<Object> postAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                    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)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

postAsync

public CompletableFuture<Object> postAsync(@Nonnull
 String path,
 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)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

postAsync

public CompletableFuture<Object> postAsync(@Nonnull
 String path)
                                    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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

put

public Object put(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 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)

body - Parameters to send with the custom request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

put

public Object put(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
           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)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

put

public Object put(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

put

public Object put(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

putAsync

public CompletableFuture<Object> putAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 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)

body - Parameters to send with the custom request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

putAsync

public CompletableFuture<Object> putAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                   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)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

putAsync

public CompletableFuture<Object> putAsync(@Nonnull
 String path,
 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)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

putAsync

public CompletableFuture<Object> putAsync(@Nonnull
 String path)
                                   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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setPersonalizationStrategy

public SetPersonalizationStrategyResponse setPersonalizationStrategy(@Nonnull
 PersonalizationStrategyParams personalizationStrategyParams,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

A strategy defines the events and facets that impact user profiles and personalized search results.

Parameters:

personalizationStrategyParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setPersonalizationStrategy

public SetPersonalizationStrategyResponse setPersonalizationStrategy(@Nonnull
 PersonalizationStrategyParams personalizationStrategyParams)
                                                              throws AlgoliaRuntimeException

A strategy defines the events and facets that impact user profiles and personalized search results.

Parameters:

personalizationStrategyParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setPersonalizationStrategyAsync

public CompletableFuture<SetPersonalizationStrategyResponse> setPersonalizationStrategyAsync(@Nonnull
 PersonalizationStrategyParams personalizationStrategyParams,
 RequestOptions requestOptions)
                                                                                      throws AlgoliaRuntimeException

(asynchronously) A strategy defines the events and facets that impact user profiles and personalized search results.

Parameters:

personalizationStrategyParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setPersonalizationStrategyAsync

public CompletableFuture<SetPersonalizationStrategyResponse> setPersonalizationStrategyAsync(@Nonnull
 PersonalizationStrategyParams personalizationStrategyParams)
                                                                                      throws AlgoliaRuntimeException

(asynchronously) A strategy defines the events and facets that impact user profiles and personalized search results.

Parameters:

personalizationStrategyParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call