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(ConfigurationWithIndex configurationWithIndex)	Creates a new Query Suggestions configuration.
BaseResponse	createConfig(ConfigurationWithIndex configurationWithIndex, RequestOptions requestOptions)	Creates a new Query Suggestions configuration.
CompletableFuture<BaseResponse>	createConfigAsync(ConfigurationWithIndex configurationWithIndex)	(asynchronously) Creates a new Query Suggestions configuration.
CompletableFuture<BaseResponse>	createConfigAsync(ConfigurationWithIndex configurationWithIndex, RequestOptions requestOptions)	(asynchronously) Creates 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)	Deletes a Query Suggestions configuration.
BaseResponse	deleteConfig(String indexName, RequestOptions requestOptions)	Deletes a Query Suggestions configuration.
CompletableFuture<BaseResponse>	deleteConfigAsync(String indexName)	(asynchronously) Deletes a Query Suggestions configuration.
CompletableFuture<BaseResponse>	deleteConfigAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Deletes a Query Suggestions configuration.
List<ConfigurationResponse>	getAllConfigs()	Retrieves all Query Suggestions configurations of your Algolia application.
List<ConfigurationResponse>	getAllConfigs(RequestOptions requestOptions)	Retrieves all Query Suggestions configurations of your Algolia application.
CompletableFuture<List<ConfigurationResponse>>	getAllConfigsAsync()	(asynchronously) Retrieves all Query Suggestions configurations of your Algolia application.
CompletableFuture<List<ConfigurationResponse>>	getAllConfigsAsync(RequestOptions requestOptions)	(asynchronously) Retrieves all Query Suggestions configurations of your Algolia application.
ConfigurationResponse	getConfig(String indexName)	Retrieves a single Query Suggestions configuration by its index name.
ConfigurationResponse	getConfig(String indexName, RequestOptions requestOptions)	Retrieves a single Query Suggestions configuration by its index name.
CompletableFuture<ConfigurationResponse>	getConfigAsync(String indexName)	(asynchronously) Retrieves a single Query Suggestions configuration by its index name.
CompletableFuture<ConfigurationResponse>	getConfigAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Retrieves a single Query Suggestions configuration by its index name.
ConfigStatus	getConfigStatus(String indexName)	Reports the status of a Query Suggestions index.
ConfigStatus	getConfigStatus(String indexName, RequestOptions requestOptions)	Reports the status of a Query Suggestions index.
CompletableFuture<ConfigStatus>	getConfigStatusAsync(String indexName)	(asynchronously) Reports the status of a Query Suggestions index.
CompletableFuture<ConfigStatus>	getConfigStatusAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Reports the status of a Query Suggestions index.
LogFile	getLogFile(String indexName)	Retrieves the logs for a single Query Suggestions index.
LogFile	getLogFile(String indexName, RequestOptions requestOptions)	Retrieves the logs for a single Query Suggestions index.
CompletableFuture<LogFile>	getLogFileAsync(String indexName)	(asynchronously) Retrieves the logs for a single Query Suggestions index.
CompletableFuture<LogFile>	getLogFileAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Retrieves the logs for a single Query Suggestions index.
BaseResponse	updateConfig(String indexName, Configuration configuration)	Updates a QuerySuggestions configuration.
BaseResponse	updateConfig(String indexName, Configuration configuration, RequestOptions requestOptions)	Updates a QuerySuggestions configuration.
CompletableFuture<BaseResponse>	updateConfigAsync(String indexName, Configuration configuration)	(asynchronously) Updates a QuerySuggestions configuration.
CompletableFuture<BaseResponse>	updateConfigAsync(String indexName, Configuration configuration, RequestOptions requestOptions)	(asynchronously) Updates a QuerySuggestions configuration.

Methods inherited from class com.algolia.ApiClient

close, executeAsync, executeAsync, setClientApiKey

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
 ConfigurationWithIndex configurationWithIndex,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

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

Parameters:

configurationWithIndex - (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
 ConfigurationWithIndex configurationWithIndex)
                          throws AlgoliaRuntimeException

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

Parameters:

configurationWithIndex - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createConfigAsync

public CompletableFuture<BaseResponse> createConfigAsync(@Nonnull
 ConfigurationWithIndex configurationWithIndex,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

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

Parameters:

configurationWithIndex - (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
 ConfigurationWithIndex configurationWithIndex)
                                                  throws AlgoliaRuntimeException

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

Parameters:

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

Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.

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

Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.

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) Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.

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) Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAllConfigs

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

Retrieves 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<ConfigurationResponse> getAllConfigs()
                                          throws AlgoliaRuntimeException

Retrieves all Query Suggestions configurations of your Algolia application.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAllConfigsAsync

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

(asynchronously) Retrieves 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<ConfigurationResponse>> getAllConfigsAsync()
                                                                  throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConfig

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

Retrieves a single Query Suggestions configuration by its index name.

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 ConfigurationResponse getConfig(@Nonnull
 String indexName)
                                throws AlgoliaRuntimeException

Retrieves a single Query Suggestions configuration by its index name.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConfigAsync

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

(asynchronously) Retrieves a single Query Suggestions configuration by its index name.

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<ConfigurationResponse> getConfigAsync(@Nonnull
 String indexName)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a single Query Suggestions configuration by its index name.

Parameters:

indexName - Query Suggestions index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConfigStatus

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

Reports 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 ConfigStatus getConfigStatus(@Nonnull
 String indexName)
                             throws AlgoliaRuntimeException

Reports 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<ConfigStatus> getConfigStatusAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) Reports 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<ConfigStatus> getConfigStatusAsync(@Nonnull
 String indexName)
                                                     throws AlgoliaRuntimeException

(asynchronously) Reports 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 LogFile getLogFile(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                   throws AlgoliaRuntimeException

Retrieves 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 LogFile getLogFile(@Nonnull
 String indexName)
                   throws AlgoliaRuntimeException

Retrieves 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<LogFile> getLogFileAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                           throws AlgoliaRuntimeException

(asynchronously) Retrieves 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<LogFile> getLogFileAsync(@Nonnull
 String indexName)
                                           throws AlgoliaRuntimeException

(asynchronously) Retrieves 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
 Configuration configuration,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

Updates a QuerySuggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

configuration - (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
 Configuration configuration)
                          throws AlgoliaRuntimeException

Updates a QuerySuggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

configuration - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateConfigAsync

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

(asynchronously) Updates a QuerySuggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

configuration - (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
 Configuration configuration)
                                                  throws AlgoliaRuntimeException

(asynchronously) Updates a QuerySuggestions configuration.

Parameters:

indexName - Query Suggestions index name. (required)

configuration - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call