Package com.algolia.api

Class AbtestingClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.AbtestingClient

public class AbtestingClient
extends ApiClient

Field Summary

Fields inherited from class com.algolia.ApiClient

json

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ABTestResponse	addABTests(AddABTestsRequest addABTestsRequest)	Creates an A/B test.
ABTestResponse	addABTests(AddABTestsRequest addABTestsRequest, RequestOptions requestOptions)	Creates an A/B test.
CompletableFuture<ABTestResponse>	addABTestsAsync(AddABTestsRequest addABTestsRequest)	(asynchronously) Creates an A/B test.
CompletableFuture<ABTestResponse>	addABTestsAsync(AddABTestsRequest addABTestsRequest, RequestOptions requestOptions)	(asynchronously) Creates an A/B test.
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.
ABTestResponse	deleteABTest(Integer id)	Delete an A/B test.
ABTestResponse	deleteABTest(Integer id, RequestOptions requestOptions)	Delete an A/B test.
CompletableFuture<ABTestResponse>	deleteABTestAsync(Integer id)	(asynchronously) Delete an A/B test.
CompletableFuture<ABTestResponse>	deleteABTestAsync(Integer id, RequestOptions requestOptions)	(asynchronously) Delete an A/B test.
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.
ABTest	getABTest(Integer id)	Get specific details for an A/B test.
ABTest	getABTest(Integer id, RequestOptions requestOptions)	Get specific details for an A/B test.
CompletableFuture<ABTest>	getABTestAsync(Integer id)	(asynchronously) Get specific details for an A/B test.
CompletableFuture<ABTest>	getABTestAsync(Integer id, RequestOptions requestOptions)	(asynchronously) Get specific details for an A/B test.
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.
ListABTestsResponse	listABTests()	List all A/B tests.
ListABTestsResponse	listABTests(RequestOptions requestOptions)	List all A/B tests.
ListABTestsResponse	listABTests(Integer offset, Integer limit, String indexPrefix, String indexSuffix)	List all A/B tests.
ListABTestsResponse	listABTests(Integer offset, Integer limit, String indexPrefix, String indexSuffix, RequestOptions requestOptions)	List all A/B tests.
CompletableFuture<ListABTestsResponse>	listABTestsAsync()	(asynchronously) List all A/B tests.
CompletableFuture<ListABTestsResponse>	listABTestsAsync(RequestOptions requestOptions)	(asynchronously) List all A/B tests.
CompletableFuture<ListABTestsResponse>	listABTestsAsync(Integer offset, Integer limit, String indexPrefix, String indexSuffix)	(asynchronously) List all A/B tests.
CompletableFuture<ListABTestsResponse>	listABTestsAsync(Integer offset, Integer limit, String indexPrefix, String indexSuffix, RequestOptions requestOptions)	(asynchronously) List all A/B tests.
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.
ABTestResponse	stopABTest(Integer id)	If stopped, the test is over and can't be restarted.
ABTestResponse	stopABTest(Integer id, RequestOptions requestOptions)	If stopped, the test is over and can't be restarted.
CompletableFuture<ABTestResponse>	stopABTestAsync(Integer id)	(asynchronously) If stopped, the test is over and can't be restarted.
CompletableFuture<ABTestResponse>	stopABTestAsync(Integer id, RequestOptions requestOptions)	(asynchronously) If stopped, the test is over and can't be restarted.

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

AbtestingClient

public AbtestingClient(String appId,
 String apiKey)

AbtestingClient

public AbtestingClient(String appId,
 String apiKey,
 ClientOptions options)

AbtestingClient

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

AbtestingClient

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

Method Details

addABTests

public ABTestResponse addABTests(AddABTestsRequest addABTestsRequest,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

Creates an A/B test.

Parameters:

addABTestsRequest - (required)

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

Returns:

ABTestResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addABTests

public ABTestResponse addABTests(AddABTestsRequest addABTestsRequest)
                          throws AlgoliaRuntimeException

Creates an A/B test.

Parameters:

addABTestsRequest - (required)

Returns:

ABTestResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addABTestsAsync

public CompletableFuture<ABTestResponse> addABTestsAsync(AddABTestsRequest addABTestsRequest,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

(asynchronously) Creates an A/B test.

Parameters:

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

addABTestsAsync

public CompletableFuture<ABTestResponse> addABTestsAsync(AddABTestsRequest addABTestsRequest)
                                                  throws AlgoliaRuntimeException

(asynchronously) Creates an A/B test.

Parameters:

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