File tree Expand file tree Collapse file tree 2 files changed +20
-2
lines changed
src/main/scala/algoliasearch Expand file tree Collapse file tree 2 files changed +20
-2
lines changed Original file line number Diff line number Diff line change @@ -23,7 +23,16 @@ import org.json4s._
23
23
24
24
sealed trait Action
25
25
26
- /** Type of indexing operation.
26
+ /** Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new record
27
+ * (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index. Equivalent to
28
+ * the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within records.
29
+ * Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to true. (If a
30
+ * record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to
31
+ * the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false.
32
+ * (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete records from an index.
33
+ * Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to the \"Delete an index\"
34
+ * operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all records from an index
35
+ * operation\".
27
36
*/
28
37
object Action {
29
38
case object AddObject extends Action {
Original file line number Diff line number Diff line change @@ -37,7 +37,16 @@ import org.json4s._
37
37
38
38
sealed trait Action
39
39
40
- /** Type of indexing operation.
40
+ /** Which indexing operation to perform: - `addObject`: adds records to an index. Equivalent to the \"Add a new record
41
+ * (with auto-generated object ID)\" operation. - `updateObject`: adds or replaces records in an index. Equivalent to
42
+ * the \"Add or replace a record\" operation. - `partialUpdateObject`: adds or updates attributes within records.
43
+ * Equivalent to the \"Add or update attributes\" operation with the `createIfNoExists` parameter set to true. (If a
44
+ * record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to
45
+ * the index) - `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false.
46
+ * (A record isn't added to the index if its `objectID` doesn't exist) - `deleteObject`: delete records from an index.
47
+ * Equivalent to the \"Delete a record\" operation. - `delete`. Delete an index. Equivalent to the \"Delete an index\"
48
+ * operation. - `clear`: delete all records from an index. Equivalent to the \"Delete all records from an index
49
+ * operation\".
41
50
*/
42
51
object Action {
43
52
case object AddObject extends Action {
You can’t perform that action at this time.
0 commit comments