Merge pull request #516 from meilisearch/indexes_changes

Update Index API for Meilisearch v.28

Author: alallema

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.IndexesQuery;
 import com.meilisearch.sdk.model.Key;
 import com.meilisearch.sdk.model.Results;
 import com.meilisearch.sdk.model.Stats;
@@ -63,33 +64,46 @@ public TaskInfo createIndex(String uid) throws MeilisearchException {
      * @throws MeilisearchException if an error occurs
      */
     public TaskInfo createIndex(String uid, String primaryKey) throws MeilisearchException {
-        return this.indexesHandler.create(uid, primaryKey);
+        return this.indexesHandler.createIndex(uid, primaryKey);
     }
 
     /**
-     * Gets all indexes in the current Meilisearch instance
-     * https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
+     * Gets indexes https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
      *
-     * @return Array of indexes in the Meilisearch client
+     * @return Results containing a list of indexes from the Meilisearch API
      * @throws MeilisearchException if an error occurs
      */
-    public Index[] getIndexes() throws MeilisearchException {
-        Index[] indexes = jsonHandler.decode(getRawIndexes(), Index[].class);
-        for (Index index : indexes) {
+    public Results<Index> getIndexes() throws MeilisearchException {
+        Results<Index> indexes = this.indexesHandler.getIndexes();
+        for (Index index : indexes.getResults()) {
             index.setConfig(this.config);
         }
         return indexes;
     }
 
     /**
-     * Gets all indexes in the current Meilisearch instance
-     * https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
+     * Gets indexes https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
      *
-     * @return Meilisearch API response as String
+     * @param params query parameters accepted by the get indexes route
+     * @return Results containing a list of indexes from the Meilisearch API
+     * @throws MeilisearchException if an error occurs
+     */
+    public Results<Index> getIndexes(IndexesQuery params) throws MeilisearchException {
+        Results<Index> indexes = this.indexesHandler.getIndexes(params);
+        for (Index index : indexes.getResults()) {
+            index.setConfig(this.config);
+        }
+        return indexes;
+    }
+
+    /**
+     * Gets all indexes https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
+     *
+     * @return List of indexes from the Meilisearch API as String
      * @throws MeilisearchException if an error occurs
      */
     public String getRawIndexes() throws MeilisearchException {
-        return this.indexesHandler.getAll();
+        return this.indexesHandler.getRawIndexes();
     }
 
     /**
@@ -98,7 +112,7 @@ public String getRawIndexes() throws MeilisearchException {
      * methods in the Index class.
      *
      * @param uid Unique identifier of the index
-     * @return Index instance
+     * @return Meilisearch API response as Index instance
      * @throws MeilisearchException if an error occurs
      */
     public Index index(String uid) throws MeilisearchException {
@@ -113,29 +127,17 @@ public Index index(String uid) throws MeilisearchException {
      * https://docs.meilisearch.com/reference/api/indexes.html#get-one-index
      *
      * @param uid Unique identifier of the index to get
-     * @return Meilisearch API response
+     * @return Meilisearch API response as Index instance
      * @throws MeilisearchException if an error occurs
      */
     public Index getIndex(String uid) throws MeilisearchException {
-        Index index = jsonHandler.decode(getRawIndex(uid), Index.class);
+        Index index = this.indexesHandler.getIndex(uid);
         index.setConfig(this.config);
         return index;
     }
 
     /**
-     * Gets single index by its unique identifier
-     * https://docs.meilisearch.com/reference/api/indexes.html#get-one-index
-     *
-     * @param uid Unique identifier of the index to get
-     * @return Meilisearch API response as String
-     * @throws MeilisearchException if an error occurs
-     */
-    public String getRawIndex(String uid) throws MeilisearchException {
-        return this.indexesHandler.get(uid);
-    }
-
-    /**
-     * Updates the primary key of an index in the Meilisearch instance
+     * Updates the primary key of an index
      * https://docs.meilisearch.com/reference/api/indexes.html#update-an-index
      *
      * @param uid Unique identifier of the index to update
@@ -156,7 +158,7 @@ public TaskInfo updateIndex(String uid, String primaryKey) throws MeilisearchExc
      * @throws MeilisearchException if an error occurs
      */
     public TaskInfo deleteIndex(String uid) throws MeilisearchException {
-        return this.indexesHandler.delete(uid);
+        return this.indexesHandler.deleteIndex(uid);
     }
 
     /**
@@ -220,7 +222,7 @@ public String getVersion() throws MeilisearchException {
      * https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
      *
      * @param uid Identifier of the requested Task
-     * @return Task Instance
+     * @return Meilisearch API response as Task Instance
      * @throws MeilisearchException if an error occurs
      */
     public Task getTask(int uid) throws MeilisearchException {
@@ -230,7 +232,7 @@ public Task getTask(int uid) throws MeilisearchException {
     /**
      * Retrieves list of tasks https://docs.meilisearch.com/reference/api/tasks.html#get-tasks
      *
-     * @return List of tasks in the Meilisearch client
+     * @return TasksResults containing a list of tasks from the Meilisearch API
      * @throws MeilisearchException if an error occurs
      */
     public TasksResults getTasks() throws MeilisearchException {
@@ -241,7 +243,7 @@ public TasksResults getTasks() throws MeilisearchException {
      * Retrieves list of tasks https://docs.meilisearch.com/reference/api/tasks.html#get-tasks
      *
      * @param param accept by the tasks route
-     * @return List of tasks in the Meilisearch client
+     * @return TasksResults containing a list of tasks from the Meilisearch API
      * @throws MeilisearchException if an error occurs
      */
     public TasksResults getTasks(TasksQuery param) throws MeilisearchException {

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

@@ -1,6 +1,8 @@
 package com.meilisearch.sdk;
 
 import com.meilisearch.sdk.exceptions.MeilisearchException;
+import com.meilisearch.sdk.model.IndexesQuery;
+import com.meilisearch.sdk.model.Results;
 import com.meilisearch.sdk.model.TaskInfo;
 import java.util.HashMap;
 
@@ -25,23 +27,23 @@ class IndexesHandler {
     /**
      * Creates an index with a unique identifier
      *
-     * @param uid Unique identifier to create the index with
-     * @return Meilisearch API response
+     * @param uid Unique identifier of the index
+     * @return Meilisearch API response as TaskInfo
      * @throws MeilisearchException if an error occurs
      */
-    TaskInfo create(String uid) throws MeilisearchException {
-        return this.create(uid, null);
+    TaskInfo createIndex(String uid) throws MeilisearchException {
+        return this.createIndex(uid, null);
     }
 
     /**
      * Creates an index with a unique identifier
      *
-     * @param uid Unique identifier to create the index with
+     * @param uid Unique identifier of the index
      * @param primaryKey Field to use as the primary key for documents in that index
-     * @return Meilisearch API response
+     * @return Meilisearch API response as TaskInfo
      * @throws MeilisearchException if an error occurs
      */
-    TaskInfo create(String uid, String primaryKey) throws MeilisearchException {
+    TaskInfo createIndex(String uid, String primaryKey) throws MeilisearchException {
         HashMap<String, String> index = new HashMap<String, String>();
         index.put("uid", uid);
         index.put("primaryKey", primaryKey);
@@ -53,21 +55,41 @@ TaskInfo create(String uid, String primaryKey) throws MeilisearchException {
      * Gets an index from its uid
      *
      * @param uid Unique identifier of the index to get
-     * @return Meilisearch API response
+     * @return Meilisearch API response as Index instance
      * @throws MeilisearchException if an error occurs
      */
-    String get(String uid) throws MeilisearchException {
-        String requestQuery = "/indexes/" + uid;
-        return httpClient.get(requestQuery, String.class);
+    Index getIndex(String uid) throws MeilisearchException {
+        return httpClient.get(new IndexesQuery().toQuery(uid), Index.class);
     }
 
     /**
-     * Gets all indexes in the current Meilisearch instance
+     * Gets indexes in the current Meilisearch instance
      *
-     * @return Meilisearch API response
+     * @return Results containing a list of indexes
      * @throws MeilisearchException if an error occurs
      */
-    String getAll() throws MeilisearchException {
+    Results<Index> getIndexes() throws MeilisearchException {
+        return httpClient.get("/indexes", Results.class, Index.class);
+    }
+
+    /**
+     * Gets indexes in the current Meilisearch instance
+     *
+     * @param query parameters accepted by the indexes route
+     * @return Results containing a list of indexes
+     * @throws MeilisearchException if an error occurs
+     */
+    Results<Index> getIndexes(IndexesQuery params) throws MeilisearchException {
+        return httpClient.get(params.toQuery(params), Results.class, Index.class);
+    }
+
+    /**
+     * Gets indexes in the current Meilisearch instance
+     *
+     * @return List of indexes as String
+     * @throws MeilisearchException if an error occurs
+     */
+    String getRawIndexes() throws MeilisearchException {
         return httpClient.get("/indexes", String.class);
     }
 
@@ -76,26 +98,24 @@ String getAll() throws MeilisearchException {
      *
      * @param uid Unique identifier of the index to update
      * @param primaryKey New primary key field to use for documents in that index
-     * @return Meilisearch API response
+     * @return Meilisearch API response as TaskInfo
      * @throws MeilisearchException if an error occurs
      */
     TaskInfo updatePrimaryKey(String uid, String primaryKey) throws MeilisearchException {
         HashMap<String, String> index = new HashMap<String, String>();
         index.put("primaryKey", primaryKey);
 
-        String requestQuery = "/indexes/" + uid;
-        return httpClient.patch(requestQuery, index, TaskInfo.class);
+        return httpClient.patch(new IndexesQuery().toQuery(uid), index, TaskInfo.class);
     }
 
     /**
      * Deletes an index in the Meilisearch instance
      *
      * @param uid Unique identifier of the index to delete
-     * @return Meilisearch API response
+     * @return Meilisearch API response as TaskInfo
      * @throws MeilisearchException if an error occurs
      */
-    TaskInfo delete(String uid) throws MeilisearchException {
-        String requestQuery = "/indexes/" + uid;
-        return httpClient.delete(requestQuery, TaskInfo.class);
+    TaskInfo deleteIndex(String uid) throws MeilisearchException {
+        return httpClient.delete(new IndexesQuery().toQuery(uid), TaskInfo.class);
     }
 }

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

@@ -44,7 +44,7 @@ Task getTask(int taskUid) throws MeilisearchException {
     /**
      * Retrieves all tasks from the client
      *
-     * @return List of task instance
+     * @return TasksResults containing a list of task instance
      * @throws MeilisearchException if client request causes an error
      */
     TasksResults getTasks() throws MeilisearchException {
@@ -58,7 +58,7 @@ TasksResults getTasks() throws MeilisearchException {
      * Retrieves all tasks from the client
      *
      * @param param accept by the tasks route
-     * @return List of task instance
+     * @return TasksResults containing a list of task instance
      * @throws MeilisearchException if client request causes an error
      */
     TasksResults getTasks(TasksQuery param) throws MeilisearchException {
@@ -79,7 +79,7 @@ TasksResults getTasks(TasksQuery param) throws MeilisearchException {
      * Retrieves all tasks from specified index uid
      *
      * @param indexUid Index identifier to index of the requested Tasks
-     * @return List of task instance
+     * @return TasksResults containing a list of task instance
      * @throws MeilisearchException if client request causes an error
      */
     TasksResults getTasks(String indexUid) throws MeilisearchException {
@@ -96,7 +96,7 @@ TasksResults getTasks(String indexUid) throws MeilisearchException {
      *
      * @param indexUid Index identifier to index of the requested Tasks
      * @param param accept by the tasks route
-     * @return List of task instance
+     * @return TasksResults containing a list of task instance
      * @throws MeilisearchException if client request causes an error
      */
     TasksResults getTasks(String indexUid, TasksQuery param) throws MeilisearchException {

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

@@ -0,0 +1,35 @@
+package com.meilisearch.sdk.model;
+
+import com.meilisearch.sdk.http.URLBuilder;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+/**
+ * Data structure of the query parameters when fetching indexes
+ *
+ * <p>https://docs.meilisearch.com/reference/api/indexes.html#query-parameters
+ */
+@Setter
+@Getter
+@Accessors(chain = true)
+public class IndexesQuery {
+    private int offset = -1;
+    private int limit = -1;
+
+    public IndexesQuery() {}
+
+    public String toQuery(String uid) {
+        URLBuilder urlb = new URLBuilder();
+        urlb.addSubroute("indexes").addSubroute(uid);
+        return urlb.getURL();
+    }
+
+    public String toQuery(IndexesQuery param) {
+        URLBuilder urlb = new URLBuilder();
+        urlb.addSubroute("indexes")
+                .addParameter("limit", param.getLimit())
+                .addParameter("offset", param.getOffset());
+        return urlb.getURL();
+    }
+}