MAINT: backfill documentation into json description for delete_entries (

opensearch-project#4721) * MAINT: backfill documentation into json description for delete_entries Signed-off-by: George Chen <[email protected]> Signed-off-by: Krishna Kondaka <[email protected]>
kkondaka · Jul 23, 2024 · 6826c07 · 6826c07
1 parent a1cae05
commit 6826c07
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/.../org/opensearch/dataprepper/plugins/processor/mutateevent/DeleteEntryProcessorConfig.java b/.../org/opensearch/dataprepper/plugins/processor/mutateevent/DeleteEntryProcessorConfig.java
@@ -6,6 +6,7 @@
 package org.opensearch.dataprepper.plugins.processor.mutateevent;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 import org.opensearch.dataprepper.model.event.EventKey;
@@ -19,9 +20,12 @@ public class DeleteEntryProcessorConfig {
     @NotNull
     @JsonProperty("with_keys")
     @EventKeyConfiguration(EventKeyFactory.EventAction.DELETE)
+    @JsonPropertyDescription("An array of keys for the entries to be deleted.")
     private List<@NotNull @NotEmpty EventKey> withKeys;
 
     @JsonProperty("delete_when")
+    @JsonPropertyDescription("Specifies under what condition the `delete_entries` processor should perform deletion. " +
+            "Default is no condition.")
     private String deleteWhen;
 
     public List<EventKey> getWithKeys() {