Updated documentation

Signed-off-by: Krishna Kondaka <[email protected]>

data-prepper-api/src/main/java/org/opensearch/dataprepper/model/event/Event.java

@@ -74,7 +74,10 @@ public interface Event extends Serializable {
     String toJsonString();
 
     /**
+     * Returns the JsonNode containing the internal representation of the event
      *
+     * @return JsonNode
+     * @since 2.5
      */
     JsonNode getJsonNode();
 

data-prepper-plugins/opensearch/README.md

@@ -146,6 +146,28 @@ e.g. [otel-v1-apm-span-index-template.json](https://github.com/opensearch-projec
 - `dlq_file`(optional): A String of absolute file path for DLQ failed output records. Defaults to null.
 If not provided, failed records will be written into the default data-prepper log file (`logs/Data-Prepper.log`). If the `dlq` option is present along with this, an error is thrown.
 
+- `action`(optional): A string indicating the type of action to be performed. Supported values are "create", "update", "upsert", "delete" and "index". Default value is "index". It also be an expression which evaluates to one of the supported values mentioned earlier.
+
+- `actions`(optional): This is an alternative to `action`. `actions` can have multiple actions, each with a condition. The first action for which the condition evaluates to true is picked as the action for an event. The action must be one of the supported values mentioned under `action` field above. Just like in case of `action`, the `type` mentioned in `actions` can be an expression which evaluates to one of the supported values. For example, the following configuration shows different action types for different conditions.
+
+```
+  sink:
+    - opensearch
+        actions:
+          - type: "create"
+             when: "/some_key == CREATE"
+          - type: "index"
+             when: "/some_key == INDEX"
+          - type: "upsert"
+             when: "/some_key == UPSERT"
+          - type: "update"
+             when: "/some_key == UPDATE"
+          - type: "delete"
+             when: "/some_key == DELETE"
+         # default case
+          - type: "index"
+```
+
 - `dlq` (optional): DLQ configurations. See [DLQ](https://github.com/opensearch-project/data-prepper/tree/main/data-prepper-plugins/failures-common/src/main/java/org/opensearch/dataprepper/plugins/dlq/README.md) for details. If the `dlq_file` option is present along with this, an error is thrown.
 
 - `max_retries`(optional): A number indicating the maximum number of times OpenSearch Sink should try to push the data to the OpenSearch server before considering it as failure. Defaults to `Integer.MAX_VALUE`.