MAINT: update required properties and property descriptions in some p…

…rocessors (#4989) * update rename key config with missing descriptions * update convert entry type required fields * update delay property description * putting convert entry type processor on hold due to the mutually exclusive properties Signed-off-by: Katherine Shen <[email protected]> --------- Signed-off-by: Katherine Shen <[email protected]>
opensearch-project · Sep 30, 2024 · c3b155f · c3b155f
1 parent d310d1c
commit c3b155f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/...ins/common/src/main/java/org/opensearch/dataprepper/plugins/processor/DelayProcessor.java b/...ins/common/src/main/java/org/opensearch/dataprepper/plugins/processor/DelayProcessor.java
@@ -60,6 +60,7 @@ public void shutdown() {
  "Typically, you should use this only for testing, experimenting, and debugging.")
  public static class Configuration {
  @JsonProperty("for")
+ @JsonPropertyDescription("The duration of time to delay. Defaults to `1s`.")
  private Duration delayFor = Duration.ofSeconds(1);
 
  public Duration getDelayFor() {

diff --git a/...va/org/opensearch/dataprepper/plugins/processor/mutateevent/RenameKeyProcessorConfig.java b/...va/org/opensearch/dataprepper/plugins/processor/mutateevent/RenameKeyProcessorConfig.java
@@ -25,12 +25,14 @@ public static class Entry {
  @NotEmpty
  @NotNull
  @JsonProperty("from_key")
+ @JsonPropertyDescription("The key of the entry to be renamed.")
  @EventKeyConfiguration({EventKeyFactory.EventAction.GET, EventKeyFactory.EventAction.DELETE})
  private EventKey fromKey;
 
  @NotEmpty
  @NotNull
  @JsonProperty("to_key")
+ @JsonPropertyDescription("The new key of the entry.")
  @EventKeyConfiguration(EventKeyFactory.EventAction.PUT)
  private EventKey toKey;