add csv_when description

Signed-off-by: Katherine Shen <katshen@amazon.com>
shenkw1 · Jul 18, 2024 · e05304b · e05304b
1 parent e1a994a
commit e05304b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/...or/src/main/java/org/opensearch/dataprepper/plugins/processor/csv/CsvProcessorConfig.java b/...or/src/main/java/org/opensearch/dataprepper/plugins/processor/csv/CsvProcessorConfig.java
@@ -57,6 +57,9 @@ public class CsvProcessorConfig {
     private List<String> columnNames;
 
     @JsonProperty("csv_when")
+    @JsonPropertyDescription("Allows you to specify a [conditional expression](https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/), " +
+            "such as `/some-key == \"test\"`, that will be evaluated to determine whether " +
+            "the processor should be applied to the event.")
     private String csvWhen;
 
     /**