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.
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.
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	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.
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.
ListAuthenticationsResponse	getAuthentications()	Retrieves a list of all authentication resources.
ListAuthenticationsResponse	getAuthentications(RequestOptions requestOptions)	Retrieves a list of all authentication resources.
ListAuthenticationsResponse	getAuthentications(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order)	Retrieves a list of all authentication resources.
ListAuthenticationsResponse	getAuthentications(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>	getAuthenticationsAsync()	(asynchronously) Retrieves a list of all authentication resources.
CompletableFuture<ListAuthenticationsResponse>	getAuthenticationsAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of all authentication resources.
CompletableFuture<ListAuthenticationsResponse>	getAuthenticationsAsync(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of all authentication resources.
CompletableFuture<ListAuthenticationsResponse>	getAuthenticationsAsync(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of all authentication resources.
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.
ListDestinationsResponse	getDestinations()	Retrieves a list of destinations.
ListDestinationsResponse	getDestinations(RequestOptions requestOptions)	Retrieves a list of destinations.
ListDestinationsResponse	getDestinations(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, DestinationSortKeys sort, OrderKeys order)	Retrieves a list of destinations.
ListDestinationsResponse	getDestinations(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, DestinationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	Retrieves a list of destinations.
CompletableFuture<ListDestinationsResponse>	getDestinationsAsync()	(asynchronously) Retrieves a list of destinations.
CompletableFuture<ListDestinationsResponse>	getDestinationsAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of destinations.
CompletableFuture<ListDestinationsResponse>	getDestinationsAsync(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, DestinationSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of destinations.
CompletableFuture<ListDestinationsResponse>	getDestinationsAsync(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, DestinationSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of destinations.
DockerSourceStreams	getDockerSourceStreams(String sourceID)	Retrieves a stream listing for a source.
DockerSourceStreams	getDockerSourceStreams(String sourceID, RequestOptions requestOptions)	Retrieves a stream listing for a source.
CompletableFuture<DockerSourceStreams>	getDockerSourceStreamsAsync(String sourceID)	(asynchronously) Retrieves a stream listing for a source.
CompletableFuture<DockerSourceStreams>	getDockerSourceStreamsAsync(String sourceID, RequestOptions requestOptions)	(asynchronously) Retrieves a stream listing for a source.
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.
ListEventsResponse	getEvents(String runID)	Retrieves a list of events for a task run, identified by it's ID.
ListEventsResponse	getEvents(String runID, RequestOptions requestOptions)	Retrieves a list of events for a task run, identified by it's ID.
ListEventsResponse	getEvents(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 it's ID.
ListEventsResponse	getEvents(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 it's ID.
CompletableFuture<ListEventsResponse>	getEventsAsync(String runID)	(asynchronously) Retrieves a list of events for a task run, identified by it's ID.
CompletableFuture<ListEventsResponse>	getEventsAsync(String runID, RequestOptions requestOptions)	(asynchronously) Retrieves a list of events for a task run, identified by it's ID.
CompletableFuture<ListEventsResponse>	getEventsAsync(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 it's ID.
CompletableFuture<ListEventsResponse>	getEventsAsync(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 it's 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.
RunListResponse	getRuns()	Retrieve a list of task runs.
RunListResponse	getRuns(RequestOptions requestOptions)	Retrieve a list of task runs.
RunListResponse	getRuns(Integer itemsPerPage, Integer page, List<RunStatus> status, String taskID, RunSortKeys sort, OrderKeys order, String startDate, String endDate)	Retrieve a list of task runs.
RunListResponse	getRuns(Integer itemsPerPage, Integer page, List<RunStatus> status, String taskID, RunSortKeys sort, OrderKeys order, String startDate, String endDate, RequestOptions requestOptions)	Retrieve a list of task runs.
CompletableFuture<RunListResponse>	getRunsAsync()	(asynchronously) Retrieve a list of task runs.
CompletableFuture<RunListResponse>	getRunsAsync(RequestOptions requestOptions)	(asynchronously) Retrieve a list of task runs.
CompletableFuture<RunListResponse>	getRunsAsync(Integer itemsPerPage, Integer page, List<RunStatus> status, String taskID, RunSortKeys sort, OrderKeys order, String startDate, String endDate)	(asynchronously) Retrieve a list of task runs.
CompletableFuture<RunListResponse>	getRunsAsync(Integer itemsPerPage, Integer page, List<RunStatus> status, String taskID, RunSortKeys sort, OrderKeys order, String startDate, String endDate, RequestOptions requestOptions)	(asynchronously) Retrieve a list of task runs.
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.
ListSourcesResponse	getSources()	Retrieves a list of sources.
ListSourcesResponse	getSources(RequestOptions requestOptions)	Retrieves a list of sources.
ListSourcesResponse	getSources(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order)	Retrieves a list of sources.
ListSourcesResponse	getSources(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order, RequestOptions requestOptions)	Retrieves a list of sources.
CompletableFuture<ListSourcesResponse>	getSourcesAsync()	(asynchronously) Retrieves a list of sources.
CompletableFuture<ListSourcesResponse>	getSourcesAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of sources.
CompletableFuture<ListSourcesResponse>	getSourcesAsync(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order)	(asynchronously) Retrieves a list of sources.
CompletableFuture<ListSourcesResponse>	getSourcesAsync(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order, RequestOptions requestOptions)	(asynchronously) Retrieves a list of sources.
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.
ListTasksResponse	getTasks()	Retrieves a list of tasks.
ListTasksResponse	getTasks(RequestOptions requestOptions)	Retrieves a list of tasks.
ListTasksResponse	getTasks(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.
ListTasksResponse	getTasks(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.
CompletableFuture<ListTasksResponse>	getTasksAsync()	(asynchronously) Retrieves a list of tasks.
CompletableFuture<ListTasksResponse>	getTasksAsync(RequestOptions requestOptions)	(asynchronously) Retrieves a list of tasks.
CompletableFuture<ListTasksResponse>	getTasksAsync(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.
CompletableFuture<ListTasksResponse>	getTasksAsync(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.
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.
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.
DockerSourceDiscover	triggerDockerSourceDiscover(String sourceID)	Triggers a stream-listing request for a source.
DockerSourceDiscover	triggerDockerSourceDiscover(String sourceID, RequestOptions requestOptions)	Triggers a stream-listing request for a source.
CompletableFuture<DockerSourceDiscover>	triggerDockerSourceDiscoverAsync(String sourceID)	(asynchronously) Triggers a stream-listing request for a source.
CompletableFuture<DockerSourceDiscover>	triggerDockerSourceDiscoverAsync(String sourceID, RequestOptions requestOptions)	(asynchronously) Triggers a stream-listing request for a source.
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.

Methods inherited from class com.algolia.ApiClient

close, executeAsync, executeAsync

Methods inherited from class java.lang.Object

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

Constructor Details

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

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

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

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

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

getAuthentications

public ListAuthenticationsResponse getAuthentications(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 authentication resources. (optional)

sort - Property by which to sort the list of authentication resources. (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

getAuthentications

public ListAuthenticationsResponse getAuthentications(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 authentication resources. (optional)

sort - Property by which to sort the list of authentication resources. (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

getAuthentications

public ListAuthenticationsResponse getAuthentications(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

getAuthentications

public ListAuthenticationsResponse getAuthentications()
                                               throws AlgoliaRuntimeException

Retrieves a list of all authentication resources.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAuthenticationsAsync

public CompletableFuture<ListAuthenticationsResponse> getAuthenticationsAsync(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 authentication resources. (optional)

sort - Property by which to sort the list of authentication resources. (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

getAuthenticationsAsync

public CompletableFuture<ListAuthenticationsResponse> getAuthenticationsAsync(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 authentication resources. (optional)

sort - Property by which to sort the list of authentication resources. (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

getAuthenticationsAsync

public CompletableFuture<ListAuthenticationsResponse> getAuthenticationsAsync(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

getAuthenticationsAsync

public CompletableFuture<ListAuthenticationsResponse> getAuthenticationsAsync()
                                                                       throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of all authentication resources.

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

getDestinations

public ListDestinationsResponse getDestinations(Integer itemsPerPage,
 Integer page,
 List<DestinationType> type,
 List<String> authenticationID,
 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)

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

getDestinations

public ListDestinationsResponse getDestinations(Integer itemsPerPage,
 Integer page,
 List<DestinationType> type,
 List<String> authenticationID,
 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)

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

getDestinations

public ListDestinationsResponse getDestinations(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

getDestinations

public ListDestinationsResponse getDestinations()
                                         throws AlgoliaRuntimeException

Retrieves a list of destinations.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDestinationsAsync

public CompletableFuture<ListDestinationsResponse> getDestinationsAsync(Integer itemsPerPage,
 Integer page,
 List<DestinationType> type,
 List<String> authenticationID,
 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)

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

getDestinationsAsync

public CompletableFuture<ListDestinationsResponse> getDestinationsAsync(Integer itemsPerPage,
 Integer page,
 List<DestinationType> type,
 List<String> authenticationID,
 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)

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

getDestinationsAsync

public CompletableFuture<ListDestinationsResponse> getDestinationsAsync(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

getDestinationsAsync

public CompletableFuture<ListDestinationsResponse> getDestinationsAsync()
                                                                 throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of destinations.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDockerSourceStreams

public DockerSourceStreams getDockerSourceStreams(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                                           throws AlgoliaRuntimeException

Retrieves a stream listing for a source. Listing streams 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

getDockerSourceStreams

public DockerSourceStreams getDockerSourceStreams(@Nonnull
 String sourceID)
                                           throws AlgoliaRuntimeException

Retrieves a stream listing for a source. Listing streams 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

getDockerSourceStreamsAsync

public CompletableFuture<DockerSourceStreams> getDockerSourceStreamsAsync(@Nonnull
 String sourceID,
 RequestOptions requestOptions)
                                                                   throws AlgoliaRuntimeException

(asynchronously) Retrieves a stream listing for a source. Listing streams 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

getDockerSourceStreamsAsync

public CompletableFuture<DockerSourceStreams> getDockerSourceStreamsAsync(@Nonnull
 String sourceID)
                                                                   throws AlgoliaRuntimeException

(asynchronously) Retrieves a stream listing for a source. Listing streams 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

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

getEvents

public ListEventsResponse getEvents(@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 it's 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 RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. (optional)

endDate - Date and time in RFC3339 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

getEvents

public ListEventsResponse getEvents(@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 it's 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 RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. (optional)

endDate - Date and time in RFC3339 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

getEvents

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

Retrieves a list of events for a task run, identified by it's 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

getEvents

public ListEventsResponse getEvents(@Nonnull
 String runID)
                             throws AlgoliaRuntimeException

Retrieves a list of events for a task run, identified by it's ID.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getEventsAsync

public CompletableFuture<ListEventsResponse> getEventsAsync(@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 it's 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 RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. (optional)

endDate - Date and time in RFC3339 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

getEventsAsync

public CompletableFuture<ListEventsResponse> getEventsAsync(@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 it's 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 RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. (optional)

endDate - Date and time in RFC3339 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

getEventsAsync

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

(asynchronously) Retrieves a list of events for a task run, identified by it's 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

getEventsAsync

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

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

Parameters:

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

getRuns

public RunListResponse getRuns(Integer itemsPerPage,
 Integer page,
 List<RunStatus> status,
 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)

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 RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. (optional)

endDate - Date in RFC3339 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

getRuns

public RunListResponse getRuns(Integer itemsPerPage,
 Integer page,
 List<RunStatus> status,
 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)

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 RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. (optional)

endDate - Date in RFC3339 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

getRuns

public RunListResponse getRuns(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

getRuns

public RunListResponse getRuns()
                        throws AlgoliaRuntimeException

Retrieve a list of task runs.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRunsAsync

public CompletableFuture<RunListResponse> getRunsAsync(Integer itemsPerPage,
 Integer page,
 List<RunStatus> status,
 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)

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 RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. (optional)

endDate - Date in RFC3339 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

getRunsAsync

public CompletableFuture<RunListResponse> getRunsAsync(Integer itemsPerPage,
 Integer page,
 List<RunStatus> status,
 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)

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 RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. (optional)

endDate - Date in RFC3339 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

getRunsAsync

public CompletableFuture<RunListResponse> getRunsAsync(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

getRunsAsync

public CompletableFuture<RunListResponse> getRunsAsync()
                                                throws AlgoliaRuntimeException

(asynchronously) Retrieve a list of task runs.

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

getSources

public ListSourcesResponse getSources(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 resource. (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

getSources

public ListSourcesResponse getSources(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 resource. (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

getSources

public ListSourcesResponse getSources(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

getSources

public ListSourcesResponse getSources()
                               throws AlgoliaRuntimeException

Retrieves a list of sources.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSourcesAsync

public CompletableFuture<ListSourcesResponse> getSourcesAsync(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 resource. (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

getSourcesAsync

public CompletableFuture<ListSourcesResponse> getSourcesAsync(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 resource. (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

getSourcesAsync

public CompletableFuture<ListSourcesResponse> getSourcesAsync(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

getSourcesAsync

public CompletableFuture<ListSourcesResponse> getSourcesAsync()
                                                       throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of sources.

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

getTasks

public ListTasksResponse getTasks(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.

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

getTasks

public ListTasksResponse getTasks(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.

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

getTasks

public ListTasksResponse getTasks(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

getTasks

public ListTasksResponse getTasks()
                           throws AlgoliaRuntimeException

Retrieves a list of tasks.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTasksAsync

public CompletableFuture<ListTasksResponse> getTasksAsync(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.

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

getTasksAsync

public CompletableFuture<ListTasksResponse> getTasksAsync(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.

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

getTasksAsync

public CompletableFuture<ListTasksResponse> getTasksAsync(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

getTasksAsync

public CompletableFuture<ListTasksResponse> getTasksAsync()
                                                   throws AlgoliaRuntimeException

(asynchronously) Retrieves a list of tasks.

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

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

triggerDockerSourceDiscover

public DockerSourceDiscover 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 DockerSourceDiscover 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<DockerSourceDiscover> 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<DockerSourceDiscover> 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

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