Package com.algolia.api

Class QuerySuggestionsClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.QuerySuggestionsClient

public class QuerySuggestionsClient
extends ApiClient

Field Summary

Fields inherited from class com.algolia.ApiClient

json

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	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.
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.
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.
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.
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.
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.
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.
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

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

Methods inherited from class java.lang.Object

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

Constructor Details

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

Returns:

BaseResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createConfig

public BaseResponse createConfig(QuerySuggestionsConfigurationWithIndex querySuggestionsConfigurationWithIndex)
                          throws AlgoliaRuntimeException

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

Parameters:

querySuggestionsConfigurationWithIndex - (required)

Returns:

BaseResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createConfigAsync

public CompletableFuture<BaseResponse> createConfigAsync(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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createConfigAsync

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

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

Parameters:

querySuggestionsConfigurationWithIndex - (required)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

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

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

Parameters:

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

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

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

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

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

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

Parameters:

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

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

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

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

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

Parameters:

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

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

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(String path)
           throws AlgoliaRuntimeException

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

Parameters:

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

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

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

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

Parameters:

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

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

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

Returns:

CompletableFuture