Package com.algolia.api

Class IngestionClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.IngestionClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class IngestionClient
extends ApiClient

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AuthenticationCreateResponse	createAuthentication(AuthenticationCreate authenticationCreate)	Creates a new authentication resource.
AuthenticationCreateResponse	createAuthentication(AuthenticationCreate authenticationCreate, RequestOptions requestOptions)	Creates a new authentication resource.
CompletableFuture<AuthenticationCreateResponse>	createAuthenticationAsync(AuthenticationCreate authenticationCreate)	(asynchronously) Creates a new authentication resource.
CompletableFuture<AuthenticationCreateResponse>	createAuthenticationAsync(AuthenticationCreate authenticationCreate, RequestOptions requestOptions)	(asynchronously) Creates a new authentication resource.
DestinationCreateResponse	createDestination(DestinationCreate destinationCreate)	Creates a new destination.
DestinationCreateResponse	createDestination(DestinationCreate destinationCreate, RequestOptions requestOptions)	Creates a new destination.
CompletableFuture<DestinationCreateResponse>	createDestinationAsync(DestinationCreate destinationCreate)	(asynchronously) Creates a new destination.
CompletableFuture<DestinationCreateResponse>	createDestinationAsync(DestinationCreate destinationCreate, RequestOptions requestOptions)	(asynchronously) Creates a new destination.
SourceCreateResponse	createSource(SourceCreate sourceCreate)	Creates a new source.
SourceCreateResponse	createSource(SourceCreate sourceCreate, RequestOptions requestOptions)	Creates a new source.
CompletableFuture<SourceCreateResponse>	createSourceAsync(SourceCreate sourceCreate)	(asynchronously) Creates a new source.
CompletableFuture<SourceCreateResponse>	createSourceAsync(SourceCreate sourceCreate, RequestOptions requestOptions)	(asynchronously) Creates a new source.
TaskCreateResponse	createTask(TaskCreate taskCreate)	Creates a new task.
TaskCreateResponse	createTask(TaskCreate taskCreate, RequestOptions requestOptions)	Creates a new task.
CompletableFuture<TaskCreateResponse>	createTaskAsync(TaskCreate taskCreate)	(asynchronously) Creates a new task.
CompletableFuture<TaskCreateResponse>	createTaskAsync(TaskCreate taskCreate, RequestOptions requestOptions)	(asynchronously) Creates a new task.
TaskCreateResponse	createTaskV1(TaskCreateV1 taskCreate)	Creates a new task using the v1 endpoint, please use `createTask` instead.
TaskCreateResponse	createTaskV1(TaskCreateV1 taskCreate, RequestOptions requestOptions)	Creates a new task using the v1 endpoint, please use `createTask` instead.
CompletableFuture<TaskCreateResponse>	createTaskV1Async(TaskCreateV1 taskCreate)	(asynchronously) Creates a new task using the v1 endpoint, please use `createTask` instead.
CompletableFuture<TaskCreateResponse>	createTaskV1Async(TaskCreateV1 taskCreate, RequestOptions requestOptions)	(asynchronously) Creates a new task using the v1 endpoint, please use `createTask` instead.
TransformationCreateResponse	createTransformation(TransformationCreate transformationCreate)	Creates a new transformation.
TransformationCreateResponse	createTransformation(TransformationCreate transformationCreate, RequestOptions requestOptions)	Creates a new transformation.
CompletableFuture<TransformationCreateResponse>	createTransformationAsync(TransformationCreate transformationCreate)	(asynchronously) Creates a new transformation.
CompletableFuture<TransformationCreateResponse>	createTransformationAsync(TransformationCreate transformationCreate, RequestOptions requestOptions)	(asynchronously) Creates a new transformation.
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.
DeleteResponse	deleteAuthentication(String authenticationID)	Deletes an authentication resource.
DeleteResponse	deleteAuthentication(String authenticationID, RequestOptions requestOptions)	Deletes an authentication resource.
CompletableFuture<DeleteResponse>	deleteAuthenticationAsync(String authenticationID)	(asynchronously) Deletes an authentication resource.
CompletableFuture<DeleteResponse>	deleteAuthenticationAsync(String authenticationID, RequestOptions requestOptions)	(asynchronously) Deletes an authentication resource.
DeleteResponse	deleteDestination(String destinationID)	Deletes a destination by its ID.
DeleteResponse	deleteDestination(String destinationID, RequestOptions requestOptions)	Deletes a destination by its ID.
CompletableFuture<DeleteResponse>	deleteDestinationAsync(String destinationID)	(asynchronously) Deletes a destination by its ID.
CompletableFuture<DeleteResponse>	deleteDestinationAsync(String destinationID, RequestOptions requestOptions)	(asynchronously) Deletes a destination by its ID.
DeleteResponse	deleteSource(String sourceID)	Deletes a source by its ID.
DeleteResponse	deleteSource(String sourceID, RequestOptions requestOptions)	Deletes a source by its ID.
CompletableFuture<DeleteResponse>	deleteSourceAsync(String sourceID)	(asynchronously) Deletes a source by its ID.
CompletableFuture<DeleteResponse>	deleteSourceAsync(String sourceID, RequestOptions requestOptions)	(asynchronously) Deletes a source by its ID.
DeleteResponse	deleteTask(String taskID)	Deletes a task by its ID.
DeleteResponse	deleteTask(String taskID, RequestOptions requestOptions)	Deletes a task by its ID.
CompletableFuture<DeleteResponse>	deleteTaskAsync(String taskID)	(asynchronously) Deletes a task by its ID.
CompletableFuture<DeleteResponse>	deleteTaskAsync(String taskID, RequestOptions requestOptions)	(asynchronously) Deletes a task by its ID.
DeleteResponse	deleteTaskV1(String taskID)	Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
DeleteResponse	deleteTaskV1(String taskID, RequestOptions requestOptions)	Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
CompletableFuture<DeleteResponse>	deleteTaskV1Async(String taskID)	(asynchronously) Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
CompletableFuture<DeleteResponse>	deleteTaskV1Async(String taskID, RequestOptions requestOptions)	(asynchronously) Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
DeleteResponse	deleteTransformation(String transformationID)	Deletes a transformation by its ID.
DeleteResponse	deleteTransformation(String transformationID, RequestOptions requestOptions)	Deletes a transformation by its ID.
CompletableFuture<DeleteResponse>	deleteTransformationAsync(String transformationID)	(asynchronously) Deletes a transformation by its ID.
CompletableFuture<DeleteResponse>	deleteTransformationAsync(String transformationID, RequestOptions requestOptions)	(asynchronously) Deletes a transformation by its ID.
TaskUpdateResponse	disableTask(String taskID)	Disables a task.
TaskUpdateResponse	disableTask(String taskID, RequestOptions requestOptions)	Disables a task.
CompletableFuture<TaskUpdateResponse>	disableTaskAsync(String taskID)	(asynchronously) Disables a task.
CompletableFuture<TaskUpdateResponse>	disableTaskAsync(String taskID, RequestOptions requestOptions)	(asynchronously) Disables a task.
TaskUpdateResponse	disableTaskV1(String taskID)	Deprecated.
TaskUpdateResponse	disableTaskV1(String taskID, RequestOptions requestOptions)	Deprecated.
CompletableFuture<TaskUpdateResponse>	disableTaskV1Async(String taskID)	Deprecated.
CompletableFuture<TaskUpdateResponse>	disableTaskV1Async(String taskID, RequestOptions requestOptions)	Deprecated.
TaskUpdateResponse	enableTask(String taskID)	Enables a task.
TaskUpdateResponse	enableTask(String taskID, RequestOptions requestOptions)	Enables a task.
CompletableFuture<TaskUpdateResponse>	enableTaskAsync(String taskID)	(asynchronously) Enables a task.
CompletableFuture<TaskUpdateResponse>	enableTaskAsync(String taskID, RequestOptions requestOptions)	(asynchronously) Enables a task.
TaskUpdateResponse	enableTaskV1(String taskID)	Enables a task using the v1 endpoint, please use `enableTask` instead.
TaskUpdateResponse	enableTaskV1(String taskID, RequestOptions requestOptions)	Enables a task using the v1 endpoint, please use `enableTask` instead.
CompletableFuture<TaskUpdateResponse>	enableTaskV1Async(String taskID)	(asynchronously) Enables a task using the v1 endpoint, please use `enableTask` instead.
CompletableFuture<TaskUpdateResponse>	enableTaskV1Async(String taskID, RequestOptions requestOptions)	(asynchronously) Enables a task using the v1 endpoint, please use `enableTask` instead.
Authentication	getAuthentication(String authenticationID)	Retrieves an authentication resource by its ID.
Authentication	getAuthentication(String authenticationID, RequestOptions requestOptions)	Retrieves an authentication resource by its ID.
CompletableFuture<Authentication>	getAuthenticationAsync(String authenticationID)	(asynchronously) Retrieves an authentication resource by its ID.
CompletableFuture<Authentication>	getAuthenticationAsync(String authenticationID, RequestOptions requestOptions)	(asynchronously) Retrieves an authentication resource by its ID.
Destination	getDestination(String destinationID)	Retrieves a destination by its ID.
Destination	getDestination(String destinationID, RequestOptions requestOptions)	Retrieves a destination by its ID.
CompletableFuture<Destination>	getDestinationAsync(String destinationID)	(asynchronously) Retrieves a destination by its ID.
CompletableFuture<Destination>	getDestinationAsync(String destinationID, RequestOptions requestOptions)	(asynchronously) Retrieves a destination by its ID.
Event	getEvent(String runID, String eventID)	Retrieves a single task run event by its ID.
Event	getEvent(String runID, String eventID, RequestOptions requestOptions)	Retrieves a single task run event by its ID.
CompletableFuture<Event>	getEventAsync(String runID, String eventID)	(asynchronously) Retrieves a single task run event by its ID.
CompletableFuture<Event>	getEventAsync(String runID, String eventID, RequestOptions requestOptions)	(asynchronously) Retrieves a single task run event by its ID.
Run	getRun(String runID)	Retrieve a single task run by its ID.
Run	getRun(String runID, RequestOptions requestOptions)	Retrieve a single task run by its ID.
CompletableFuture<Run>	getRunAsync(String runID)	(asynchronously) Retrieve a single task run by its ID.
CompletableFuture<Run>	getRunAsync(String runID, RequestOptions requestOptions)	(asynchronously) Retrieve a single task run by its ID.
Source	getSource(String sourceID)	Retrieve a source by its ID.
Source	getSource(String sourceID, RequestOptions requestOptions)	Retrieve a source by its ID.
CompletableFuture<Source>	getSourceAsync(String sourceID)	(asynchronously) Retrieve a source by its ID.
CompletableFuture<Source>	getSourceAsync(String sourceID, RequestOptions requestOptions)	(asynchronously) Retrieve a source by its ID.
Task	getTask(String taskID)	Retrieves a task by its ID.
Task	getTask(String taskID, RequestOptions requestOptions)	Retrieves a task by its ID.
CompletableFuture<Task>	getTaskAsync(String taskID)	(asynchronously) Retrieves a task by its ID.
CompletableFuture<Task>	getTaskAsync(String taskID, RequestOptions requestOptions)	(asynchronously) Retrieves a task by its ID.
TaskV1	getTaskV1(String taskID)	Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
TaskV1	getTaskV1(String taskID, RequestOptions requestOptions)	Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
CompletableFuture<TaskV1>	getTaskV1Async(String taskID)	(asynchronously) Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
CompletableFuture<TaskV1>	getTaskV1Async(String taskID, RequestOptions requestOptions)	(asynchronously) Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
Transformation	getTransformation(String transformationID)	Retrieves a transformation by its ID.
Transformation	getTransformation(String transformationID, RequestOptions requestOptions)	Retrieves a transformation by its ID.
CompletableFuture<Transformation>	getTransformationAsync(String transformationID)	(asynchronously) Retrieves a transformation by its ID.
CompletableFuture<Transformation>	getTransformationAsync(String transformationID, RequestOptions requestOptions)	(asynchronously) Retrieves a transformation by its ID.
ListAuthenticationsResponse	listAuthentications()	Retrieves a list of all authentication resources.
ListAuthenticationsResponse	listAuthentications(RequestOptions requestOptions)	Retrieves a list of all authentication resources.
ListAuthenticationsResponse	listAuthentications(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order)	Retrieves a list of all authentication resources.
ListAuthenticationsResponse	listAuthentications(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	Retrieves a list of all authentication resources.
CompletableFuture<ListAuthenticationsResponse>	listAuthenticationsAsync()	(asynchronously) Retrieves a list of all authentication resources.
CompletableFuture<ListAuthenticationsResponse>	listAuthenticationsAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of all authentication resources.
CompletableFuture<ListAuthenticationsResponse>	listAuthenticationsAsync(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of all authentication resources.
CompletableFuture<ListAuthenticationsResponse>	listAuthenticationsAsync(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of all authentication resources.
ListDestinationsResponse	listDestinations()	Retrieves a list of destinations.
ListDestinationsResponse	listDestinations(RequestOptions requestOptions)	Retrieves a list of destinations.
ListDestinationsResponse	listDestinations(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, String transformationID, DestinationSortKeys sort, OrderKeys order)	Retrieves a list of destinations.
ListDestinationsResponse	listDestinations(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, String transformationID, DestinationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	Retrieves a list of destinations.
CompletableFuture<ListDestinationsResponse>	listDestinationsAsync()	(asynchronously) Retrieves a list of destinations.
CompletableFuture<ListDestinationsResponse>	listDestinationsAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of destinations.
CompletableFuture<ListDestinationsResponse>	listDestinationsAsync(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, String transformationID, DestinationSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of destinations.
CompletableFuture<ListDestinationsResponse>	listDestinationsAsync(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, String transformationID, DestinationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of destinations.
ListEventsResponse	listEvents(String runID)	Retrieves a list of events for a task run, identified by its ID.
ListEventsResponse	listEvents(String runID, RequestOptions requestOptions)	Retrieves a list of events for a task run, identified by its ID.
ListEventsResponse	listEvents(String runID, Integer itemsPerPage, Integer page, List<EventStatus> status, List<EventType> type, EventSortKeys sort, OrderKeys order, String startDate, String endDate)	Retrieves a list of events for a task run, identified by its ID.
ListEventsResponse	listEvents(String runID, Integer itemsPerPage, Integer page, List<EventStatus> status, List<EventType> type, EventSortKeys sort, OrderKeys order, String startDate, String endDate, RequestOptions requestOptions)	Retrieves a list of events for a task run, identified by its ID.
CompletableFuture<ListEventsResponse>	listEventsAsync(String runID)	(asynchronously) Retrieves a list of events for a task run, identified by its ID.
CompletableFuture<ListEventsResponse>	listEventsAsync(String runID, RequestOptions requestOptions)	(asynchronously) Retrieves a list of events for a task run, identified by its ID.
CompletableFuture<ListEventsResponse>	listEventsAsync(String runID, Integer itemsPerPage, Integer page, List<EventStatus> status, List<EventType> type, EventSortKeys sort, OrderKeys order, String startDate, String endDate)	(asynchronously) Retrieves a list of events for a task run, identified by its ID.
CompletableFuture<ListEventsResponse>	listEventsAsync(String runID, Integer itemsPerPage, Integer page, List<EventStatus> status, List<EventType> type, EventSortKeys sort, OrderKeys order, String startDate, String endDate, RequestOptions requestOptions)	(asynchronously) Retrieves a list of events for a task run, identified by its ID.
RunListResponse	listRuns()	Retrieve a list of task runs.
RunListResponse	listRuns(RequestOptions requestOptions)	Retrieve a list of task runs.
RunListResponse	listRuns(Integer itemsPerPage, Integer page, List<RunStatus> status, List<RunType> type, String taskID, RunSortKeys sort, OrderKeys order, String startDate, String endDate)	Retrieve a list of task runs.
RunListResponse	listRuns(Integer itemsPerPage, Integer page, List<RunStatus> status, List<RunType> type, String taskID, RunSortKeys sort, OrderKeys order, String startDate, String endDate, RequestOptions requestOptions)	Retrieve a list of task runs.
CompletableFuture<RunListResponse>	listRunsAsync()	(asynchronously) Retrieve a list of task runs.
CompletableFuture<RunListResponse>	listRunsAsync(RequestOptions requestOptions)	(asynchronously) Retrieve a list of task runs.
CompletableFuture<RunListResponse>	listRunsAsync(Integer itemsPerPage, Integer page, List<RunStatus> status, List<RunType> type, String taskID, RunSortKeys sort, OrderKeys order, String startDate, String endDate)	(asynchronously) Retrieve a list of task runs.
CompletableFuture<RunListResponse>	listRunsAsync(Integer itemsPerPage, Integer page, List<RunStatus> status, List<RunType> type, String taskID, RunSortKeys sort, OrderKeys order, String startDate, String endDate, RequestOptions requestOptions)	(asynchronously) Retrieve a list of task runs.
ListSourcesResponse	listSources()	Retrieves a list of sources.
ListSourcesResponse	listSources(RequestOptions requestOptions)	Retrieves a list of sources.
ListSourcesResponse	listSources(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order)	Retrieves a list of sources.
ListSourcesResponse	listSources(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order, RequestOptions requestOptions)	Retrieves a list of sources.
CompletableFuture<ListSourcesResponse>	listSourcesAsync()	(asynchronously) Retrieves a list of sources.
CompletableFuture<ListSourcesResponse>	listSourcesAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of sources.
CompletableFuture<ListSourcesResponse>	listSourcesAsync(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of sources.
CompletableFuture<ListSourcesResponse>	listSourcesAsync(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of sources.
ListTasksResponse	listTasks()	Retrieves a list of tasks.
ListTasksResponse	listTasks(RequestOptions requestOptions)	Retrieves a list of tasks.
ListTasksResponse	listTasks(Integer itemsPerPage, Integer page, List<ActionType> action, Boolean enabled, List<String> sourceID, List<SourceType> sourceType, List<String> destinationID, List<TriggerType> triggerType, TaskSortKeys sort, OrderKeys order)	Retrieves a list of tasks.
ListTasksResponse	listTasks(Integer itemsPerPage, Integer page, List<ActionType> action, Boolean enabled, List<String> sourceID, List<SourceType> sourceType, List<String> destinationID, List<TriggerType> triggerType, TaskSortKeys sort, OrderKeys order, RequestOptions requestOptions)	Retrieves a list of tasks.
CompletableFuture<ListTasksResponse>	listTasksAsync()	(asynchronously) Retrieves a list of tasks.
CompletableFuture<ListTasksResponse>	listTasksAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of tasks.
CompletableFuture<ListTasksResponse>	listTasksAsync(Integer itemsPerPage, Integer page, List<ActionType> action, Boolean enabled, List<String> sourceID, List<SourceType> sourceType, List<String> destinationID, List<TriggerType> triggerType, TaskSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of tasks.
CompletableFuture<ListTasksResponse>	listTasksAsync(Integer itemsPerPage, Integer page, List<ActionType> action, Boolean enabled, List<String> sourceID, List<SourceType> sourceType, List<String> destinationID, List<TriggerType> triggerType, TaskSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of tasks.
ListTasksResponseV1	listTasksV1()	Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
ListTasksResponseV1	listTasksV1(RequestOptions requestOptions)	Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
ListTasksResponseV1	listTasksV1(Integer itemsPerPage, Integer page, List<ActionType> action, Boolean enabled, List<String> sourceID, List<String> destinationID, List<TriggerType> triggerType, TaskSortKeys sort, OrderKeys order)	Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
ListTasksResponseV1	listTasksV1(Integer itemsPerPage, Integer page, List<ActionType> action, Boolean enabled, List<String> sourceID, List<String> destinationID, List<TriggerType> triggerType, TaskSortKeys sort, OrderKeys order, RequestOptions requestOptions)	Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
CompletableFuture<ListTasksResponseV1>	listTasksV1Async()	(asynchronously) Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
CompletableFuture<ListTasksResponseV1>	listTasksV1Async(RequestOptions requestOptions)	(asynchronously) Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
CompletableFuture<ListTasksResponseV1>	listTasksV1Async(Integer itemsPerPage, Integer page, List<ActionType> action, Boolean enabled, List<String> sourceID, List<String> destinationID, List<TriggerType> triggerType, TaskSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
CompletableFuture<ListTasksResponseV1>	listTasksV1Async(Integer itemsPerPage, Integer page, List<ActionType> action, Boolean enabled, List<String> sourceID, List<String> destinationID, List<TriggerType> triggerType, TaskSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
ListTransformationsResponse	listTransformations()	Retrieves a list of transformations.
ListTransformationsResponse	listTransformations(RequestOptions requestOptions)	Retrieves a list of transformations.
ListTransformationsResponse	listTransformations(Integer itemsPerPage, Integer page, TransformationSortKeys sort, OrderKeys order)	Retrieves a list of transformations.
ListTransformationsResponse	listTransformations(Integer itemsPerPage, Integer page, TransformationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	Retrieves a list of transformations.
CompletableFuture<ListTransformationsResponse>	listTransformationsAsync()	(asynchronously) Retrieves a list of transformations.
CompletableFuture<ListTransformationsResponse>	listTransformationsAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of transformations.
CompletableFuture<ListTransformationsResponse>	listTransformationsAsync(Integer itemsPerPage, Integer page, TransformationSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of transformations.
CompletableFuture<ListTransformationsResponse>	listTransformationsAsync(Integer itemsPerPage, Integer page, TransformationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of transformations.
RunResponse	pushTask(String taskID, PushTaskPayload pushTaskPayload)	Push a `batch` request payload through the Pipeline.
RunResponse	pushTask(String taskID, PushTaskPayload pushTaskPayload, RequestOptions requestOptions)	Push a `batch` request payload through the Pipeline.
CompletableFuture<RunResponse>	pushTaskAsync(String taskID, PushTaskPayload pushTaskPayload)	(asynchronously) Push a `batch` request payload through the Pipeline.
CompletableFuture<RunResponse>	pushTaskAsync(String taskID, PushTaskPayload pushTaskPayload, RequestOptions requestOptions)	(asynchronously) Push a `batch` request payload through the Pipeline.
RunSourceResponse	runSource(String sourceID)	Runs all tasks linked to a source, only available for Shopify sources.
RunSourceResponse	runSource(String sourceID, RequestOptions requestOptions)	Runs all tasks linked to a source, only available for Shopify sources.
RunSourceResponse	runSource(String sourceID, RunSourcePayload runSourcePayload)	Runs all tasks linked to a source, only available for Shopify sources.
RunSourceResponse	runSource(String sourceID, RunSourcePayload runSourcePayload, RequestOptions requestOptions)	Runs all tasks linked to a source, only available for Shopify sources.
CompletableFuture<RunSourceResponse>	runSourceAsync(String sourceID)	(asynchronously) Runs all tasks linked to a source, only available for Shopify sources.
CompletableFuture<RunSourceResponse>	runSourceAsync(String sourceID, RequestOptions requestOptions)	(asynchronously) Runs all tasks linked to a source, only available for Shopify sources.
CompletableFuture<RunSourceResponse>	runSourceAsync(String sourceID, RunSourcePayload runSourcePayload)	(asynchronously) Runs all tasks linked to a source, only available for Shopify sources.
CompletableFuture<RunSourceResponse>	runSourceAsync(String sourceID, RunSourcePayload runSourcePayload, RequestOptions requestOptions)	(asynchronously) Runs all tasks linked to a source, only available for Shopify sources.
RunResponse	runTask(String taskID)	Runs a task.
RunResponse	runTask(String taskID, RequestOptions requestOptions)	Runs a task.
CompletableFuture<RunResponse>	runTaskAsync(String taskID)	(asynchronously) Runs a task.
CompletableFuture<RunResponse>	runTaskAsync(String taskID, RequestOptions requestOptions)	(asynchronously) Runs a task.
RunResponse	runTaskV1(String taskID)	Runs a task using the v1 endpoint, please use `runTask` instead.
RunResponse	runTaskV1(String taskID, RequestOptions requestOptions)	Runs a task using the v1 endpoint, please use `runTask` instead.
CompletableFuture<RunResponse>	runTaskV1Async(String taskID)	(asynchronously) Runs a task using the v1 endpoint, please use `runTask` instead.
CompletableFuture<RunResponse>	runTaskV1Async(String taskID, RequestOptions requestOptions)	(asynchronously) Runs a task using the v1 endpoint, please use `runTask` instead.
List<Authentication>	searchAuthentications(AuthenticationSearch authenticationSearch)	Searches for authentication resources.
List<Authentication>	searchAuthentications(AuthenticationSearch authenticationSearch, RequestOptions requestOptions)	Searches for authentication resources.
CompletableFuture<List<Authentication>>	searchAuthenticationsAsync(AuthenticationSearch authenticationSearch)	(asynchronously) Searches for authentication resources.
CompletableFuture<List<Authentication>>	searchAuthenticationsAsync(AuthenticationSearch authenticationSearch, RequestOptions requestOptions)	(asynchronously) Searches for authentication resources.
List<Destination>	searchDestinations(DestinationSearch destinationSearch)	Searches for destinations.
List<Destination>	searchDestinations(DestinationSearch destinationSearch, RequestOptions requestOptions)	Searches for destinations.
CompletableFuture<List<Destination>>	searchDestinationsAsync(DestinationSearch destinationSearch)	(asynchronously) Searches for destinations.
CompletableFuture<List<Destination>>	searchDestinationsAsync(DestinationSearch destinationSearch, RequestOptions requestOptions)	(asynchronously) Searches for destinations.
List<Source>	searchSources(SourceSearch sourceSearch)	Searches for sources.
List<Source>	searchSources(SourceSearch sourceSearch, RequestOptions requestOptions)	Searches for sources.
CompletableFuture<List<Source>>	searchSourcesAsync(SourceSearch sourceSearch)	(asynchronously) Searches for sources.
CompletableFuture<List<Source>>	searchSourcesAsync(SourceSearch sourceSearch, RequestOptions requestOptions)	(asynchronously) Searches for sources.
List<Task>	searchTasks(TaskSearch taskSearch)	Searches for tasks.
List<Task>	searchTasks(TaskSearch taskSearch, RequestOptions requestOptions)	Searches for tasks.
CompletableFuture<List<Task>>	searchTasksAsync(TaskSearch taskSearch)	(asynchronously) Searches for tasks.
CompletableFuture<List<Task>>	searchTasksAsync(TaskSearch taskSearch, RequestOptions requestOptions)	(asynchronously) Searches for tasks.
List<TaskV1>	searchTasksV1(TaskSearch taskSearch)	Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
List<TaskV1>	searchTasksV1(TaskSearch taskSearch, RequestOptions requestOptions)	Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
CompletableFuture<List<TaskV1>>	searchTasksV1Async(TaskSearch taskSearch)	(asynchronously) Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
CompletableFuture<List<TaskV1>>	searchTasksV1Async(TaskSearch taskSearch, RequestOptions requestOptions)	(asynchronously) Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
List<Transformation>	searchTransformations(TransformationSearch transformationSearch)	Searches for transformations.
List<Transformation>	searchTransformations(TransformationSearch transformationSearch, RequestOptions requestOptions)	Searches for transformations.
CompletableFuture<List<Transformation>>	searchTransformationsAsync(TransformationSearch transformationSearch)	(asynchronously) Searches for transformations.
CompletableFuture<List<Transformation>>	searchTransformationsAsync(TransformationSearch transformationSearch, RequestOptions requestOptions)	(asynchronously) Searches for transformations.
SourceWatchResponse	triggerDockerSourceDiscover(String sourceID)	Triggers a stream-listing request for a source.
SourceWatchResponse	triggerDockerSourceDiscover(String sourceID, RequestOptions requestOptions)	Triggers a stream-listing request for a source.
CompletableFuture<SourceWatchResponse>	triggerDockerSourceDiscoverAsync(String sourceID)	(asynchronously) Triggers a stream-listing request for a source.
CompletableFuture<SourceWatchResponse>	triggerDockerSourceDiscoverAsync(String sourceID, RequestOptions requestOptions)	(asynchronously) Triggers a stream-listing request for a source.
TransformationTryResponse	tryTransformation(TransformationTry transformationTry)	Try a transformation before creating it.
TransformationTryResponse	tryTransformation(TransformationTry transformationTry, RequestOptions requestOptions)	Try a transformation before creating it.
CompletableFuture<TransformationTryResponse>	tryTransformationAsync(TransformationTry transformationTry)	(asynchronously) Try a transformation before creating it.
CompletableFuture<TransformationTryResponse>	tryTransformationAsync(TransformationTry transformationTry, RequestOptions requestOptions)	(asynchronously) Try a transformation before creating it.
TransformationTryResponse	tryTransformationBeforeUpdate(String transformationID, TransformationTry transformationTry)	Try a transformation before updating it.
TransformationTryResponse	tryTransformationBeforeUpdate(String transformationID, TransformationTry transformationTry, RequestOptions requestOptions)	Try a transformation before updating it.
CompletableFuture<TransformationTryResponse>	tryTransformationBeforeUpdateAsync(String transformationID, TransformationTry transformationTry)	(asynchronously) Try a transformation before updating it.
CompletableFuture<TransformationTryResponse>	tryTransformationBeforeUpdateAsync(String transformationID, TransformationTry transformationTry, RequestOptions requestOptions)	(asynchronously) Try a transformation before updating it.
AuthenticationUpdateResponse	updateAuthentication(String authenticationID, AuthenticationUpdate authenticationUpdate)	Updates an authentication resource.
AuthenticationUpdateResponse	updateAuthentication(String authenticationID, AuthenticationUpdate authenticationUpdate, RequestOptions requestOptions)	Updates an authentication resource.
CompletableFuture<AuthenticationUpdateResponse>	updateAuthenticationAsync(String authenticationID, AuthenticationUpdate authenticationUpdate)	(asynchronously) Updates an authentication resource.
CompletableFuture<AuthenticationUpdateResponse>	updateAuthenticationAsync(String authenticationID, AuthenticationUpdate authenticationUpdate, RequestOptions requestOptions)	(asynchronously) Updates an authentication resource.
DestinationUpdateResponse	updateDestination(String destinationID, DestinationUpdate destinationUpdate)	Updates the destination by its ID.
DestinationUpdateResponse	updateDestination(String destinationID, DestinationUpdate destinationUpdate, RequestOptions requestOptions)	Updates the destination by its ID.
CompletableFuture<DestinationUpdateResponse>	updateDestinationAsync(String destinationID, DestinationUpdate destinationUpdate)	(asynchronously) Updates the destination by its ID.
CompletableFuture<DestinationUpdateResponse>	updateDestinationAsync(String destinationID, DestinationUpdate destinationUpdate, RequestOptions requestOptions)	(asynchronously) Updates the destination by its ID.
SourceUpdateResponse	updateSource(String sourceID, SourceUpdate sourceUpdate)	Updates a source by its ID.
SourceUpdateResponse	updateSource(String sourceID, SourceUpdate sourceUpdate, RequestOptions requestOptions)	Updates a source by its ID.
CompletableFuture<SourceUpdateResponse>	updateSourceAsync(String sourceID, SourceUpdate sourceUpdate)	(asynchronously) Updates a source by its ID.
CompletableFuture<SourceUpdateResponse>	updateSourceAsync(String sourceID, SourceUpdate sourceUpdate, RequestOptions requestOptions)	(asynchronously) Updates a source by its ID.
TaskUpdateResponse	updateTask(String taskID, TaskUpdate taskUpdate)	Updates a task by its ID.
TaskUpdateResponse	updateTask(String taskID, TaskUpdate taskUpdate, RequestOptions requestOptions)	Updates a task by its ID.
CompletableFuture<TaskUpdateResponse>	updateTaskAsync(String taskID, TaskUpdate taskUpdate)	(asynchronously) Updates a task by its ID.
CompletableFuture<TaskUpdateResponse>	updateTaskAsync(String taskID, TaskUpdate taskUpdate, RequestOptions requestOptions)	(asynchronously) Updates a task by its ID.
TaskUpdateResponse	updateTaskV1(String taskID, TaskUpdateV1 taskUpdate)	Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
TaskUpdateResponse	updateTaskV1(String taskID, TaskUpdateV1 taskUpdate, RequestOptions requestOptions)	Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
CompletableFuture<TaskUpdateResponse>	updateTaskV1Async(String taskID, TaskUpdateV1 taskUpdate)	(asynchronously) Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
CompletableFuture<TaskUpdateResponse>	updateTaskV1Async(String taskID, TaskUpdateV1 taskUpdate, RequestOptions requestOptions)	(asynchronously) Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
TransformationUpdateResponse	updateTransformation(String transformationID, TransformationCreate transformationCreate)	Updates a transformation by its ID.
TransformationUpdateResponse	updateTransformation(String transformationID, TransformationCreate transformationCreate, RequestOptions requestOptions)	Updates a transformation by its ID.
CompletableFuture<TransformationUpdateResponse>	updateTransformationAsync(String transformationID, TransformationCreate transformationCreate)	(asynchronously) Updates a transformation by its ID.
CompletableFuture<TransformationUpdateResponse>	updateTransformationAsync(String transformationID, TransformationCreate transformationCreate, RequestOptions requestOptions)	(asynchronously) Updates a transformation by its ID.
SourceWatchResponse	validateSource()	Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
SourceWatchResponse	validateSource(RequestOptions requestOptions)	Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
SourceWatchResponse	validateSource(SourceCreate sourceCreate)	Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
SourceWatchResponse	validateSource(SourceCreate sourceCreate, RequestOptions requestOptions)	Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
CompletableFuture<SourceWatchResponse>	validateSourceAsync()	(asynchronously) Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
CompletableFuture<SourceWatchResponse>	validateSourceAsync(RequestOptions requestOptions)	(asynchronously) Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
CompletableFuture<SourceWatchResponse>	validateSourceAsync(SourceCreate sourceCreate)	(asynchronously) Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
CompletableFuture<SourceWatchResponse>	validateSourceAsync(SourceCreate sourceCreate, RequestOptions requestOptions)	(asynchronously) Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
SourceWatchResponse	validateSourceBeforeUpdate(String sourceID, SourceUpdate sourceUpdate)	Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
SourceWatchResponse	validateSourceBeforeUpdate(String sourceID, SourceUpdate sourceUpdate, RequestOptions requestOptions)	Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
CompletableFuture<SourceWatchResponse>	validateSourceBeforeUpdateAsync(String sourceID, SourceUpdate sourceUpdate)	(asynchronously) Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
CompletableFuture<SourceWatchResponse>	validateSourceBeforeUpdateAsync(String sourceID, SourceUpdate sourceUpdate, RequestOptions requestOptions)	(asynchronously) Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.

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

IngestionClient

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

IngestionClient

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

Method Details

createAuthentication

public AuthenticationCreateResponse createAuthentication(@Nonnull
 AuthenticationCreate authenticationCreate,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Creates a new authentication resource.

Parameters:

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

createAuthentication

public AuthenticationCreateResponse createAuthentication(@Nonnull
 AuthenticationCreate authenticationCreate)
                                                  throws AlgoliaRuntimeException

Creates a new authentication resource.

Parameters:

authenticationCreate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createAuthenticationAsync

public CompletableFuture<AuthenticationCreateResponse> createAuthenticationAsync(@Nonnull
 AuthenticationCreate authenticationCreate,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Creates a new authentication resource.

Parameters:

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

createAuthenticationAsync

public CompletableFuture<AuthenticationCreateResponse> createAuthenticationAsync(@Nonnull
 AuthenticationCreate authenticationCreate)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Creates a new authentication resource.

Parameters:

authenticationCreate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createDestination

public DestinationCreateResponse createDestination(@Nonnull
 DestinationCreate destinationCreate,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

Creates a new destination.

Parameters:

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

createDestination

public DestinationCreateResponse createDestination(@Nonnull
 DestinationCreate destinationCreate)
                                            throws AlgoliaRuntimeException

Creates a new destination.

Parameters:

destinationCreate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createDestinationAsync

public CompletableFuture<DestinationCreateResponse> createDestinationAsync(@Nonnull
 DestinationCreate destinationCreate,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Creates a new destination.

Parameters:

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

createDestinationAsync

public CompletableFuture<DestinationCreateResponse> createDestinationAsync(@Nonnull
 DestinationCreate destinationCreate)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Creates a new destination.

Parameters:

destinationCreate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createSource

public SourceCreateResponse createSource(@Nonnull
 SourceCreate sourceCreate,
 RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Creates a new source.

Parameters:

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

createSource

public SourceCreateResponse createSource(@Nonnull
 SourceCreate sourceCreate)
                                  throws AlgoliaRuntimeException

Creates a new source.

Parameters:

sourceCreate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createSourceAsync

public CompletableFuture<SourceCreateResponse> createSourceAsync(@Nonnull
 SourceCreate sourceCreate,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) Creates a new source.

Parameters:

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

createSourceAsync

public CompletableFuture<SourceCreateResponse> createSourceAsync(@Nonnull
 SourceCreate sourceCreate)
                                                          throws AlgoliaRuntimeException

(asynchronously) Creates a new source.

Parameters:

sourceCreate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createTask

public TaskCreateResponse createTask(@Nonnull
 TaskCreate taskCreate,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Creates a new task.

Parameters:

taskCreate - Request body for creating a task. (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

createTask

public TaskCreateResponse createTask(@Nonnull
 TaskCreate taskCreate)
                              throws AlgoliaRuntimeException

Creates a new task.

Parameters:

taskCreate - Request body for creating a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createTaskAsync

public CompletableFuture<TaskCreateResponse> createTaskAsync(@Nonnull
 TaskCreate taskCreate,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Creates a new task.

Parameters:

taskCreate - Request body for creating a task. (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

createTaskAsync

public CompletableFuture<TaskCreateResponse> createTaskAsync(@Nonnull
 TaskCreate taskCreate)
                                                      throws AlgoliaRuntimeException

(asynchronously) Creates a new task.

Parameters:

taskCreate - Request body for creating a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createTaskV1

public TaskCreateResponse createTaskV1(@Nonnull
 TaskCreateV1 taskCreate,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Creates a new task using the v1 endpoint, please use `createTask` instead.

Parameters:

taskCreate - Request body for creating a task. (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

createTaskV1

public TaskCreateResponse createTaskV1(@Nonnull
 TaskCreateV1 taskCreate)
                                throws AlgoliaRuntimeException

Creates a new task using the v1 endpoint, please use `createTask` instead.

Parameters:

taskCreate - Request body for creating a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createTaskV1Async

public CompletableFuture<TaskCreateResponse> createTaskV1Async(@Nonnull
 TaskCreateV1 taskCreate,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Creates a new task using the v1 endpoint, please use `createTask` instead.

Parameters:

taskCreate - Request body for creating a task. (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

createTaskV1Async

public CompletableFuture<TaskCreateResponse> createTaskV1Async(@Nonnull
 TaskCreateV1 taskCreate)
                                                        throws AlgoliaRuntimeException

(asynchronously) Creates a new task using the v1 endpoint, please use `createTask` instead.

Parameters:

taskCreate - Request body for creating a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createTransformation

public TransformationCreateResponse createTransformation(@Nonnull
 TransformationCreate transformationCreate,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Creates a new transformation.

Parameters:

transformationCreate - Request body for creating a transformation. (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

createTransformation

public TransformationCreateResponse createTransformation(@Nonnull
 TransformationCreate transformationCreate)
                                                  throws AlgoliaRuntimeException

Creates a new transformation.

Parameters:

transformationCreate - Request body for creating a transformation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

createTransformationAsync

public CompletableFuture<TransformationCreateResponse> createTransformationAsync(@Nonnull
 TransformationCreate transformationCreate,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Creates a new transformation.

Parameters:

transformationCreate - Request body for creating a transformation. (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

createTransformationAsync

public CompletableFuture<TransformationCreateResponse> createTransformationAsync(@Nonnull
 TransformationCreate transformationCreate)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Creates a new transformation.

Parameters:

transformationCreate - Request body for creating a transformation. (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

deleteAuthentication

public DeleteResponse deleteAuthentication(@Nonnull
 String authenticationID,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.

Parameters:

authenticationID - Unique identifier of an authentication resource. (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

deleteAuthentication

public DeleteResponse deleteAuthentication(@Nonnull
 String authenticationID)
                                    throws AlgoliaRuntimeException

Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.

Parameters:

authenticationID - Unique identifier of an authentication resource. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteAuthenticationAsync

public CompletableFuture<DeleteResponse> deleteAuthenticationAsync(@Nonnull
 String authenticationID,
 RequestOptions requestOptions)
                                                            throws AlgoliaRuntimeException

(asynchronously) Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.

Parameters:

authenticationID - Unique identifier of an authentication resource. (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

deleteAuthenticationAsync

public CompletableFuture<DeleteResponse> deleteAuthenticationAsync(@Nonnull
 String authenticationID)
                                                            throws AlgoliaRuntimeException

(asynchronously) Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.

Parameters:

authenticationID - Unique identifier of an authentication resource. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteDestination

public DeleteResponse deleteDestination(@Nonnull
 String destinationID,
 RequestOptions requestOptions)
                                 throws AlgoliaRuntimeException

Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.

Parameters:

destinationID - Unique identifier of a destination. (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

deleteDestination

public DeleteResponse deleteDestination(@Nonnull
 String destinationID)
                                 throws AlgoliaRuntimeException

Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.

Parameters:

destinationID - Unique identifier of a destination. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteDestinationAsync

public CompletableFuture<DeleteResponse> deleteDestinationAsync(@Nonnull
 String destinationID,
 RequestOptions requestOptions)
                                                         throws AlgoliaRuntimeException

(asynchronously) Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.

Parameters:

destinationID - Unique identifier of a destination. (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

deleteDestinationAsync

public CompletableFuture<DeleteResponse> deleteDestinationAsync(@Nonnull
 String destinationID)
                                                         throws AlgoliaRuntimeException

(asynchronously) Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.

Parameters:

destinationID - Unique identifier of a destination. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSource

public DeleteResponse deleteSource(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Deletes a source by its ID. You can't delete sources that are referenced in tasks.

Parameters:

sourceID - Unique identifier of a source. (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

deleteSource

public DeleteResponse deleteSource(@Nonnull
 String sourceID)
                            throws AlgoliaRuntimeException

Deletes a source by its ID. You can't delete sources that are referenced in tasks.

Parameters:

sourceID - Unique identifier of a source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSourceAsync

public CompletableFuture<DeleteResponse> deleteSourceAsync(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Deletes a source by its ID. You can't delete sources that are referenced in tasks.

Parameters:

sourceID - Unique identifier of a source. (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

deleteSourceAsync

public CompletableFuture<DeleteResponse> deleteSourceAsync(@Nonnull
 String sourceID)
                                                    throws AlgoliaRuntimeException

(asynchronously) Deletes a source by its ID. You can't delete sources that are referenced in tasks.

Parameters:

sourceID - Unique identifier of a source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteTask

public DeleteResponse deleteTask(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

Deletes a task by its ID.

Parameters:

taskID - Unique identifier of a task. (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

deleteTask

public DeleteResponse deleteTask(@Nonnull
 String taskID)
                          throws AlgoliaRuntimeException

Deletes a task by its ID.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteTaskAsync

public CompletableFuture<DeleteResponse> deleteTaskAsync(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

(asynchronously) Deletes a task by its ID.

Parameters:

taskID - Unique identifier of a task. (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

deleteTaskAsync

public CompletableFuture<DeleteResponse> deleteTaskAsync(@Nonnull
 String taskID)
                                                  throws AlgoliaRuntimeException

(asynchronously) Deletes a task by its ID.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteTaskV1

public DeleteResponse deleteTaskV1(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.

Parameters:

taskID - Unique identifier of a task. (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

deleteTaskV1

public DeleteResponse deleteTaskV1(@Nonnull
 String taskID)
                            throws AlgoliaRuntimeException

Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteTaskV1Async

public CompletableFuture<DeleteResponse> deleteTaskV1Async(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.

Parameters:

taskID - Unique identifier of a task. (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

deleteTaskV1Async

public CompletableFuture<DeleteResponse> deleteTaskV1Async(@Nonnull
 String taskID)
                                                    throws AlgoliaRuntimeException

(asynchronously) Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteTransformation

public DeleteResponse deleteTransformation(@Nonnull
 String transformationID,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

Deletes a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (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

deleteTransformation

public DeleteResponse deleteTransformation(@Nonnull
 String transformationID)
                                    throws AlgoliaRuntimeException

Deletes a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteTransformationAsync

public CompletableFuture<DeleteResponse> deleteTransformationAsync(@Nonnull
 String transformationID,
 RequestOptions requestOptions)
                                                            throws AlgoliaRuntimeException

(asynchronously) Deletes a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (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

deleteTransformationAsync

public CompletableFuture<DeleteResponse> deleteTransformationAsync(@Nonnull
 String transformationID)
                                                            throws AlgoliaRuntimeException

(asynchronously) Deletes a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

disableTask

public TaskUpdateResponse disableTask(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

Disables a task.

Parameters:

taskID - Unique identifier of a task. (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

disableTask

public TaskUpdateResponse disableTask(@Nonnull
 String taskID)
                               throws AlgoliaRuntimeException

Disables a task.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

disableTaskAsync

public CompletableFuture<TaskUpdateResponse> disableTaskAsync(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) Disables a task.

Parameters:

taskID - Unique identifier of a task. (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

disableTaskAsync

public CompletableFuture<TaskUpdateResponse> disableTaskAsync(@Nonnull
 String taskID)
                                                       throws AlgoliaRuntimeException

(asynchronously) Disables a task.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

disableTaskV1

@Deprecated
public TaskUpdateResponse disableTaskV1(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                 throws AlgoliaRuntimeException

Deprecated.

Disables a task using the v1 endpoint, please use `disableTask` instead.

Parameters:

taskID - Unique identifier of a task. (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

disableTaskV1

@Deprecated
public TaskUpdateResponse disableTaskV1(@Nonnull
 String taskID)
                                 throws AlgoliaRuntimeException

Deprecated.

Disables a task using the v1 endpoint, please use `disableTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

disableTaskV1Async

@Deprecated
public CompletableFuture<TaskUpdateResponse> disableTaskV1Async(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                                         throws AlgoliaRuntimeException

Deprecated.

(asynchronously) Disables a task using the v1 endpoint, please use `disableTask` instead.

Parameters:

taskID - Unique identifier of a task. (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

disableTaskV1Async

@Deprecated
public CompletableFuture<TaskUpdateResponse> disableTaskV1Async(@Nonnull
 String taskID)
                                                         throws AlgoliaRuntimeException

Deprecated.

(asynchronously) Disables a task using the v1 endpoint, please use `disableTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

enableTask

public TaskUpdateResponse enableTask(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Enables a task.

Parameters:

taskID - Unique identifier of a task. (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

enableTask

public TaskUpdateResponse enableTask(@Nonnull
 String taskID)
                              throws AlgoliaRuntimeException

Enables a task.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

enableTaskAsync

public CompletableFuture<TaskUpdateResponse> enableTaskAsync(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Enables a task.

Parameters:

taskID - Unique identifier of a task. (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

enableTaskAsync

public CompletableFuture<TaskUpdateResponse> enableTaskAsync(@Nonnull
 String taskID)
                                                      throws AlgoliaRuntimeException

(asynchronously) Enables a task.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

enableTaskV1

public TaskUpdateResponse enableTaskV1(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Enables a task using the v1 endpoint, please use `enableTask` instead.

Parameters:

taskID - Unique identifier of a task. (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

enableTaskV1

public TaskUpdateResponse enableTaskV1(@Nonnull
 String taskID)
                                throws AlgoliaRuntimeException

Enables a task using the v1 endpoint, please use `enableTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

enableTaskV1Async

public CompletableFuture<TaskUpdateResponse> enableTaskV1Async(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Enables a task using the v1 endpoint, please use `enableTask` instead.

Parameters:

taskID - Unique identifier of a task. (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

enableTaskV1Async

public CompletableFuture<TaskUpdateResponse> enableTaskV1Async(@Nonnull
 String taskID)
                                                        throws AlgoliaRuntimeException

(asynchronously) Enables a task using the v1 endpoint, please use `enableTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAuthentication

public Authentication getAuthentication(@Nonnull
 String authenticationID,
 RequestOptions requestOptions)
                                 throws AlgoliaRuntimeException

Retrieves an authentication resource by its ID.

Parameters:

authenticationID - Unique identifier of an authentication resource. (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

getAuthentication

public Authentication getAuthentication(@Nonnull
 String authenticationID)
                                 throws AlgoliaRuntimeException

Retrieves an authentication resource by its ID.

Parameters:

authenticationID - Unique identifier of an authentication resource. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAuthenticationAsync

public CompletableFuture<Authentication> getAuthenticationAsync(@Nonnull
 String authenticationID,
 RequestOptions requestOptions)
                                                         throws AlgoliaRuntimeException

(asynchronously) Retrieves an authentication resource by its ID.

Parameters:

authenticationID - Unique identifier of an authentication resource. (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

getAuthenticationAsync

public CompletableFuture<Authentication> getAuthenticationAsync(@Nonnull
 String authenticationID)
                                                         throws AlgoliaRuntimeException

(asynchronously) Retrieves an authentication resource by its ID.

Parameters:

authenticationID - Unique identifier of an authentication resource. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDestination

public Destination getDestination(@Nonnull
 String destinationID,
 RequestOptions requestOptions)
                           throws AlgoliaRuntimeException

Retrieves a destination by its ID.

Parameters:

destinationID - Unique identifier of a destination. (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

getDestination

public Destination getDestination(@Nonnull
 String destinationID)
                           throws AlgoliaRuntimeException

Retrieves a destination by its ID.

Parameters:

destinationID - Unique identifier of a destination. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDestinationAsync

public CompletableFuture<Destination> getDestinationAsync(@Nonnull
 String destinationID,
 RequestOptions requestOptions)
                                                   throws AlgoliaRuntimeException

(asynchronously) Retrieves a destination by its ID.

Parameters:

destinationID - Unique identifier of a destination. (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

getDestinationAsync

public CompletableFuture<Destination> getDestinationAsync(@Nonnull
 String destinationID)
                                                   throws AlgoliaRuntimeException

(asynchronously) Retrieves a destination by its ID.

Parameters:

destinationID - Unique identifier of a destination. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getEvent

public Event getEvent(@Nonnull
 String runID,
 @Nonnull
 String eventID,
 RequestOptions requestOptions)
               throws AlgoliaRuntimeException

Retrieves a single task run event by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

eventID - Unique identifier of an event. (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

getEvent

public Event getEvent(@Nonnull
 String runID,
 @Nonnull
 String eventID)
               throws AlgoliaRuntimeException

Retrieves a single task run event by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

eventID - Unique identifier of an event. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getEventAsync

public CompletableFuture<Event> getEventAsync(@Nonnull
 String runID,
 @Nonnull
 String eventID,
 RequestOptions requestOptions)
                                       throws AlgoliaRuntimeException

(asynchronously) Retrieves a single task run event by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

eventID - Unique identifier of an event. (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

getEventAsync

public CompletableFuture<Event> getEventAsync(@Nonnull
 String runID,
 @Nonnull
 String eventID)
                                       throws AlgoliaRuntimeException

(asynchronously) Retrieves a single task run event by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

eventID - Unique identifier of an event. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRun

public Run getRun(@Nonnull
 String runID,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

Retrieve a single task run by its ID.

Parameters:

runID - Unique identifier of a task run. (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

getRun

public Run getRun(@Nonnull
 String runID)
           throws AlgoliaRuntimeException

Retrieve a single task run by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRunAsync

public CompletableFuture<Run> getRunAsync(@Nonnull
 String runID,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) Retrieve a single task run by its ID.

Parameters:

runID - Unique identifier of a task run. (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

getRunAsync

public CompletableFuture<Run> getRunAsync(@Nonnull
 String runID)
                                   throws AlgoliaRuntimeException

(asynchronously) Retrieve a single task run by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSource

public Source getSource(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

Retrieve a source by its ID.

Parameters:

sourceID - Unique identifier of a source. (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

getSource

public Source getSource(@Nonnull
 String sourceID)
                 throws AlgoliaRuntimeException

Retrieve a source by its ID.

Parameters:

sourceID - Unique identifier of a source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSourceAsync

public CompletableFuture<Source> getSourceAsync(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) Retrieve a source by its ID.

Parameters:

sourceID - Unique identifier of a source. (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

getSourceAsync

public CompletableFuture<Source> getSourceAsync(@Nonnull
 String sourceID)
                                         throws AlgoliaRuntimeException

(asynchronously) Retrieve a source by its ID.

Parameters:

sourceID - Unique identifier of a source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTask

public Task getTask(@Nonnull
 String taskID,
 RequestOptions requestOptions)
             throws AlgoliaRuntimeException

Retrieves a task by its ID.

Parameters:

taskID - Unique identifier of a task. (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

getTask

public Task getTask(@Nonnull
 String taskID)
             throws AlgoliaRuntimeException

Retrieves a task by its ID.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTaskAsync

public CompletableFuture<Task> getTaskAsync(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                     throws AlgoliaRuntimeException

(asynchronously) Retrieves a task by its ID.

Parameters:

taskID - Unique identifier of a task. (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

getTaskAsync

public CompletableFuture<Task> getTaskAsync(@Nonnull
 String taskID)
                                     throws AlgoliaRuntimeException

(asynchronously) Retrieves a task by its ID.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTaskV1

public TaskV1 getTaskV1(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.

Parameters:

taskID - Unique identifier of a task. (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

getTaskV1

public TaskV1 getTaskV1(@Nonnull
 String taskID)
                 throws AlgoliaRuntimeException

Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTaskV1Async

public CompletableFuture<TaskV1> getTaskV1Async(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.

Parameters:

taskID - Unique identifier of a task. (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

getTaskV1Async

public CompletableFuture<TaskV1> getTaskV1Async(@Nonnull
 String taskID)
                                         throws AlgoliaRuntimeException

(asynchronously) Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTransformation

public Transformation getTransformation(@Nonnull
 String transformationID,
 RequestOptions requestOptions)
                                 throws AlgoliaRuntimeException

Retrieves a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (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

getTransformation

public Transformation getTransformation(@Nonnull
 String transformationID)
                                 throws AlgoliaRuntimeException

Retrieves a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTransformationAsync

public CompletableFuture<Transformation> getTransformationAsync(@Nonnull
 String transformationID,
 RequestOptions requestOptions)
                                                         throws AlgoliaRuntimeException

(asynchronously) Retrieves a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (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

getTransformationAsync

public CompletableFuture<Transformation> getTransformationAsync(@Nonnull
 String transformationID)
                                                         throws AlgoliaRuntimeException

(asynchronously) Retrieves a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listAuthentications

public ListAuthenticationsResponse listAuthentications(Integer itemsPerPage,
 Integer page,
 List<AuthenticationType> type,
 List<PlatformWithNone> platform,
 AuthenticationSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Retrieves a list of all authentication resources.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Type of authentication resource to retrieve. (optional)

platform - Ecommerce platform for which to retrieve authentications. (optional)

sort - Property by which to sort the list of authentications. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listAuthentications

public ListAuthenticationsResponse listAuthentications(Integer itemsPerPage,
 Integer page,
 List<AuthenticationType> type,
 List<PlatformWithNone> platform,
 AuthenticationSortKeys sort,
 OrderKeys order)
                                                throws AlgoliaRuntimeException

Retrieves a list of all authentication resources.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Type of authentication resource to retrieve. (optional)

platform - Ecommerce platform for which to retrieve authentications. (optional)

sort - Property by which to sort the list of authentications. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listAuthentications

public ListAuthenticationsResponse listAuthentications(RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Retrieves a list of all authentication resources.

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

listAuthentications

public ListAuthenticationsResponse listAuthentications()
                                                throws AlgoliaRuntimeException

Retrieves a list of all authentication resources.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listAuthenticationsAsync

public CompletableFuture<ListAuthenticationsResponse> listAuthenticationsAsync(Integer itemsPerPage,
 Integer page,
 List<AuthenticationType> type,
 List<PlatformWithNone> platform,
 AuthenticationSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of all authentication resources.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Type of authentication resource to retrieve. (optional)

platform - Ecommerce platform for which to retrieve authentications. (optional)

sort - Property by which to sort the list of authentications. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listAuthenticationsAsync

public CompletableFuture<ListAuthenticationsResponse> listAuthenticationsAsync(Integer itemsPerPage,
 Integer page,
 List<AuthenticationType> type,
 List<PlatformWithNone> platform,
 AuthenticationSortKeys sort,
 OrderKeys order)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of all authentication resources.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Type of authentication resource to retrieve. (optional)

platform - Ecommerce platform for which to retrieve authentications. (optional)

sort - Property by which to sort the list of authentications. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listAuthenticationsAsync

public CompletableFuture<ListAuthenticationsResponse> listAuthenticationsAsync(RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of all authentication resources.

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

listAuthenticationsAsync

public CompletableFuture<ListAuthenticationsResponse> listAuthenticationsAsync()
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of all authentication resources.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listDestinations

public ListDestinationsResponse listDestinations(Integer itemsPerPage,
 Integer page,
 List<DestinationType> type,
 List<String> authenticationID,
 String transformationID,
 DestinationSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

Retrieves a list of destinations.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Destination type. (optional)

authenticationID - Authentication ID used by destinations. (optional)

transformationID - Get the list of destinations used by a transformation. (optional)

sort - Property by which to sort the destinations. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listDestinations

public ListDestinationsResponse listDestinations(Integer itemsPerPage,
 Integer page,
 List<DestinationType> type,
 List<String> authenticationID,
 String transformationID,
 DestinationSortKeys sort,
 OrderKeys order)
                                          throws AlgoliaRuntimeException

Retrieves a list of destinations.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Destination type. (optional)

authenticationID - Authentication ID used by destinations. (optional)

transformationID - Get the list of destinations used by a transformation. (optional)

sort - Property by which to sort the destinations. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listDestinations

public ListDestinationsResponse listDestinations(RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

Retrieves a list of destinations.

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

listDestinations

public ListDestinationsResponse listDestinations()
                                          throws AlgoliaRuntimeException

Retrieves a list of destinations.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listDestinationsAsync

public CompletableFuture<ListDestinationsResponse> listDestinationsAsync(Integer itemsPerPage,
 Integer page,
 List<DestinationType> type,
 List<String> authenticationID,
 String transformationID,
 DestinationSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of destinations.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Destination type. (optional)

authenticationID - Authentication ID used by destinations. (optional)

transformationID - Get the list of destinations used by a transformation. (optional)

sort - Property by which to sort the destinations. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listDestinationsAsync

public CompletableFuture<ListDestinationsResponse> listDestinationsAsync(Integer itemsPerPage,
 Integer page,
 List<DestinationType> type,
 List<String> authenticationID,
 String transformationID,
 DestinationSortKeys sort,
 OrderKeys order)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of destinations.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Destination type. (optional)

authenticationID - Authentication ID used by destinations. (optional)

transformationID - Get the list of destinations used by a transformation. (optional)

sort - Property by which to sort the destinations. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listDestinationsAsync

public CompletableFuture<ListDestinationsResponse> listDestinationsAsync(RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of destinations.

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

listDestinationsAsync

public CompletableFuture<ListDestinationsResponse> listDestinationsAsync()
                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of destinations.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listEvents

public ListEventsResponse listEvents(@Nonnull
 String runID,
 Integer itemsPerPage,
 Integer page,
 List<EventStatus> status,
 List<EventType> type,
 EventSortKeys sort,
 OrderKeys order,
 String startDate,
 String endDate,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Retrieves a list of events for a task run, identified by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

status - Event status for filtering the list of task runs. (optional)

type - Event type for filtering the list of task runs. (optional)

sort - Property by which to sort the list of task run events. (optional)

order - Sort order of the response, ascending or descending. (optional, default to desc)

startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. (optional)

endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used. (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

listEvents

public ListEventsResponse listEvents(@Nonnull
 String runID,
 Integer itemsPerPage,
 Integer page,
 List<EventStatus> status,
 List<EventType> type,
 EventSortKeys sort,
 OrderKeys order,
 String startDate,
 String endDate)
                              throws AlgoliaRuntimeException

Retrieves a list of events for a task run, identified by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

status - Event status for filtering the list of task runs. (optional)

type - Event type for filtering the list of task runs. (optional)

sort - Property by which to sort the list of task run events. (optional)

order - Sort order of the response, ascending or descending. (optional, default to desc)

startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. (optional)

endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listEvents

public ListEventsResponse listEvents(@Nonnull
 String runID,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Retrieves a list of events for a task run, identified by its ID.

Parameters:

runID - Unique identifier of a task run. (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

listEvents

public ListEventsResponse listEvents(@Nonnull
 String runID)
                              throws AlgoliaRuntimeException

Retrieves a list of events for a task run, identified by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listEventsAsync

public CompletableFuture<ListEventsResponse> listEventsAsync(@Nonnull
 String runID,
 Integer itemsPerPage,
 Integer page,
 List<EventStatus> status,
 List<EventType> type,
 EventSortKeys sort,
 OrderKeys order,
 String startDate,
 String endDate,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of events for a task run, identified by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

status - Event status for filtering the list of task runs. (optional)

type - Event type for filtering the list of task runs. (optional)

sort - Property by which to sort the list of task run events. (optional)

order - Sort order of the response, ascending or descending. (optional, default to desc)

startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. (optional)

endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used. (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

listEventsAsync

public CompletableFuture<ListEventsResponse> listEventsAsync(@Nonnull
 String runID,
 Integer itemsPerPage,
 Integer page,
 List<EventStatus> status,
 List<EventType> type,
 EventSortKeys sort,
 OrderKeys order,
 String startDate,
 String endDate)
                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of events for a task run, identified by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

status - Event status for filtering the list of task runs. (optional)

type - Event type for filtering the list of task runs. (optional)

sort - Property by which to sort the list of task run events. (optional)

order - Sort order of the response, ascending or descending. (optional, default to desc)

startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. (optional)

endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listEventsAsync

public CompletableFuture<ListEventsResponse> listEventsAsync(@Nonnull
 String runID,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of events for a task run, identified by its ID.

Parameters:

runID - Unique identifier of a task run. (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

listEventsAsync

public CompletableFuture<ListEventsResponse> listEventsAsync(@Nonnull
 String runID)
                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of events for a task run, identified by its ID.

Parameters:

runID - Unique identifier of a task run. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listRuns

public RunListResponse listRuns(Integer itemsPerPage,
 Integer page,
 List<RunStatus> status,
 List<RunType> type,
 String taskID,
 RunSortKeys sort,
 OrderKeys order,
 String startDate,
 String endDate,
 RequestOptions requestOptions)
                         throws AlgoliaRuntimeException

Retrieve a list of task runs.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

status - Run status for filtering the list of task runs. (optional)

type - Run type for filtering the list of task runs. (optional)

taskID - Task ID for filtering the list of task runs. (optional)

sort - Property by which to sort the list of task runs. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. (optional)

endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used. (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

listRuns

public RunListResponse listRuns(Integer itemsPerPage,
 Integer page,
 List<RunStatus> status,
 List<RunType> type,
 String taskID,
 RunSortKeys sort,
 OrderKeys order,
 String startDate,
 String endDate)
                         throws AlgoliaRuntimeException

Retrieve a list of task runs.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

status - Run status for filtering the list of task runs. (optional)

type - Run type for filtering the list of task runs. (optional)

taskID - Task ID for filtering the list of task runs. (optional)

sort - Property by which to sort the list of task runs. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. (optional)

endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listRuns

public RunListResponse listRuns(RequestOptions requestOptions)
                         throws AlgoliaRuntimeException

Retrieve a list of task runs.

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

listRuns

public RunListResponse listRuns()
                         throws AlgoliaRuntimeException

Retrieve a list of task runs.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listRunsAsync

public CompletableFuture<RunListResponse> listRunsAsync(Integer itemsPerPage,
 Integer page,
 List<RunStatus> status,
 List<RunType> type,
 String taskID,
 RunSortKeys sort,
 OrderKeys order,
 String startDate,
 String endDate,
 RequestOptions requestOptions)
                                                 throws AlgoliaRuntimeException

(asynchronously) Retrieve a list of task runs.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

status - Run status for filtering the list of task runs. (optional)

type - Run type for filtering the list of task runs. (optional)

taskID - Task ID for filtering the list of task runs. (optional)

sort - Property by which to sort the list of task runs. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. (optional)

endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used. (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

listRunsAsync

public CompletableFuture<RunListResponse> listRunsAsync(Integer itemsPerPage,
 Integer page,
 List<RunStatus> status,
 List<RunType> type,
 String taskID,
 RunSortKeys sort,
 OrderKeys order,
 String startDate,
 String endDate)
                                                 throws AlgoliaRuntimeException

(asynchronously) Retrieve a list of task runs.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

status - Run status for filtering the list of task runs. (optional)

type - Run type for filtering the list of task runs. (optional)

taskID - Task ID for filtering the list of task runs. (optional)

sort - Property by which to sort the list of task runs. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. (optional)

endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listRunsAsync

public CompletableFuture<RunListResponse> listRunsAsync(RequestOptions requestOptions)
                                                 throws AlgoliaRuntimeException

(asynchronously) Retrieve a list of task runs.

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

listRunsAsync

public CompletableFuture<RunListResponse> listRunsAsync()
                                                 throws AlgoliaRuntimeException

(asynchronously) Retrieve a list of task runs.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listSources

public ListSourcesResponse listSources(Integer itemsPerPage,
 Integer page,
 List<SourceType> type,
 List<String> authenticationID,
 SourceSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Retrieves a list of sources.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Source type. Some sources require authentication. (optional)

authenticationID - Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)

sort - Property by which to sort the list of sources. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listSources

public ListSourcesResponse listSources(Integer itemsPerPage,
 Integer page,
 List<SourceType> type,
 List<String> authenticationID,
 SourceSortKeys sort,
 OrderKeys order)
                                throws AlgoliaRuntimeException

Retrieves a list of sources.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Source type. Some sources require authentication. (optional)

authenticationID - Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)

sort - Property by which to sort the list of sources. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listSources

public ListSourcesResponse listSources(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Retrieves a list of sources.

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

listSources

public ListSourcesResponse listSources()
                                throws AlgoliaRuntimeException

Retrieves a list of sources.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listSourcesAsync

public CompletableFuture<ListSourcesResponse> listSourcesAsync(Integer itemsPerPage,
 Integer page,
 List<SourceType> type,
 List<String> authenticationID,
 SourceSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of sources.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Source type. Some sources require authentication. (optional)

authenticationID - Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)

sort - Property by which to sort the list of sources. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listSourcesAsync

public CompletableFuture<ListSourcesResponse> listSourcesAsync(Integer itemsPerPage,
 Integer page,
 List<SourceType> type,
 List<String> authenticationID,
 SourceSortKeys sort,
 OrderKeys order)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of sources.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

type - Source type. Some sources require authentication. (optional)

authenticationID - Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)

sort - Property by which to sort the list of sources. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listSourcesAsync

public CompletableFuture<ListSourcesResponse> listSourcesAsync(RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of sources.

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

listSourcesAsync

public CompletableFuture<ListSourcesResponse> listSourcesAsync()
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of sources.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTasks

public ListTasksResponse listTasks(Integer itemsPerPage,
 Integer page,
 List<ActionType> action,
 Boolean enabled,
 List<String> sourceID,
 List<SourceType> sourceType,
 List<String> destinationID,
 List<TriggerType> triggerType,
 TaskSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Retrieves a list of tasks.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

action - Actions for filtering the list of tasks. (optional)

enabled - Whether to filter the list of tasks by the `enabled` status. (optional)

sourceID - Source IDs for filtering the list of tasks. (optional)

sourceType - Filters the tasks with the specified source type. (optional)

destinationID - Destination IDs for filtering the list of tasks. (optional)

triggerType - Type of task trigger for filtering the list of tasks. (optional)

sort - Property by which to sort the list of tasks. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listTasks

public ListTasksResponse listTasks(Integer itemsPerPage,
 Integer page,
 List<ActionType> action,
 Boolean enabled,
 List<String> sourceID,
 List<SourceType> sourceType,
 List<String> destinationID,
 List<TriggerType> triggerType,
 TaskSortKeys sort,
 OrderKeys order)
                            throws AlgoliaRuntimeException

Retrieves a list of tasks.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

action - Actions for filtering the list of tasks. (optional)

enabled - Whether to filter the list of tasks by the `enabled` status. (optional)

sourceID - Source IDs for filtering the list of tasks. (optional)

sourceType - Filters the tasks with the specified source type. (optional)

destinationID - Destination IDs for filtering the list of tasks. (optional)

triggerType - Type of task trigger for filtering the list of tasks. (optional)

sort - Property by which to sort the list of tasks. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTasks

public ListTasksResponse listTasks(RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Retrieves a list of tasks.

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

listTasks

public ListTasksResponse listTasks()
                            throws AlgoliaRuntimeException

Retrieves a list of tasks.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTasksAsync

public CompletableFuture<ListTasksResponse> listTasksAsync(Integer itemsPerPage,
 Integer page,
 List<ActionType> action,
 Boolean enabled,
 List<String> sourceID,
 List<SourceType> sourceType,
 List<String> destinationID,
 List<TriggerType> triggerType,
 TaskSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

action - Actions for filtering the list of tasks. (optional)

enabled - Whether to filter the list of tasks by the `enabled` status. (optional)

sourceID - Source IDs for filtering the list of tasks. (optional)

sourceType - Filters the tasks with the specified source type. (optional)

destinationID - Destination IDs for filtering the list of tasks. (optional)

triggerType - Type of task trigger for filtering the list of tasks. (optional)

sort - Property by which to sort the list of tasks. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listTasksAsync

public CompletableFuture<ListTasksResponse> listTasksAsync(Integer itemsPerPage,
 Integer page,
 List<ActionType> action,
 Boolean enabled,
 List<String> sourceID,
 List<SourceType> sourceType,
 List<String> destinationID,
 List<TriggerType> triggerType,
 TaskSortKeys sort,
 OrderKeys order)
                                                    throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

action - Actions for filtering the list of tasks. (optional)

enabled - Whether to filter the list of tasks by the `enabled` status. (optional)

sourceID - Source IDs for filtering the list of tasks. (optional)

sourceType - Filters the tasks with the specified source type. (optional)

destinationID - Destination IDs for filtering the list of tasks. (optional)

triggerType - Type of task trigger for filtering the list of tasks. (optional)

sort - Property by which to sort the list of tasks. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTasksAsync

public CompletableFuture<ListTasksResponse> listTasksAsync(RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks.

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

listTasksAsync

public CompletableFuture<ListTasksResponse> listTasksAsync()
                                                    throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTasksV1

public ListTasksResponseV1 listTasksV1(Integer itemsPerPage,
 Integer page,
 List<ActionType> action,
 Boolean enabled,
 List<String> sourceID,
 List<String> destinationID,
 List<TriggerType> triggerType,
 TaskSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

action - Actions for filtering the list of tasks. (optional)

enabled - Whether to filter the list of tasks by the `enabled` status. (optional)

sourceID - Source IDs for filtering the list of tasks. (optional)

destinationID - Destination IDs for filtering the list of tasks. (optional)

triggerType - Type of task trigger for filtering the list of tasks. (optional)

sort - Property by which to sort the list of tasks. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listTasksV1

public ListTasksResponseV1 listTasksV1(Integer itemsPerPage,
 Integer page,
 List<ActionType> action,
 Boolean enabled,
 List<String> sourceID,
 List<String> destinationID,
 List<TriggerType> triggerType,
 TaskSortKeys sort,
 OrderKeys order)
                                throws AlgoliaRuntimeException

Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

action - Actions for filtering the list of tasks. (optional)

enabled - Whether to filter the list of tasks by the `enabled` status. (optional)

sourceID - Source IDs for filtering the list of tasks. (optional)

destinationID - Destination IDs for filtering the list of tasks. (optional)

triggerType - Type of task trigger for filtering the list of tasks. (optional)

sort - Property by which to sort the list of tasks. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTasksV1

public ListTasksResponseV1 listTasksV1(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.

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

listTasksV1

public ListTasksResponseV1 listTasksV1()
                                throws AlgoliaRuntimeException

Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTasksV1Async

public CompletableFuture<ListTasksResponseV1> listTasksV1Async(Integer itemsPerPage,
 Integer page,
 List<ActionType> action,
 Boolean enabled,
 List<String> sourceID,
 List<String> destinationID,
 List<TriggerType> triggerType,
 TaskSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

action - Actions for filtering the list of tasks. (optional)

enabled - Whether to filter the list of tasks by the `enabled` status. (optional)

sourceID - Source IDs for filtering the list of tasks. (optional)

destinationID - Destination IDs for filtering the list of tasks. (optional)

triggerType - Type of task trigger for filtering the list of tasks. (optional)

sort - Property by which to sort the list of tasks. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listTasksV1Async

public CompletableFuture<ListTasksResponseV1> listTasksV1Async(Integer itemsPerPage,
 Integer page,
 List<ActionType> action,
 Boolean enabled,
 List<String> sourceID,
 List<String> destinationID,
 List<TriggerType> triggerType,
 TaskSortKeys sort,
 OrderKeys order)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

action - Actions for filtering the list of tasks. (optional)

enabled - Whether to filter the list of tasks by the `enabled` status. (optional)

sourceID - Source IDs for filtering the list of tasks. (optional)

destinationID - Destination IDs for filtering the list of tasks. (optional)

triggerType - Type of task trigger for filtering the list of tasks. (optional)

sort - Property by which to sort the list of tasks. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTasksV1Async

public CompletableFuture<ListTasksResponseV1> listTasksV1Async(RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.

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

listTasksV1Async

public CompletableFuture<ListTasksResponseV1> listTasksV1Async()
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTransformations

public ListTransformationsResponse listTransformations(Integer itemsPerPage,
 Integer page,
 TransformationSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Retrieves a list of transformations.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

sort - Property by which to sort the list of transformations. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listTransformations

public ListTransformationsResponse listTransformations(Integer itemsPerPage,
 Integer page,
 TransformationSortKeys sort,
 OrderKeys order)
                                                throws AlgoliaRuntimeException

Retrieves a list of transformations.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

sort - Property by which to sort the list of transformations. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTransformations

public ListTransformationsResponse listTransformations(RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Retrieves a list of transformations.

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

listTransformations

public ListTransformationsResponse listTransformations()
                                                throws AlgoliaRuntimeException

Retrieves a list of transformations.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTransformationsAsync

public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(Integer itemsPerPage,
 Integer page,
 TransformationSortKeys sort,
 OrderKeys order,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of transformations.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

sort - Property by which to sort the list of transformations. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

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

listTransformationsAsync

public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(Integer itemsPerPage,
 Integer page,
 TransformationSortKeys sort,
 OrderKeys order)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of transformations.

Parameters:

itemsPerPage - Number of items per page. (optional, default to 10)

page - Page number of the paginated API response. (optional)

sort - Property by which to sort the list of transformations. (optional, default to createdAt)

order - Sort order of the response, ascending or descending. (optional, default to desc)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listTransformationsAsync

public CompletableFuture<ListTransformationsResponse> listTransformationsAsync(RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of transformations.

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

listTransformationsAsync

public CompletableFuture<ListTransformationsResponse> listTransformationsAsync()
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of transformations.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

pushTask

public RunResponse pushTask(@Nonnull
 String taskID,
 @Nonnull
 PushTaskPayload pushTaskPayload,
 RequestOptions requestOptions)
                     throws AlgoliaRuntimeException

Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (required)

pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (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

pushTask

public RunResponse pushTask(@Nonnull
 String taskID,
 @Nonnull
 PushTaskPayload pushTaskPayload)
                     throws AlgoliaRuntimeException

Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (required)

pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

pushTaskAsync

public CompletableFuture<RunResponse> pushTaskAsync(@Nonnull
 String taskID,
 @Nonnull
 PushTaskPayload pushTaskPayload,
 RequestOptions requestOptions)
                                             throws AlgoliaRuntimeException

(asynchronously) Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (required)

pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (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

pushTaskAsync

public CompletableFuture<RunResponse> pushTaskAsync(@Nonnull
 String taskID,
 @Nonnull
 PushTaskPayload pushTaskPayload)
                                             throws AlgoliaRuntimeException

(asynchronously) Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (required)

pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

runSource

public RunSourceResponse runSource(@Nonnull
 String sourceID,
 RunSourcePayload runSourcePayload,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Parameters:

sourceID - Unique identifier of a source. (required)

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

runSource

public RunSourceResponse runSource(@Nonnull
 String sourceID,
 RunSourcePayload runSourcePayload)
                            throws AlgoliaRuntimeException

Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Parameters:

sourceID - Unique identifier of a source. (required)

runSourcePayload - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

runSource

public RunSourceResponse runSource(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Parameters:

sourceID - Unique identifier of a source. (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

runSource

public RunSourceResponse runSource(@Nonnull
 String sourceID)
                            throws AlgoliaRuntimeException

Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Parameters:

sourceID - Unique identifier of a source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

runSourceAsync

public CompletableFuture<RunSourceResponse> runSourceAsync(@Nonnull
 String sourceID,
 RunSourcePayload runSourcePayload,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Parameters:

sourceID - Unique identifier of a source. (required)

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

runSourceAsync

public CompletableFuture<RunSourceResponse> runSourceAsync(@Nonnull
 String sourceID,
 RunSourcePayload runSourcePayload)
                                                    throws AlgoliaRuntimeException

(asynchronously) Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Parameters:

sourceID - Unique identifier of a source. (required)

runSourcePayload - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

runSourceAsync

public CompletableFuture<RunSourceResponse> runSourceAsync(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Parameters:

sourceID - Unique identifier of a source. (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

runSourceAsync

public CompletableFuture<RunSourceResponse> runSourceAsync(@Nonnull
 String sourceID)
                                                    throws AlgoliaRuntimeException

(asynchronously) Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Parameters:

sourceID - Unique identifier of a source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

runTask

public RunResponse runTask(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                    throws AlgoliaRuntimeException

Runs a task. You can check the status of task runs with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (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

runTask

public RunResponse runTask(@Nonnull
 String taskID)
                    throws AlgoliaRuntimeException

Runs a task. You can check the status of task runs with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

runTaskAsync

public CompletableFuture<RunResponse> runTaskAsync(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

(asynchronously) Runs a task. You can check the status of task runs with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (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

runTaskAsync

public CompletableFuture<RunResponse> runTaskAsync(@Nonnull
 String taskID)
                                            throws AlgoliaRuntimeException

(asynchronously) Runs a task. You can check the status of task runs with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

runTaskV1

public RunResponse runTaskV1(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                      throws AlgoliaRuntimeException

Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (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

runTaskV1

public RunResponse runTaskV1(@Nonnull
 String taskID)
                      throws AlgoliaRuntimeException

Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

runTaskV1Async

public CompletableFuture<RunResponse> runTaskV1Async(@Nonnull
 String taskID,
 RequestOptions requestOptions)
                                              throws AlgoliaRuntimeException

(asynchronously) Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (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

runTaskV1Async

public CompletableFuture<RunResponse> runTaskV1Async(@Nonnull
 String taskID)
                                              throws AlgoliaRuntimeException

(asynchronously) Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.

Parameters:

taskID - Unique identifier of a task. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchAuthentications

public List<Authentication> searchAuthentications(@Nonnull
 AuthenticationSearch authenticationSearch,
 RequestOptions requestOptions)
                                           throws AlgoliaRuntimeException

Searches for authentication resources.

Parameters:

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

searchAuthentications

public List<Authentication> searchAuthentications(@Nonnull
 AuthenticationSearch authenticationSearch)
                                           throws AlgoliaRuntimeException

Searches for authentication resources.

Parameters:

authenticationSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchAuthenticationsAsync

public CompletableFuture<List<Authentication>> searchAuthenticationsAsync(@Nonnull
 AuthenticationSearch authenticationSearch,
 RequestOptions requestOptions)
                                                                   throws AlgoliaRuntimeException

(asynchronously) Searches for authentication resources.

Parameters:

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

searchAuthenticationsAsync

public CompletableFuture<List<Authentication>> searchAuthenticationsAsync(@Nonnull
 AuthenticationSearch authenticationSearch)
                                                                   throws AlgoliaRuntimeException

(asynchronously) Searches for authentication resources.

Parameters:

authenticationSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDestinations

public List<Destination> searchDestinations(@Nonnull
 DestinationSearch destinationSearch,
 RequestOptions requestOptions)
                                     throws AlgoliaRuntimeException

Searches for destinations.

Parameters:

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

searchDestinations

public List<Destination> searchDestinations(@Nonnull
 DestinationSearch destinationSearch)
                                     throws AlgoliaRuntimeException

Searches for destinations.

Parameters:

destinationSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDestinationsAsync

public CompletableFuture<List<Destination>> searchDestinationsAsync(@Nonnull
 DestinationSearch destinationSearch,
 RequestOptions requestOptions)
                                                             throws AlgoliaRuntimeException

(asynchronously) Searches for destinations.

Parameters:

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

searchDestinationsAsync

public CompletableFuture<List<Destination>> searchDestinationsAsync(@Nonnull
 DestinationSearch destinationSearch)
                                                             throws AlgoliaRuntimeException

(asynchronously) Searches for destinations.

Parameters:

destinationSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSources

public List<Source> searchSources(@Nonnull
 SourceSearch sourceSearch,
 RequestOptions requestOptions)
                           throws AlgoliaRuntimeException

Searches for sources.

Parameters:

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

searchSources

public List<Source> searchSources(@Nonnull
 SourceSearch sourceSearch)
                           throws AlgoliaRuntimeException

Searches for sources.

Parameters:

sourceSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSourcesAsync

public CompletableFuture<List<Source>> searchSourcesAsync(@Nonnull
 SourceSearch sourceSearch,
 RequestOptions requestOptions)
                                                   throws AlgoliaRuntimeException

(asynchronously) Searches for sources.

Parameters:

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

searchSourcesAsync

public CompletableFuture<List<Source>> searchSourcesAsync(@Nonnull
 SourceSearch sourceSearch)
                                                   throws AlgoliaRuntimeException

(asynchronously) Searches for sources.

Parameters:

sourceSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchTasks

public List<Task> searchTasks(@Nonnull
 TaskSearch taskSearch,
 RequestOptions requestOptions)
                       throws AlgoliaRuntimeException

Searches for tasks.

Parameters:

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

searchTasks

public List<Task> searchTasks(@Nonnull
 TaskSearch taskSearch)
                       throws AlgoliaRuntimeException

Searches for tasks.

Parameters:

taskSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchTasksAsync

public CompletableFuture<List<Task>> searchTasksAsync(@Nonnull
 TaskSearch taskSearch,
 RequestOptions requestOptions)
                                               throws AlgoliaRuntimeException

(asynchronously) Searches for tasks.

Parameters:

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

searchTasksAsync

public CompletableFuture<List<Task>> searchTasksAsync(@Nonnull
 TaskSearch taskSearch)
                                               throws AlgoliaRuntimeException

(asynchronously) Searches for tasks.

Parameters:

taskSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchTasksV1

public List<TaskV1> searchTasksV1(@Nonnull
 TaskSearch taskSearch,
 RequestOptions requestOptions)
                           throws AlgoliaRuntimeException

Searches for tasks using the v1 endpoint, please use `searchTasks` instead.

Parameters:

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

searchTasksV1

public List<TaskV1> searchTasksV1(@Nonnull
 TaskSearch taskSearch)
                           throws AlgoliaRuntimeException

Searches for tasks using the v1 endpoint, please use `searchTasks` instead.

Parameters:

taskSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchTasksV1Async

public CompletableFuture<List<TaskV1>> searchTasksV1Async(@Nonnull
 TaskSearch taskSearch,
 RequestOptions requestOptions)
                                                   throws AlgoliaRuntimeException

(asynchronously) Searches for tasks using the v1 endpoint, please use `searchTasks` instead.

Parameters:

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

searchTasksV1Async

public CompletableFuture<List<TaskV1>> searchTasksV1Async(@Nonnull
 TaskSearch taskSearch)
                                                   throws AlgoliaRuntimeException

(asynchronously) Searches for tasks using the v1 endpoint, please use `searchTasks` instead.

Parameters:

taskSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchTransformations

public List<Transformation> searchTransformations(@Nonnull
 TransformationSearch transformationSearch,
 RequestOptions requestOptions)
                                           throws AlgoliaRuntimeException

Searches for transformations.

Parameters:

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

searchTransformations

public List<Transformation> searchTransformations(@Nonnull
 TransformationSearch transformationSearch)
                                           throws AlgoliaRuntimeException

Searches for transformations.

Parameters:

transformationSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchTransformationsAsync

public CompletableFuture<List<Transformation>> searchTransformationsAsync(@Nonnull
 TransformationSearch transformationSearch,
 RequestOptions requestOptions)
                                                                   throws AlgoliaRuntimeException

(asynchronously) Searches for transformations.

Parameters:

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

searchTransformationsAsync

public CompletableFuture<List<Transformation>> searchTransformationsAsync(@Nonnull
 TransformationSearch transformationSearch)
                                                                   throws AlgoliaRuntimeException

(asynchronously) Searches for transformations.

Parameters:

transformationSearch - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

triggerDockerSourceDiscover

public SourceWatchResponse triggerDockerSourceDiscover(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.

Parameters:

sourceID - Unique identifier of a source. (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

triggerDockerSourceDiscover

public SourceWatchResponse triggerDockerSourceDiscover(@Nonnull
 String sourceID)
                                                throws AlgoliaRuntimeException

Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.

Parameters:

sourceID - Unique identifier of a source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

triggerDockerSourceDiscoverAsync

public CompletableFuture<SourceWatchResponse> triggerDockerSourceDiscoverAsync(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.

Parameters:

sourceID - Unique identifier of a source. (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

triggerDockerSourceDiscoverAsync

public CompletableFuture<SourceWatchResponse> triggerDockerSourceDiscoverAsync(@Nonnull
 String sourceID)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.

Parameters:

sourceID - Unique identifier of a source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

tryTransformation

public TransformationTryResponse tryTransformation(@Nonnull
 TransformationTry transformationTry,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

Try a transformation before creating it.

Parameters:

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

tryTransformation

public TransformationTryResponse tryTransformation(@Nonnull
 TransformationTry transformationTry)
                                            throws AlgoliaRuntimeException

Try a transformation before creating it.

Parameters:

transformationTry - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

tryTransformationAsync

public CompletableFuture<TransformationTryResponse> tryTransformationAsync(@Nonnull
 TransformationTry transformationTry,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Try a transformation before creating it.

Parameters:

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

tryTransformationAsync

public CompletableFuture<TransformationTryResponse> tryTransformationAsync(@Nonnull
 TransformationTry transformationTry)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Try a transformation before creating it.

Parameters:

transformationTry - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

tryTransformationBeforeUpdate

public TransformationTryResponse tryTransformationBeforeUpdate(@Nonnull
 String transformationID,
 @Nonnull
 TransformationTry transformationTry,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

Try a transformation before updating it.

Parameters:

transformationID - Unique identifier of a transformation. (required)

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

tryTransformationBeforeUpdate

public TransformationTryResponse tryTransformationBeforeUpdate(@Nonnull
 String transformationID,
 @Nonnull
 TransformationTry transformationTry)
                                                        throws AlgoliaRuntimeException

Try a transformation before updating it.

Parameters:

transformationID - Unique identifier of a transformation. (required)

transformationTry - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

tryTransformationBeforeUpdateAsync

public CompletableFuture<TransformationTryResponse> tryTransformationBeforeUpdateAsync(@Nonnull
 String transformationID,
 @Nonnull
 TransformationTry transformationTry,
 RequestOptions requestOptions)
                                                                                throws AlgoliaRuntimeException

(asynchronously) Try a transformation before updating it.

Parameters:

transformationID - Unique identifier of a transformation. (required)

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

tryTransformationBeforeUpdateAsync

public CompletableFuture<TransformationTryResponse> tryTransformationBeforeUpdateAsync(@Nonnull
 String transformationID,
 @Nonnull
 TransformationTry transformationTry)
                                                                                throws AlgoliaRuntimeException

(asynchronously) Try a transformation before updating it.

Parameters:

transformationID - Unique identifier of a transformation. (required)

transformationTry - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateAuthentication

public AuthenticationUpdateResponse updateAuthentication(@Nonnull
 String authenticationID,
 @Nonnull
 AuthenticationUpdate authenticationUpdate,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Updates an authentication resource.

Parameters:

authenticationID - Unique identifier of an authentication resource. (required)

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

updateAuthentication

public AuthenticationUpdateResponse updateAuthentication(@Nonnull
 String authenticationID,
 @Nonnull
 AuthenticationUpdate authenticationUpdate)
                                                  throws AlgoliaRuntimeException

Updates an authentication resource.

Parameters:

authenticationID - Unique identifier of an authentication resource. (required)

authenticationUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateAuthenticationAsync

public CompletableFuture<AuthenticationUpdateResponse> updateAuthenticationAsync(@Nonnull
 String authenticationID,
 @Nonnull
 AuthenticationUpdate authenticationUpdate,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Updates an authentication resource.

Parameters:

authenticationID - Unique identifier of an authentication resource. (required)

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

updateAuthenticationAsync

public CompletableFuture<AuthenticationUpdateResponse> updateAuthenticationAsync(@Nonnull
 String authenticationID,
 @Nonnull
 AuthenticationUpdate authenticationUpdate)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Updates an authentication resource.

Parameters:

authenticationID - Unique identifier of an authentication resource. (required)

authenticationUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateDestination

public DestinationUpdateResponse updateDestination(@Nonnull
 String destinationID,
 @Nonnull
 DestinationUpdate destinationUpdate,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

Updates the destination by its ID.

Parameters:

destinationID - Unique identifier of a destination. (required)

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

updateDestination

public DestinationUpdateResponse updateDestination(@Nonnull
 String destinationID,
 @Nonnull
 DestinationUpdate destinationUpdate)
                                            throws AlgoliaRuntimeException

Updates the destination by its ID.

Parameters:

destinationID - Unique identifier of a destination. (required)

destinationUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateDestinationAsync

public CompletableFuture<DestinationUpdateResponse> updateDestinationAsync(@Nonnull
 String destinationID,
 @Nonnull
 DestinationUpdate destinationUpdate,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Updates the destination by its ID.

Parameters:

destinationID - Unique identifier of a destination. (required)

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

updateDestinationAsync

public CompletableFuture<DestinationUpdateResponse> updateDestinationAsync(@Nonnull
 String destinationID,
 @Nonnull
 DestinationUpdate destinationUpdate)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Updates the destination by its ID.

Parameters:

destinationID - Unique identifier of a destination. (required)

destinationUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateSource

public SourceUpdateResponse updateSource(@Nonnull
 String sourceID,
 @Nonnull
 SourceUpdate sourceUpdate,
 RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Updates a source by its ID.

Parameters:

sourceID - Unique identifier of a source. (required)

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

updateSource

public SourceUpdateResponse updateSource(@Nonnull
 String sourceID,
 @Nonnull
 SourceUpdate sourceUpdate)
                                  throws AlgoliaRuntimeException

Updates a source by its ID.

Parameters:

sourceID - Unique identifier of a source. (required)

sourceUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateSourceAsync

public CompletableFuture<SourceUpdateResponse> updateSourceAsync(@Nonnull
 String sourceID,
 @Nonnull
 SourceUpdate sourceUpdate,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) Updates a source by its ID.

Parameters:

sourceID - Unique identifier of a source. (required)

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

updateSourceAsync

public CompletableFuture<SourceUpdateResponse> updateSourceAsync(@Nonnull
 String sourceID,
 @Nonnull
 SourceUpdate sourceUpdate)
                                                          throws AlgoliaRuntimeException

(asynchronously) Updates a source by its ID.

Parameters:

sourceID - Unique identifier of a source. (required)

sourceUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateTask

public TaskUpdateResponse updateTask(@Nonnull
 String taskID,
 @Nonnull
 TaskUpdate taskUpdate,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Updates a task by its ID.

Parameters:

taskID - Unique identifier of a task. (required)

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

updateTask

public TaskUpdateResponse updateTask(@Nonnull
 String taskID,
 @Nonnull
 TaskUpdate taskUpdate)
                              throws AlgoliaRuntimeException

Updates a task by its ID.

Parameters:

taskID - Unique identifier of a task. (required)

taskUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateTaskAsync

public CompletableFuture<TaskUpdateResponse> updateTaskAsync(@Nonnull
 String taskID,
 @Nonnull
 TaskUpdate taskUpdate,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Updates a task by its ID.

Parameters:

taskID - Unique identifier of a task. (required)

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

updateTaskAsync

public CompletableFuture<TaskUpdateResponse> updateTaskAsync(@Nonnull
 String taskID,
 @Nonnull
 TaskUpdate taskUpdate)
                                                      throws AlgoliaRuntimeException

(asynchronously) Updates a task by its ID.

Parameters:

taskID - Unique identifier of a task. (required)

taskUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateTaskV1

public TaskUpdateResponse updateTaskV1(@Nonnull
 String taskID,
 @Nonnull
 TaskUpdateV1 taskUpdate,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

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

updateTaskV1

public TaskUpdateResponse updateTaskV1(@Nonnull
 String taskID,
 @Nonnull
 TaskUpdateV1 taskUpdate)
                                throws AlgoliaRuntimeException

Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

taskUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateTaskV1Async

public CompletableFuture<TaskUpdateResponse> updateTaskV1Async(@Nonnull
 String taskID,
 @Nonnull
 TaskUpdateV1 taskUpdate,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

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

updateTaskV1Async

public CompletableFuture<TaskUpdateResponse> updateTaskV1Async(@Nonnull
 String taskID,
 @Nonnull
 TaskUpdateV1 taskUpdate)
                                                        throws AlgoliaRuntimeException

(asynchronously) Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.

Parameters:

taskID - Unique identifier of a task. (required)

taskUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateTransformation

public TransformationUpdateResponse updateTransformation(@Nonnull
 String transformationID,
 @Nonnull
 TransformationCreate transformationCreate,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Updates a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (required)

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

updateTransformation

public TransformationUpdateResponse updateTransformation(@Nonnull
 String transformationID,
 @Nonnull
 TransformationCreate transformationCreate)
                                                  throws AlgoliaRuntimeException

Updates a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (required)

transformationCreate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateTransformationAsync

public CompletableFuture<TransformationUpdateResponse> updateTransformationAsync(@Nonnull
 String transformationID,
 @Nonnull
 TransformationCreate transformationCreate,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Updates a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (required)

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

updateTransformationAsync

public CompletableFuture<TransformationUpdateResponse> updateTransformationAsync(@Nonnull
 String transformationID,
 @Nonnull
 TransformationCreate transformationCreate)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Updates a transformation by its ID.

Parameters:

transformationID - Unique identifier of a transformation. (required)

transformationCreate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

validateSource

public SourceWatchResponse validateSource(SourceCreate sourceCreate,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

Parameters:

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

validateSource

public SourceWatchResponse validateSource(SourceCreate sourceCreate)
                                   throws AlgoliaRuntimeException

Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

Parameters:

sourceCreate - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

validateSource

public SourceWatchResponse validateSource(RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

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

validateSource

public SourceWatchResponse validateSource()
                                   throws AlgoliaRuntimeException

Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

validateSourceAsync

public CompletableFuture<SourceWatchResponse> validateSourceAsync(SourceCreate sourceCreate,
 RequestOptions requestOptions)
                                                           throws AlgoliaRuntimeException

(asynchronously) Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

Parameters:

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

validateSourceAsync

public CompletableFuture<SourceWatchResponse> validateSourceAsync(SourceCreate sourceCreate)
                                                           throws AlgoliaRuntimeException

(asynchronously) Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

Parameters:

sourceCreate - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

validateSourceAsync

public CompletableFuture<SourceWatchResponse> validateSourceAsync(RequestOptions requestOptions)
                                                           throws AlgoliaRuntimeException

(asynchronously) Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

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

validateSourceAsync

public CompletableFuture<SourceWatchResponse> validateSourceAsync()
                                                           throws AlgoliaRuntimeException

(asynchronously) Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

validateSourceBeforeUpdate

public SourceWatchResponse validateSourceBeforeUpdate(@Nonnull
 String sourceID,
 @Nonnull
 SourceUpdate sourceUpdate,
 RequestOptions requestOptions)
                                               throws AlgoliaRuntimeException

Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.

Parameters:

sourceID - Unique identifier of a source. (required)

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

validateSourceBeforeUpdate

public SourceWatchResponse validateSourceBeforeUpdate(@Nonnull
 String sourceID,
 @Nonnull
 SourceUpdate sourceUpdate)
                                               throws AlgoliaRuntimeException

Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.

Parameters:

sourceID - Unique identifier of a source. (required)

sourceUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

validateSourceBeforeUpdateAsync

public CompletableFuture<SourceWatchResponse> validateSourceBeforeUpdateAsync(@Nonnull
 String sourceID,
 @Nonnull
 SourceUpdate sourceUpdate,
 RequestOptions requestOptions)
                                                                       throws AlgoliaRuntimeException

(asynchronously) Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.

Parameters:

sourceID - Unique identifier of a source. (required)

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

validateSourceBeforeUpdateAsync

public CompletableFuture<SourceWatchResponse> validateSourceBeforeUpdateAsync(@Nonnull
 String sourceID,
 @Nonnull
 SourceUpdate sourceUpdate)
                                                                       throws AlgoliaRuntimeException

(asynchronously) Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.

Parameters:

sourceID - Unique identifier of a source. (required)

sourceUpdate - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call