Skip to content

Commit 383c7a0

Browse files
committed
fix: improves ActionEnum documentation
Fix #594 [changelog]
1 parent 3dd0c65 commit 383c7a0

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

  • algoliasearch-core/src/main/java/com/algolia/search/models/indexing

algoliasearch-core/src/main/java/com/algolia/search/models/indexing/ActionEnum.java

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,40 @@
66
* @see <a href="https://www.algolia.com/doc/api-reference/api-methods/batc">Algolia.com</a>
77
*/
88
public class ActionEnum {
9+
10+
/** Add an object. Equivalent to Add an object without ID. */
911
public static final String ADD_OBJECT = "addObject";
12+
13+
/**
14+
* Add or replace an existing object. You must set the <code>objectID</code> attribute to indicate
15+
* the object to update. Equivalent to Add/update an object by ID.
16+
*/
1017
public static final String UPDATE_OBJECT = "updateObject";
18+
19+
/**
20+
* Partially update an object. You must set the <code>objectID</code> attribute to indicate the
21+
* object to update. Equivalent to Partially update an object.
22+
*/
1123
public static final String PARTIAL_UPDATE_OBJECT = "partialUpdateObject";
24+
25+
/**
26+
* Same as partialUpdateObject, except that the object is not created if the object designated by
27+
* <code>objectID</code> does not exist.
28+
*/
1229
public static final String PARTIAL_UPDATE_OBJECT_NO_CREATE = "partialUpdateObjectNoCreate";
30+
31+
/**
32+
* Delete an object. You must set the <code>objectID</code> attribute to indicate the object to
33+
* delete. Equivalent to Delete an object.
34+
*/
1335
public static final String DELETE_OBJECT = "deleteObject";
36+
37+
/** Delete the index. Equivalent to Delete an index. */
1438
public static final String DELETE = "delete";
39+
40+
/**
41+
* Remove the index’s content, but keep settings and index-specific API keys untouched. Equivalent
42+
* to Clear objects.
43+
*/
1544
public static final String CLEAR = "clear";
1645
}

0 commit comments

Comments
 (0)