Package com.algolia.api

Class QuerySuggestionsClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.QuerySuggestionsClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class QuerySuggestionsClient
extends ApiClient

Constructor Summary

Constructors

Constructor	Description
QuerySuggestionsClient(String appId, String apiKey, String region)
QuerySuggestionsClient(String appId, String apiKey, String region, ClientOptions options)

Method Summary

Modifier and Type	Method	Description
BaseResponse	createConfig(QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex)	Create a new Query Suggestions configuration.
BaseResponse	createConfig(QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex, RequestOptions requestOptions)	Create a new Query Suggestions configuration.
CompletableFuture<BaseResponse>	createConfigAsync(QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex)	(asynchronously) Create a new Query Suggestions configuration.
CompletableFuture<BaseResponse>	createConfigAsync(QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex, RequestOptions requestOptions)	(asynchronously) Create a new Query Suggestions configuration.
Object	customDelete(String path)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customGet(String path)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPost(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPut(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
BaseResponse	deleteConfig(String indexName)	Delete a Query Suggestions configuration.
BaseResponse	deleteConfig(String indexName, RequestOptions requestOptions)	Delete a Query Suggestions configuration.
CompletableFuture<BaseResponse>	deleteConfigAsync(String indexName)	(asynchronously) Delete a Query Suggestions configuration.
CompletableFuture<BaseResponse>	deleteConfigAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Delete a Query Suggestions configuration.
List<QuerySuggestionsConfigurationResponse>	getAllConfigs()	List all Query Suggestions configurations of your Algolia application.
List<QuerySuggestionsConfigurationResponse>	getAllConfigs(RequestOptions requestOptions)	List all Query Suggestions configurations of your Algolia application.
CompletableFuture<List<QuerySuggestionsConfigurationResponse>>	getAllConfigsAsync()	(asynchronously) List all Query Suggestions configurations of your Algolia application.
CompletableFuture<List<QuerySuggestionsConfigurationResponse>>	getAllConfigsAsync(RequestOptions requestOptions)	(asynchronously) List all Query Suggestions configurations of your Algolia application.
QuerySuggestionsConfigurationResponse	getConfig(String indexName)	Get a single Query Suggestions configuration.
QuerySuggestionsConfigurationResponse	getConfig(String indexName, RequestOptions requestOptions)	Get a single Query Suggestions configuration.
CompletableFuture<QuerySuggestionsConfigurationResponse>	getConfigAsync(String indexName)	(asynchronously) Get a single Query Suggestions configuration.
CompletableFuture<QuerySuggestionsConfigurationResponse>	getConfigAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Get a single Query Suggestions configuration.
GetConfigStatus200Response	getConfigStatus(String indexName)	Report the status of a Query Suggestions index.
GetConfigStatus200Response	getConfigStatus(String indexName, RequestOptions requestOptions)	Report the status of a Query Suggestions index.
CompletableFuture<GetConfigStatus200Response>	getConfigStatusAsync(String indexName)	(asynchronously) Report the status of a Query Suggestions index.
CompletableFuture<GetConfigStatus200Response>	getConfigStatusAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Report the status of a Query Suggestions index.
GetLogFile200Response	getLogFile(String indexName)	Get the logs for a single Query Suggestions index.
GetLogFile200Response	getLogFile(String indexName, RequestOptions requestOptions)	Get the logs for a single Query Suggestions index.
CompletableFuture<GetLogFile200Response>	getLogFileAsync(String indexName)	(asynchronously) Get the logs for a single Query Suggestions index.
CompletableFuture<GetLogFile200Response>	getLogFileAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Get the logs for a single Query Suggestions index.
BaseResponse	updateConfig(String indexName, QuerySuggestionsConfiguration querySuggestionsConfiguration)	Update a QuerySuggestions configuration.
BaseResponse	updateConfig(String indexName, QuerySuggestionsConfiguration querySuggestionsConfiguration, RequestOptions requestOptions)	Update a QuerySuggestions configuration.
CompletableFuture<BaseResponse>	updateConfigAsync(String indexName, QuerySuggestionsConfiguration querySuggestionsConfiguration)	(asynchronously) Update a QuerySuggestions configuration.
CompletableFuture<BaseResponse>	updateConfigAsync(String indexName, QuerySuggestionsConfiguration querySuggestionsConfiguration, RequestOptions requestOptions)	(asynchronously) Update a QuerySuggestions configuration.

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

QuerySuggestionsClient

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

QuerySuggestionsClient

public QuerySuggestionsClient(String appId,
 String apiKey,
 String region,
 ClientOptions options)

Method Details

createConfig

public BaseResponse createConfig(@Nonnull
 QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.

Parameters:

querySuggestionsConfigurationWithIndex - (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

createConfig

public BaseResponse createConfig(@Nonnull
 QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex)
                          throws AlgoliaRuntimeException

Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.

Parameters:

querySuggestionsConfigurationWithIndex - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createConfigAsync

public CompletableFuture<BaseResponse> createConfigAsync(@Nonnull
 QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

(asynchronously) Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.

Parameters:

querySuggestionsConfigurationWithIndex - (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

createConfigAsync

public CompletableFuture<BaseResponse> createConfigAsync(@Nonnull
 QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex)
                                                  throws AlgoliaRuntimeException

(asynchronously) Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.

Parameters:

querySuggestionsConfigurationWithIndex - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@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

customDelete

public Object customDelete(@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

customDelete

public Object customDelete(@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

customDelete

public Object customDelete(@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

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@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

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@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

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@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

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@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

customGet

public Object customGet(@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

customGet

public Object customGet(@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

customGet

public Object customGet(@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

customGet

public Object customGet(@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

customGetAsync

public CompletableFuture<Object> customGetAsync(@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

customGetAsync

public CompletableFuture<Object> customGetAsync(@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

customGetAsync

public CompletableFuture<Object> customGetAsync(@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

customGetAsync

public CompletableFuture<Object> customGetAsync(@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

customPost

public Object customPost(@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

customPost

public Object customPost(@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

customPost

public Object customPost(@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

customPost

public Object customPost(@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

customPostAsync

public CompletableFuture<Object> customPostAsync(@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

customPostAsync

public CompletableFuture<Object> customPostAsync(@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

customPostAsync

public CompletableFuture<Object> customPostAsync(@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

customPostAsync

public CompletableFuture<Object> customPostAsync(@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

customPut

public Object customPut(@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

customPut

public Object customPut(@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

customPut

public Object customPut(@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

customPut

public Object customPut(@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

customPutAsync

public CompletableFuture<Object> customPutAsync(@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

customPutAsync

public CompletableFuture<Object> customPutAsync(@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

customPutAsync

public CompletableFuture<Object> customPutAsync(@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

customPutAsync

public CompletableFuture<Object> customPutAsync(@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

deleteConfig

public BaseResponse deleteConfig(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.

Parameters:

indexName - Query Suggestions index name. (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

deleteConfig

public BaseResponse deleteConfig(@Nonnull
 String indexName)
                          throws AlgoliaRuntimeException

Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteConfigAsync

public CompletableFuture<BaseResponse> deleteConfigAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

(asynchronously) Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.

Parameters:

indexName - Query Suggestions index name. (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

deleteConfigAsync

public CompletableFuture<BaseResponse> deleteConfigAsync(@Nonnull
 String indexName)
                                                  throws AlgoliaRuntimeException

(asynchronously) Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAllConfigs

public List<QuerySuggestionsConfigurationResponse> getAllConfigs(RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

List all Query Suggestions configurations of your Algolia application.

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

getAllConfigs

public List<QuerySuggestionsConfigurationResponse> getAllConfigs()
                                                          throws AlgoliaRuntimeException

List all Query Suggestions configurations of your Algolia application.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAllConfigsAsync

public CompletableFuture<List<QuerySuggestionsConfigurationResponse>> getAllConfigsAsync(RequestOptions requestOptions)
                                                                                  throws AlgoliaRuntimeException

(asynchronously) List all Query Suggestions configurations of your Algolia application.

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

getAllConfigsAsync

public CompletableFuture<List<QuerySuggestionsConfigurationResponse>> getAllConfigsAsync()
                                                                                  throws AlgoliaRuntimeException

(asynchronously) List all Query Suggestions configurations of your Algolia application.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConfig

public QuerySuggestionsConfigurationResponse getConfig(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Get a single Query Suggestions configuration.

Parameters:

indexName - Query Suggestions index name. (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

getConfig

public QuerySuggestionsConfigurationResponse getConfig(@Nonnull
 String indexName)
                                                throws AlgoliaRuntimeException

Get a single Query Suggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConfigAsync

public CompletableFuture<QuerySuggestionsConfigurationResponse> getConfigAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Get a single Query Suggestions configuration.

Parameters:

indexName - Query Suggestions index name. (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

getConfigAsync

public CompletableFuture<QuerySuggestionsConfigurationResponse> getConfigAsync(@Nonnull
 String indexName)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Get a single Query Suggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConfigStatus

public GetConfigStatus200Response getConfigStatus(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                           throws AlgoliaRuntimeException

Report the status of a Query Suggestions index.

Parameters:

indexName - Query Suggestions index name. (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

getConfigStatus

public GetConfigStatus200Response getConfigStatus(@Nonnull
 String indexName)
                                           throws AlgoliaRuntimeException

Report the status of a Query Suggestions index.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConfigStatusAsync

public CompletableFuture<GetConfigStatus200Response> getConfigStatusAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                                   throws AlgoliaRuntimeException

(asynchronously) Report the status of a Query Suggestions index.

Parameters:

indexName - Query Suggestions index name. (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

getConfigStatusAsync

public CompletableFuture<GetConfigStatus200Response> getConfigStatusAsync(@Nonnull
 String indexName)
                                                                   throws AlgoliaRuntimeException

(asynchronously) Report the status of a Query Suggestions index.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogFile

public GetLogFile200Response getLogFile(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                 throws AlgoliaRuntimeException

Get the logs for a single Query Suggestions index.

Parameters:

indexName - Query Suggestions index name. (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

getLogFile

public GetLogFile200Response getLogFile(@Nonnull
 String indexName)
                                 throws AlgoliaRuntimeException

Get the logs for a single Query Suggestions index.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogFileAsync

public CompletableFuture<GetLogFile200Response> getLogFileAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                         throws AlgoliaRuntimeException

(asynchronously) Get the logs for a single Query Suggestions index.

Parameters:

indexName - Query Suggestions index name. (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

getLogFileAsync

public CompletableFuture<GetLogFile200Response> getLogFileAsync(@Nonnull
 String indexName)
                                                         throws AlgoliaRuntimeException

(asynchronously) Get the logs for a single Query Suggestions index.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateConfig

public BaseResponse updateConfig(@Nonnull
 String indexName,
 @Nonnull
 QuerySuggestionsConfiguration querySuggestionsConfiguration,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

Update a QuerySuggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

querySuggestionsConfiguration - (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

updateConfig

public BaseResponse updateConfig(@Nonnull
 String indexName,
 @Nonnull
 QuerySuggestionsConfiguration querySuggestionsConfiguration)
                          throws AlgoliaRuntimeException

Update a QuerySuggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

querySuggestionsConfiguration - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateConfigAsync

public CompletableFuture<BaseResponse> updateConfigAsync(@Nonnull
 String indexName,
 @Nonnull
 QuerySuggestionsConfiguration querySuggestionsConfiguration,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

(asynchronously) Update a QuerySuggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

querySuggestionsConfiguration - (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

updateConfigAsync

public CompletableFuture<BaseResponse> updateConfigAsync(@Nonnull
 String indexName,
 @Nonnull
 QuerySuggestionsConfiguration querySuggestionsConfiguration)
                                                  throws AlgoliaRuntimeException

(asynchronously) Update a QuerySuggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

querySuggestionsConfiguration - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call