Package com.algolia.api

Class AbtestingClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.AbtestingClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class AbtestingClient
extends ApiClient

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

close, executeAsync, executeAsync

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addABTests

public ABTestResponse addABTests(@Nonnull
 AddABTestsRequest addABTestsRequest)
                          throws AlgoliaRuntimeException

Creates an A/B test.

Parameters:

addABTestsRequest - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addABTestsAsync

public CompletableFuture<ABTestResponse> addABTestsAsync(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addABTestsAsync

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

(asynchronously) Creates an A/B test.

Parameters:

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

deleteABTest

public ABTestResponse deleteABTest(@Nonnull
 Integer id,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (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

deleteABTest

public ABTestResponse deleteABTest(@Nonnull
 Integer id)
                            throws AlgoliaRuntimeException

Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteABTestAsync

public CompletableFuture<ABTestResponse> deleteABTestAsync(@Nonnull
 Integer id,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (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

deleteABTestAsync

public CompletableFuture<ABTestResponse> deleteABTestAsync(@Nonnull
 Integer id)
                                                    throws AlgoliaRuntimeException

(asynchronously) Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getABTest

public ABTest getABTest(@Nonnull
 Integer id,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (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

getABTest

public ABTest getABTest(@Nonnull
 Integer id)
                 throws AlgoliaRuntimeException

Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getABTestAsync

public CompletableFuture<ABTest> getABTestAsync(@Nonnull
 Integer id,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (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

getABTestAsync

public CompletableFuture<ABTest> getABTestAsync(@Nonnull
 Integer id)
                                         throws AlgoliaRuntimeException

(asynchronously) Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listABTests

public ListABTestsResponse listABTests(Integer offset,
 Integer limit,
 String indexPrefix,
 String indexSuffix,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

List all A/B tests.

Parameters:

offset - Position of the first item to return. (optional, default to 0)

limit - Number of items to return. (optional, default to 10)

indexPrefix - Only return A/B tests for indices starting with this prefix. (optional)

indexSuffix - Only return A/B tests for indices ending with this suffix. (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

listABTests

public ListABTestsResponse listABTests(Integer offset,
 Integer limit,
 String indexPrefix,
 String indexSuffix)
                                throws AlgoliaRuntimeException

List all A/B tests.

Parameters:

offset - Position of the first item to return. (optional, default to 0)

limit - Number of items to return. (optional, default to 10)

indexPrefix - Only return A/B tests for indices starting with this prefix. (optional)

indexSuffix - Only return A/B tests for indices ending with this suffix. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listABTests

public ListABTestsResponse listABTests(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

List all A/B tests.

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

listABTests

public ListABTestsResponse listABTests()
                                throws AlgoliaRuntimeException

List all A/B tests.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listABTestsAsync

public CompletableFuture<ListABTestsResponse> listABTestsAsync(Integer offset,
 Integer limit,
 String indexPrefix,
 String indexSuffix,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) List all A/B tests.

Parameters:

offset - Position of the first item to return. (optional, default to 0)

limit - Number of items to return. (optional, default to 10)

indexPrefix - Only return A/B tests for indices starting with this prefix. (optional)

indexSuffix - Only return A/B tests for indices ending with this suffix. (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

listABTestsAsync

public CompletableFuture<ListABTestsResponse> listABTestsAsync(Integer offset,
 Integer limit,
 String indexPrefix,
 String indexSuffix)
                                                        throws AlgoliaRuntimeException

(asynchronously) List all A/B tests.

Parameters:

offset - Position of the first item to return. (optional, default to 0)

limit - Number of items to return. (optional, default to 10)

indexPrefix - Only return A/B tests for indices starting with this prefix. (optional)

indexSuffix - Only return A/B tests for indices ending with this suffix. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listABTestsAsync

public CompletableFuture<ListABTestsResponse> listABTestsAsync(RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) List all A/B tests.

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

listABTestsAsync

public CompletableFuture<ListABTestsResponse> listABTestsAsync()
                                                        throws AlgoliaRuntimeException

(asynchronously) List all A/B tests.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

stopABTest

public ABTestResponse stopABTest(@Nonnull
 Integer id,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (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

stopABTest

public ABTestResponse stopABTest(@Nonnull
 Integer id)
                          throws AlgoliaRuntimeException

If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

stopABTestAsync

public CompletableFuture<ABTestResponse> stopABTestAsync(@Nonnull
 Integer id,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

(asynchronously) If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (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

stopABTestAsync

public CompletableFuture<ABTestResponse> stopABTestAsync(@Nonnull
 Integer id)
                                                  throws AlgoliaRuntimeException

(asynchronously) If stopped, the test is over and can't be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).

Parameters:

id - Unique A/B test ID. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call