Add cancel task api for v0.30.0

src/main/java/com/meilisearch/sdk/Client.java

@@ -7,6 +7,7 @@
 import com.auth0.jwt.algorithms.Algorithm;
 import com.meilisearch.sdk.exceptions.MeilisearchException;
 import com.meilisearch.sdk.json.JsonHandler;
+import com.meilisearch.sdk.model.CancelTasksQuery;
 import com.meilisearch.sdk.model.IndexesQuery;
 import com.meilisearch.sdk.model.Key;
 import com.meilisearch.sdk.model.KeyUpdate;
@@ -253,6 +254,18 @@ public TasksResults getTasks(TasksQuery param) throws MeilisearchException {
         return this.tasksHandler.getTasks(param);
     }
 
+    /**
+     * Cancel any number of enqueued or processing tasks
+     * https://docs.meilisearch.com/reference/api/tasks.html#cancel-tasks
+     *
+     * @param param accept by the tasks route
+     * @return Meilisearch API response as TaskInfo
+     * @throws MeilisearchException if an error occurs
+     */
+    public TaskInfo cancelTasks(CancelTasksQuery param) throws MeilisearchException {
+        return this.tasksHandler.cancelTasks(param);
+    }
+
     /**
      * Waits for a task to be processed
      *

src/main/java/com/meilisearch/sdk/TasksHandler.java

@@ -3,7 +3,9 @@
 import com.meilisearch.sdk.exceptions.MeilisearchException;
 import com.meilisearch.sdk.exceptions.MeilisearchTimeoutException;
 import com.meilisearch.sdk.http.URLBuilder;
+import com.meilisearch.sdk.model.CancelTasksQuery;
 import com.meilisearch.sdk.model.Task;
+import com.meilisearch.sdk.model.TaskInfo;
 import com.meilisearch.sdk.model.TasksQuery;
 import com.meilisearch.sdk.model.TasksResults;
 import java.util.Date;
@@ -100,6 +102,20 @@ TasksResults getTasks(String indexUid, TasksQuery param) throws MeilisearchExcep
         return result;
     }
 
+    /**
+     * Delete tasks from the client
+     *
+     * @param param accept by the tasks route
+     * @return Meilisearch API response as TaskInfo
+     * @throws MeilisearchException if client request causes an error
+     */
+    TaskInfo cancelTasks(CancelTasksQuery param) throws MeilisearchException {
+        URLBuilder urlb = tasksPath().addSubroute("cancel");
+        TaskInfo result =
+                httpClient.post(urlb.addQuery(param.toQuery()).getURL(), null, TaskInfo.class);
+        return result;
+    }
+
     /**
      * Waits for a task to be processed
      *

src/main/java/com/meilisearch/sdk/model/CancelTasksQuery.java

@@ -0,0 +1,41 @@
+package com.meilisearch.sdk.model;
+
+import com.meilisearch.sdk.http.URLBuilder;
+import java.util.Date;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+/**
+ * Data structure of a query parameter for tasks route
+ *
+ * <p>https://docs.meilisearch.com/reference/api/tasks.html#query-parameters
+ */
+@Setter
+@Getter
+@Accessors(chain = true)
+public class CancelTasksQuery {
+    private int[] uids;
+    private String[] statuses;
+    private String[] types;
+    private String[] indexUids;
+    private Date beforeEnqueuedAt;
+    private Date afterEnqueuedAt;
+    private Date beforeStartedAt;
+    private Date afterStartedAt;
+
+    public CancelTasksQuery() {}
+
+    public String toQuery() {
+        URLBuilder urlb =
+                new URLBuilder()
+                        .addParameter("statuses", this.getStatuses())
+                        .addParameter("types", this.getTypes())
+                        .addParameter("indexUids", this.getIndexUids())
+                        .addParameter("beforeEnqueuedAt", this.getBeforeEnqueuedAt())
+                        .addParameter("afterEnqueuedAt", this.getAfterEnqueuedAt())
+                        .addParameter("beforeStartedAt", this.getBeforeStartedAt())
+                        .addParameter("afterStartedAt", this.getAfterStartedAt());
+        return urlb.getURL();
+    }
+}

src/test/java/com/meilisearch/integration/TasksTest.java

@@ -5,6 +5,7 @@
 import com.meilisearch.integration.classes.AbstractIT;
 import com.meilisearch.integration.classes.TestData;
 import com.meilisearch.sdk.Index;
+import com.meilisearch.sdk.model.CancelTasksQuery;
 import com.meilisearch.sdk.model.Task;
 import com.meilisearch.sdk.model.TaskInfo;
 import com.meilisearch.sdk.model.TasksQuery;
@@ -117,6 +118,42 @@ public void testClientGetTasksAllQueryParameters() throws Exception {
         assertNotNull(result.getNext());
     }
 
+    /** Test Cancel Task */
+    @Test
+    public void testClientCancelTask() throws Exception {
+        CancelTasksQuery query =
+                new CancelTasksQuery().setStatuses(new String[] {"enqueued", "succeeded"});
+
+        TaskInfo task = client.cancelTasks(query);
+
+        assertTrue(task instanceof TaskInfo);
+        assertNotNull(task.getStatus());
+        assertNotEquals("", task.getStatus());
+        assertNull(task.getIndexUid());
+        assertEquals("taskCancelation", task.getType());
+    }
+
+    /** Test Cancel Task with multiple filters */
+    @Test
+    public void testClientCancelTaskWithMultipleFilters() throws Exception {
+        Date date = new Date();
+        CancelTasksQuery query =
+                new CancelTasksQuery()
+                        .setUids(new int[] {0, 1, 2})
+                        .setStatuses(new String[] {"enqueued", "succeeded"})
+                        .setTypes(new String[] {"indexDeletion"})
+                        .setIndexUids(new String[] {"index"})
+                        .setBeforeEnqueuedAt(date);
+
+        TaskInfo task = client.cancelTasks(query);
+
+        assertTrue(task instanceof TaskInfo);
+        assertNotNull(task.getStatus());
+        assertNotEquals("", task.getStatus());
+        assertNull(task.getIndexUid());
+        assertEquals("taskCancelation", task.getType());
+    }
+
     /** Test waitForTask */
     @Test
     public void testWaitForTask() throws Exception {