From 58db87b4f0ddc76ffb2f46e4e15d8c0500551578 Mon Sep 17 00:00:00 2001
From: "opensearch-trigger-bot[bot]"
 <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com>
Date: Wed, 13 Sep 2023 15:07:42 -0700
Subject: [PATCH] [Backport 2.x] Updated Workflow Interface (#34)

Updated Workflow Interface (#30)

* Updated Workflow Interface



* Updated method definition to handle input/output



---------


(cherry picked from commit 0f0b65ddd27722831846006490fc54207097eeeb)

Signed-off-by: Owais Kazi <owaiskazi19@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Owais Kazi <owaiskazi19@gmail.com>
---
 .../flowframework/workflow/WorkflowData.java      | 14 ++++++++++++++
 .../workflow/{Workflow.java => WorkflowStep.java} | 15 +++++++++++----
 2 files changed, 25 insertions(+), 4 deletions(-)
 create mode 100644 src/main/java/org/opensearch/flowframework/workflow/WorkflowData.java
 rename src/main/java/org/opensearch/flowframework/workflow/{Workflow.java => WorkflowStep.java} (64%)

diff --git a/src/main/java/org/opensearch/flowframework/workflow/WorkflowData.java b/src/main/java/org/opensearch/flowframework/workflow/WorkflowData.java
new file mode 100644
index 000000000..3e8dc81b2
--- /dev/null
+++ b/src/main/java/org/opensearch/flowframework/workflow/WorkflowData.java
@@ -0,0 +1,14 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package org.opensearch.flowframework.workflow;
+
+/**
+ * Interface for handling the input/output of the building blocks.
+ */
+public interface WorkflowData {}
diff --git a/src/main/java/org/opensearch/flowframework/workflow/Workflow.java b/src/main/java/org/opensearch/flowframework/workflow/WorkflowStep.java
similarity index 64%
rename from src/main/java/org/opensearch/flowframework/workflow/Workflow.java
rename to src/main/java/org/opensearch/flowframework/workflow/WorkflowStep.java
index 634877bec..6a65ce6e3 100644
--- a/src/main/java/org/opensearch/flowframework/workflow/Workflow.java
+++ b/src/main/java/org/opensearch/flowframework/workflow/WorkflowStep.java
@@ -8,19 +8,26 @@
  */
 package org.opensearch.flowframework.workflow;
 
+import org.opensearch.common.Nullable;
+
 import java.util.concurrent.CompletableFuture;
 
 /**
  * Interface for the workflow setup of different building blocks.
  */
-public interface Workflow {
+public interface WorkflowStep {
 
     /**
      * Triggers the processing of the building block.
-     *
+     * @param data for input/output params of the building blocks.
      * @return CompletableFuture of the building block.
-     * @throws Exception if execution fails
      */
-    CompletableFuture<Workflow> execute() throws Exception;
+    CompletableFuture<WorkflowData> execute(@Nullable WorkflowData data);
+
+    /**
+     *
+     * @return the name of this workflow step.
+     */
+    String getName();
 
 }