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 Details

  • Method Details

    • createAuthentication

      public AuthenticationCreateResponse createAuthentication(@Nonnull AuthenticationCreate authenticationCreate, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Create a authentication.
      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
      Create a authentication.
      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) Create a authentication.
      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) Create a authentication.
      Parameters:
      authenticationCreate - (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • createDestination

      public DestinationCreateResponse createDestination(@Nonnull DestinationCreate destinationCreate, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Create a 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
      Create a 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) Create a 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) Create a 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
      Create a 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
      Create a 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) Create a 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) Create a 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
      Create a task.
      Parameters:
      taskCreate - (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
      Create a task.
      Parameters:
      taskCreate - (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • createTaskAsync

      public CompletableFuture<TaskCreateResponse> createTaskAsync(@Nonnull TaskCreate taskCreate, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Create a task.
      Parameters:
      taskCreate - (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) Create a task.
      Parameters:
      taskCreate - (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
      Soft delete the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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
      Soft delete the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • deleteAuthenticationAsync

      public CompletableFuture<DeleteResponse> deleteAuthenticationAsync(@Nonnull String authenticationID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Soft delete the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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) Soft delete the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • deleteDestination

      public DeleteResponse deleteDestination(@Nonnull String destinationID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Soft delete the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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
      Soft delete the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • deleteDestinationAsync

      public CompletableFuture<DeleteResponse> deleteDestinationAsync(@Nonnull String destinationID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Soft delete the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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) Soft delete the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • deleteSource

      public DeleteResponse deleteSource(@Nonnull String sourceID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Soft delete the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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
      Soft delete the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • deleteSourceAsync

      public CompletableFuture<DeleteResponse> deleteSourceAsync(@Nonnull String sourceID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Soft delete the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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) Soft delete the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • deleteTask

      public DeleteResponse deleteTask(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Soft delete the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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
      Soft delete the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • deleteTaskAsync

      public CompletableFuture<DeleteResponse> deleteTaskAsync(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Soft delete the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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) Soft delete the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • disableTask

      public TaskUpdateResponse disableTask(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Disable the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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
      Disable the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • disableTaskAsync

      public CompletableFuture<TaskUpdateResponse> disableTaskAsync(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Disable the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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) Disable the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • enableTask

      public TaskUpdateResponse enableTask(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Enable the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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
      Enable the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • enableTaskAsync

      public CompletableFuture<TaskUpdateResponse> enableTaskAsync(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Enable the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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) Enable the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getAuthentication

      public Authentication getAuthentication(@Nonnull String authenticationID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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
      Get the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getAuthenticationAsync

      public CompletableFuture<Authentication> getAuthenticationAsync(@Nonnull String authenticationID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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) Get the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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
      Get a list of authentications for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the authentications to retrieve. (optional)
      platform - The platform of the authentications to retrieve. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (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

    • getAuthentications

      public ListAuthenticationsResponse getAuthentications(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order) throws AlgoliaRuntimeException
      Get a list of authentications for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the authentications to retrieve. (optional)
      platform - The platform of the authentications to retrieve. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getAuthentications

      public ListAuthenticationsResponse getAuthentications(RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get a list of authentications for the given query parameters, with pagination details.
      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
      Get a list of authentications for the given query parameters, with pagination details.
      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) Get a list of authentications for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the authentications to retrieve. (optional)
      platform - The platform of the authentications to retrieve. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (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

    • getAuthenticationsAsync

      public CompletableFuture<ListAuthenticationsResponse> getAuthenticationsAsync(Integer itemsPerPage, Integer page, List<AuthenticationType> type, List<PlatformWithNone> platform, AuthenticationSortKeys sort, OrderKeys order) throws AlgoliaRuntimeException
      (asynchronously) Get a list of authentications for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the authentications to retrieve. (optional)
      platform - The platform of the authentications to retrieve. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getAuthenticationsAsync

      public CompletableFuture<ListAuthenticationsResponse> getAuthenticationsAsync(RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get a list of authentications for the given query parameters, with pagination details.
      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) Get a list of authentications for the given query parameters, with pagination details.
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getDestination

      public Destination getDestination(@Nonnull String destinationID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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
      Get the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getDestinationAsync

      public CompletableFuture<Destination> getDestinationAsync(@Nonnull String destinationID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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) Get the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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
      Get a list of destinations for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the destinations to retrive. (optional)
      authenticationID - The authenticationIDs of the destinations to retrive. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (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

    • getDestinations

      public ListDestinationsResponse getDestinations(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, DestinationSortKeys sort, OrderKeys order) throws AlgoliaRuntimeException
      Get a list of destinations for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the destinations to retrive. (optional)
      authenticationID - The authenticationIDs of the destinations to retrive. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getDestinations

      public ListDestinationsResponse getDestinations(RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get a list of destinations for the given query parameters, with pagination details.
      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
      Get a list of destinations for the given query parameters, with pagination details.
      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) Get a list of destinations for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the destinations to retrive. (optional)
      authenticationID - The authenticationIDs of the destinations to retrive. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (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

    • getDestinationsAsync

      public CompletableFuture<ListDestinationsResponse> getDestinationsAsync(Integer itemsPerPage, Integer page, List<DestinationType> type, List<String> authenticationID, DestinationSortKeys sort, OrderKeys order) throws AlgoliaRuntimeException
      (asynchronously) Get a list of destinations for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the destinations to retrive. (optional)
      authenticationID - The authenticationIDs of the destinations to retrive. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getDestinationsAsync

      public CompletableFuture<ListDestinationsResponse> getDestinationsAsync(RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get a list of destinations for the given query parameters, with pagination details.
      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) Get a list of destinations for the given query parameters, with pagination details.
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getDockerSourceStreams

      public DockerSourceStreams getDockerSourceStreams(@Nonnull String sourceID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Retrieve a stream listing for a given Singer specification compatible docker type source ID.
      Parameters:
      sourceID - The source UUID. (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
      Retrieve a stream listing for a given Singer specification compatible docker type source ID.
      Parameters:
      sourceID - The source UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getDockerSourceStreamsAsync

      public CompletableFuture<DockerSourceStreams> getDockerSourceStreamsAsync(@Nonnull String sourceID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Retrieve a stream listing for a given Singer specification compatible docker type source ID.
      Parameters:
      sourceID - The source UUID. (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) Retrieve a stream listing for a given Singer specification compatible docker type source ID.
      Parameters:
      sourceID - The source UUID. (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
      Get a single event for a specific runID.
      Parameters:
      runID - The run UUID. (required)
      eventID - The event UUID. (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
      Get a single event for a specific runID.
      Parameters:
      runID - The run UUID. (required)
      eventID - The event UUID. (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) Get a single event for a specific runID.
      Parameters:
      runID - The run UUID. (required)
      eventID - The event UUID. (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) Get a single event for a specific runID.
      Parameters:
      runID - The run UUID. (required)
      eventID - The event UUID. (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
      Get a list of events associated to the given runID, for the given query parameters.
      Parameters:
      runID - The run UUID. (required)
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      status - Filter the status of the events. (optional)
      type - Filter the type of the events. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      startDate - The start date (in RFC3339 format) of the events fetching window. Defaults to 'now'-3 hours if omitted. (optional)
      endDate - The end date (in RFC3339 format) of the events fetching window. Defaults to 'now' days if omitted. (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
      Get a list of events associated to the given runID, for the given query parameters.
      Parameters:
      runID - The run UUID. (required)
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      status - Filter the status of the events. (optional)
      type - Filter the type of the events. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      startDate - The start date (in RFC3339 format) of the events fetching window. Defaults to 'now'-3 hours if omitted. (optional)
      endDate - The end date (in RFC3339 format) of the events fetching window. Defaults to 'now' days if omitted. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getEvents

      public ListEventsResponse getEvents(@Nonnull String runID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get a list of events associated to the given runID, for the given query parameters.
      Parameters:
      runID - The run UUID. (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
      Get a list of events associated to the given runID, for the given query parameters.
      Parameters:
      runID - The run UUID. (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) Get a list of events associated to the given runID, for the given query parameters.
      Parameters:
      runID - The run UUID. (required)
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      status - Filter the status of the events. (optional)
      type - Filter the type of the events. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      startDate - The start date (in RFC3339 format) of the events fetching window. Defaults to 'now'-3 hours if omitted. (optional)
      endDate - The end date (in RFC3339 format) of the events fetching window. Defaults to 'now' days if omitted. (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) Get a list of events associated to the given runID, for the given query parameters.
      Parameters:
      runID - The run UUID. (required)
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      status - Filter the status of the events. (optional)
      type - Filter the type of the events. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      startDate - The start date (in RFC3339 format) of the events fetching window. Defaults to 'now'-3 hours if omitted. (optional)
      endDate - The end date (in RFC3339 format) of the events fetching window. Defaults to 'now' days if omitted. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getEventsAsync

      public CompletableFuture<ListEventsResponse> getEventsAsync(@Nonnull String runID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get a list of events associated to the given runID, for the given query parameters.
      Parameters:
      runID - The run UUID. (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) Get a list of events associated to the given runID, for the given query parameters.
      Parameters:
      runID - The run UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getRun

      public Run getRun(@Nonnull String runID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get a single run for the given ID.
      Parameters:
      runID - The run UUID. (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
      Get a single run for the given ID.
      Parameters:
      runID - The run UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getRunAsync

      public CompletableFuture<Run> getRunAsync(@Nonnull String runID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get a single run for the given ID.
      Parameters:
      runID - The run UUID. (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) Get a single run for the given ID.
      Parameters:
      runID - The run UUID. (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
      Get a list of runs for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      status - Filter the status of the runs. (optional)
      taskID - Filter by taskID. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      startDate - The start date (in RFC3339 format) of the runs fetching window. Defaults to 'now'-7 days if omitted. (optional)
      endDate - The end date (in RFC3339 format) of the runs fetching window. Defaults to 'now' days if omitted. (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
      Get a list of runs for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      status - Filter the status of the runs. (optional)
      taskID - Filter by taskID. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      startDate - The start date (in RFC3339 format) of the runs fetching window. Defaults to 'now'-7 days if omitted. (optional)
      endDate - The end date (in RFC3339 format) of the runs fetching window. Defaults to 'now' days if omitted. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getRuns

      public RunListResponse getRuns(RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get a list of runs for the given query parameters, with pagination details.
      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
      Get a list of runs for the given query parameters, with pagination details.
      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) Get a list of runs for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      status - Filter the status of the runs. (optional)
      taskID - Filter by taskID. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      startDate - The start date (in RFC3339 format) of the runs fetching window. Defaults to 'now'-7 days if omitted. (optional)
      endDate - The end date (in RFC3339 format) of the runs fetching window. Defaults to 'now' days if omitted. (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) Get a list of runs for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      status - Filter the status of the runs. (optional)
      taskID - Filter by taskID. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      startDate - The start date (in RFC3339 format) of the runs fetching window. Defaults to 'now'-7 days if omitted. (optional)
      endDate - The end date (in RFC3339 format) of the runs fetching window. Defaults to 'now' days if omitted. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getRunsAsync

      public CompletableFuture<RunListResponse> getRunsAsync(RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get a list of runs for the given query parameters, with pagination details.
      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) Get a list of runs for the given query parameters, with pagination details.
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSource

      public Source getSource(@Nonnull String sourceID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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
      Get the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSourceAsync

      public CompletableFuture<Source> getSourceAsync(@Nonnull String sourceID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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) Get the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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
      Get a list of sources for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the sources to retrieve. (optional)
      authenticationID - The authenticationIDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (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

    • getSources

      public ListSourcesResponse getSources(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order) throws AlgoliaRuntimeException
      Get a list of sources for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the sources to retrieve. (optional)
      authenticationID - The authenticationIDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSources

      public ListSourcesResponse getSources(RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get a list of sources for the given query parameters, with pagination details.
      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
      Get a list of sources for the given query parameters, with pagination details.
      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) Get a list of sources for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the sources to retrieve. (optional)
      authenticationID - The authenticationIDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (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

    • getSourcesAsync

      public CompletableFuture<ListSourcesResponse> getSourcesAsync(Integer itemsPerPage, Integer page, List<SourceType> type, List<String> authenticationID, SourceSortKeys sort, OrderKeys order) throws AlgoliaRuntimeException
      (asynchronously) Get a list of sources for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      type - The type of the sources to retrieve. (optional)
      authenticationID - The authenticationIDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSourcesAsync

      public CompletableFuture<ListSourcesResponse> getSourcesAsync(RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get a list of sources for the given query parameters, with pagination details.
      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) Get a list of sources for the given query parameters, with pagination details.
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTask

      public Task getTask(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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
      Get the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTaskAsync

      public CompletableFuture<Task> getTaskAsync(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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) Get the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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
      Get a list of tasks for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      action - The action of the tasks to retrieve. (optional)
      enabled - Whether the task is enabled or not. (optional)
      sourceID - The sourceIDs of the tasks to retrive. (optional)
      destinationID - The destinationIDs of the tasks to retrive. (optional)
      triggerType - The trigger type of the task. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (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

    • 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
      Get a list of tasks for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      action - The action of the tasks to retrieve. (optional)
      enabled - Whether the task is enabled or not. (optional)
      sourceID - The sourceIDs of the tasks to retrive. (optional)
      destinationID - The destinationIDs of the tasks to retrive. (optional)
      triggerType - The trigger type of the task. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTasks

      public ListTasksResponse getTasks(RequestOptions requestOptions) throws AlgoliaRuntimeException
      Get a list of tasks for the given query parameters, with pagination details.
      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
      Get a list of tasks for the given query parameters, with pagination details.
      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) Get a list of tasks for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      action - The action of the tasks to retrieve. (optional)
      enabled - Whether the task is enabled or not. (optional)
      sourceID - The sourceIDs of the tasks to retrive. (optional)
      destinationID - The destinationIDs of the tasks to retrive. (optional)
      triggerType - The trigger type of the task. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (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

    • 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) Get a list of tasks for the given query parameters, with pagination details.
      Parameters:
      itemsPerPage - The number of items per page to return. (optional)
      page - The page number to fetch, starting at 1. (optional)
      action - The action of the tasks to retrieve. (optional)
      enabled - Whether the task is enabled or not. (optional)
      sourceID - The sourceIDs of the tasks to retrive. (optional)
      destinationID - The destinationIDs of the tasks to retrive. (optional)
      triggerType - The trigger type of the task. (optional)
      sort - The key by which the list should be sorted. (optional)
      order - The order of the returned list. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTasksAsync

      public CompletableFuture<ListTasksResponse> getTasksAsync(RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Get a list of tasks for the given query parameters, with pagination details.
      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) Get a list of tasks for the given query parameters, with pagination details.
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • runTask

      public RunResponse runTask(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Run the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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
      Run the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • runTaskAsync

      public CompletableFuture<RunResponse> runTaskAsync(@Nonnull String taskID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Run the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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) Run the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • searchAuthentications

      public List<Authentication> searchAuthentications(@Nonnull AuthenticationSearch authenticationSearch, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Search among authentications with a defined set of parameters.
      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
      Search among authentications with a defined set of parameters.
      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) Search among authentications with a defined set of parameters.
      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) Search among authentications with a defined set of parameters.
      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
      Search among destinations with a defined set of parameters.
      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
      Search among destinations with a defined set of parameters.
      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) Search among destinations with a defined set of parameters.
      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) Search among destinations with a defined set of parameters.
      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
      Search among sources with a defined set of parameters.
      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
      Search among sources with a defined set of parameters.
      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) Search among sources with a defined set of parameters.
      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) Search among sources with a defined set of parameters.
      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
      Search among tasks with a defined set of parameters.
      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
      Search among tasks with a defined set of parameters.
      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) Search among tasks with a defined set of parameters.
      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) Search among tasks with a defined set of parameters.
      Parameters:
      taskSearch - (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • triggerDockerSourceDiscover

      public DockerSourceDiscover triggerDockerSourceDiscover(@Nonnull String sourceID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Trigger a stream listing request for a Singer specification compatible docker type source.
      Parameters:
      sourceID - The source UUID. (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
      Trigger a stream listing request for a Singer specification compatible docker type source.
      Parameters:
      sourceID - The source UUID. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • triggerDockerSourceDiscoverAsync

      public CompletableFuture<DockerSourceDiscover> triggerDockerSourceDiscoverAsync(@Nonnull String sourceID, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Trigger a stream listing request for a Singer specification compatible docker type source.
      Parameters:
      sourceID - The source UUID. (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) Trigger a stream listing request for a Singer specification compatible docker type source.
      Parameters:
      sourceID - The source UUID. (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
      Update the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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
      Update the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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) Update the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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) Update the authentication of the given authenticationID.
      Parameters:
      authenticationID - The authentication UUID. (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
      Update the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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
      Update the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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) Update the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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) Update the destination of the given destinationID.
      Parameters:
      destinationID - The destination UUID. (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
      Update the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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
      Update the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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) Update the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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) Update the source of the given sourceID.
      Parameters:
      sourceID - The source UUID. (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
      Update the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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
      Update the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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) Update the task of the given taskID.
      Parameters:
      taskID - The task UUID. (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) Update the task of the given taskID.
      Parameters:
      taskID - The task UUID. (required)
      taskUpdate - (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call