From ba21474ac75bb163df74bc3081a14daacef20a77 Mon Sep 17 00:00:00 2001 From: Joshua Palis Date: Wed, 27 Mar 2024 00:07:33 +0000 Subject: [PATCH] fixing checkstyle Signed-off-by: Joshua Palis --- .../flowframework/rest/RestOrchestrateAction.java | 4 ++-- .../flowframework/transport/OrchestrateRequest.java | 8 ++++++++ .../workflow/SearchResponseProcessorStep.java | 3 +++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/opensearch/flowframework/rest/RestOrchestrateAction.java b/src/main/java/org/opensearch/flowframework/rest/RestOrchestrateAction.java index 8856e583c..0ec3cf35d 100644 --- a/src/main/java/org/opensearch/flowframework/rest/RestOrchestrateAction.java +++ b/src/main/java/org/opensearch/flowframework/rest/RestOrchestrateAction.java @@ -43,8 +43,8 @@ public class RestOrchestrateAction extends BaseRestHandler { private static final String ORCHESTRATE_ACTION = "orchestrate_action"; - /* - * Creates a new RestOrchestrateAction + /** + * Creates a new RestOrchestrateAction instance */ public RestOrchestrateAction() {} diff --git a/src/main/java/org/opensearch/flowframework/transport/OrchestrateRequest.java b/src/main/java/org/opensearch/flowframework/transport/OrchestrateRequest.java index b2bdb3f9e..fd20bc1cb 100644 --- a/src/main/java/org/opensearch/flowframework/transport/OrchestrateRequest.java +++ b/src/main/java/org/opensearch/flowframework/transport/OrchestrateRequest.java @@ -52,10 +52,18 @@ public OrchestrateRequest(StreamInput in) throws IOException { this.userInputs = in.readMap(StreamInput::readString, StreamInput::readString); } + /** + * Returns the workflow ID + * @return the workflow ID + */ public String getWorkflowId() { return this.workflowId; } + /** + * Returns the user inputs map + * @return the user inputs map + */ public Map getUserInputs() { return this.userInputs; } diff --git a/src/main/java/org/opensearch/flowframework/workflow/SearchResponseProcessorStep.java b/src/main/java/org/opensearch/flowframework/workflow/SearchResponseProcessorStep.java index 5ad70d3ad..440853775 100644 --- a/src/main/java/org/opensearch/flowframework/workflow/SearchResponseProcessorStep.java +++ b/src/main/java/org/opensearch/flowframework/workflow/SearchResponseProcessorStep.java @@ -39,6 +39,9 @@ public class SearchResponseProcessorStep implements WorkflowStep { private static final Logger logger = LogManager.getLogger(SearchResponseProcessorStep.class); private final SearchPipelineService searchPipelineService; + /** + * The name of the SearchResponseProcessor step + */ public static final String NAME = "search_response_processor"; /**