Эх сурвалжийг харах

完成resubmit和retry开发 待测试

yjp 1 жил өмнө
parent
commit
6a6613f3c7

+ 22 - 6
client/workflow.go

@@ -28,6 +28,7 @@ type CreateWorkflowParams struct {
 	WorkflowDefinition map[string]any
 }
 
+// CreateWorkflow 创建工作流
 func (c *Client) CreateWorkflow(params CreateWorkflowParams) (string, error) {
 	responseMap := make(map[string]any)
 
@@ -88,6 +89,7 @@ type DeleteWorkflowParams struct {
 	Name      string
 }
 
+// DeleteWorkflow 删除工作流
 func (c *Client) DeleteWorkflow(params DeleteWorkflowParams) error {
 	responseMap := make(map[string]any)
 
@@ -122,6 +124,7 @@ type GetWorkflowsInNamespaceParams struct {
 	Namespace string
 }
 
+// GetWorkflowsInNamespace 获取命名空间下的工作流
 func (c *Client) GetWorkflowsInNamespace(params GetWorkflowsInNamespaceParams) ([]map[string]any, error) {
 	responseMap := make(map[string]any)
 
@@ -176,6 +179,7 @@ type GetWorkflowParams struct {
 	Name      string
 }
 
+// GetWorkflow 获取指定的工作流
 func (c *Client) GetWorkflow(params GetWorkflowParams) (map[string]any, error) {
 	responseMap := make(map[string]any)
 
@@ -211,6 +215,7 @@ type LintWorkflowParams struct {
 	WorkflowDefinition map[string]any
 }
 
+// LintWorkflow 检查工作流定义语法
 func (c *Client) LintWorkflow(params LintWorkflowParams) error {
 	responseMap := make(map[string]any)
 
@@ -252,6 +257,7 @@ type SubmitWorkflowFromWorkflowTemplateParams struct {
 	Parameters   []string
 }
 
+// SubmitWorkflowFromWorkflowTemplate 基于工作流模板提交工作流
 func (c *Client) SubmitWorkflowFromWorkflowTemplate(params SubmitWorkflowFromWorkflowTemplateParams) (string, error) {
 	responseMap := make(map[string]any)
 
@@ -318,6 +324,9 @@ type ResubmitWorkflowParams struct {
 	ResubmitParameters []string
 }
 
+// ResubmitWorkflow 重提交工作流
+// 有三种方式可以用来重复提交(可以结合使用):重新运行,基于缓存的和传递重提交参数
+// 基于缓存的必须在Error和Failed的工作流上才可以使用
 func (c *Client) ResubmitWorkflow(params ResubmitWorkflowParams) (string, error) {
 	responseMap := make(map[string]any)
 
@@ -377,13 +386,14 @@ func (c *Client) ResubmitWorkflow(params ResubmitWorkflowParams) (string, error)
 }
 
 type RetryWorkflowParams struct {
-	Namespace                           string
-	Name                                string
-	RetryParameters                     []string
-	RetryOnSuccessfulWorkflow           bool
-	SuccessfulWorkflowNodeFieldSelector string
+	Namespace                      string
+	Name                           string
+	RetryParameters                []string
+	RetryOnSuccessfulWorkflow      bool
+	RetryWorkflowNodeFieldSelector string
 }
 
+// RetryWorkflow 重新运行工作流(默认只能失败的工作流上重新运行)
 func (c *Client) RetryWorkflow(params RetryWorkflowParams) error {
 	responseMap := make(map[string]any)
 
@@ -399,7 +409,7 @@ func (c *Client) RetryWorkflow(params RetryWorkflowParams) error {
 			"name":              params.Name,
 			"parameters":        params.RetryParameters,
 			"restartSuccessful": params.RetryOnSuccessfulWorkflow,
-			"nodeFieldSelector": params.SuccessfulWorkflowNodeFieldSelector,
+			"nodeFieldSelector": params.RetryWorkflowNodeFieldSelector,
 		}).
 		SetResult(&responseMap).
 		SetError(&responseMap).
@@ -428,6 +438,7 @@ type StopWorkflowParams struct {
 	Message           string
 }
 
+// StopWorkflow 终止工作流运行,会调用所有的退出处理器
 func (c *Client) StopWorkflow(params StopWorkflowParams) error {
 	return nil
 }
@@ -437,6 +448,7 @@ type TerminalWorkflowParams struct {
 	Name      string
 }
 
+// TerminalWorkflow 终止工作流运行,不调用所有的退出处理器
 func (c *Client) TerminalWorkflow(params TerminalWorkflowParams) error {
 	return nil
 }
@@ -450,6 +462,7 @@ type SetWorkflowParams struct {
 	OutputParameters  []string
 }
 
+// SetWorkflow 设置工作流的参数
 func (c *Client) SetWorkflow(params SetWorkflowParams) error {
 	return nil
 }
@@ -459,6 +472,7 @@ type SuspendWorkflowParams struct {
 	Name      string
 }
 
+// SuspendWorkflow 挂起工作流
 func (c *Client) SuspendWorkflow(params SuspendWorkflowParams) error {
 	return nil
 }
@@ -468,6 +482,7 @@ type ResumeWorkflowParams struct {
 	Name      string
 }
 
+// ResumeWorkflow 恢复被挂起的工作流
 func (c *Client) ResumeWorkflow(params ResumeWorkflowParams) error {
 	return nil
 }
@@ -479,6 +494,7 @@ type GetWorkflowEventsStreamParams struct {
 	Name      string
 }
 
+// GetWorkflowEventsStream 监听工作流事件
 func (c *Client) GetWorkflowEventsStream(params GetWorkflowEventsStreamParams, callback EventCallback) error {
 	return nil
 }

+ 6 - 0
client/workflow_template.go

@@ -19,6 +19,7 @@ type CreateWorkflowTemplateParams struct {
 	TemplateDefinition map[string]any
 }
 
+// CreateWorkflowTemplate 创建工作流模板
 func (c *Client) CreateWorkflowTemplate(params CreateWorkflowTemplateParams) error {
 	responseMap := make(map[string]any)
 
@@ -59,6 +60,7 @@ type DeleteWorkflowTemplateParams struct {
 	Name      string
 }
 
+// DeleteWorkflowTemplate 删除工作流模板
 func (c *Client) DeleteWorkflowTemplate(params DeleteWorkflowTemplateParams) error {
 	responseMap := make(map[string]any)
 
@@ -95,6 +97,7 @@ type UpdateWorkflowTemplateParams struct {
 	TemplateDefinition map[string]any
 }
 
+// UpdateWorkflowTemplate 更新工作流模板
 func (c *Client) UpdateWorkflowTemplate(params UpdateWorkflowTemplateParams) error {
 	responseMap := make(map[string]any)
 
@@ -134,6 +137,7 @@ type GetWorkflowTemplatesInNamespaceParams struct {
 	Namespace string
 }
 
+// GetWorkflowTemplatesInNamespace 获取命名空间下的工作流模板
 func (c *Client) GetWorkflowTemplatesInNamespace(params GetWorkflowTemplatesInNamespaceParams) ([]map[string]any, error) {
 	responseMap := make(map[string]any)
 
@@ -188,6 +192,7 @@ type GetWorkflowTemplateParams struct {
 	Name      string
 }
 
+// GetWorkflowTemplate 获取指定的工作流模板
 func (c *Client) GetWorkflowTemplate(params GetWorkflowTemplateParams) (map[string]any, error) {
 	responseMap := make(map[string]any)
 
@@ -223,6 +228,7 @@ type LintWorkflowTemplateParams struct {
 	TemplateDefinition map[string]any
 }
 
+// LintWorkflowTemplate 工作流模板定义语法检查
 func (c *Client) LintWorkflowTemplate(params LintWorkflowTemplateParams) error {
 	responseMap := make(map[string]any)