-
Notifications
You must be signed in to change notification settings - Fork 35
/
foreach_state.go
107 lines (93 loc) · 3.92 KB
/
foreach_state.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
// Copyright 2022 The Serverless Workflow Specification Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package model
import (
"encoding/json"
"k8s.io/apimachinery/pkg/util/intstr"
"github.com/serverlessworkflow/sdk-go/v2/util"
)
// ForEachModeType Specifies how iterations are to be performed (sequentially or in parallel)
type ForEachModeType string
func (f ForEachModeType) KindValues() []string {
return []string{
string(ForEachModeTypeSequential),
string(ForEachModeTypeParallel),
}
}
func (f ForEachModeType) String() string {
return string(f)
}
const (
// ForEachModeTypeSequential specifies iterations should be done sequentially.
ForEachModeTypeSequential ForEachModeType = "sequential"
// ForEachModeTypeParallel specifies iterations should be done parallel.
ForEachModeTypeParallel ForEachModeType = "parallel"
)
// ForEachState used to execute actions for each element of a data set.
type ForEachState struct {
// Workflow expression selecting an array element of the states' data.
// +kubebuilder:validation:Required
InputCollection string `json:"inputCollection" validate:"required"`
// Workflow expression specifying an array element of the states data to add the results of each iteration.
// +optional
OutputCollection string `json:"outputCollection,omitempty"`
// Name of the iteration parameter that can be referenced in actions/workflow. For each parallel iteration,
// this param should contain a unique element of the inputCollection array.
// +optional
IterationParam string `json:"iterationParam,omitempty"`
// Specifies how many iterations may run in parallel at the same time. Used if mode property is set to
// parallel (default). If not specified, its value should be the size of the inputCollection.
// +optional
BatchSize *intstr.IntOrString `json:"batchSize,omitempty"`
// Actions to be executed for each of the elements of inputCollection.
// +kubebuilder:validation:MinItems=0
Actions []Action `json:"actions,omitempty" validate:"required,min=0,dive"`
// State specific timeout.
// +optional
Timeouts *ForEachStateTimeout `json:"timeouts,omitempty"`
// Specifies how iterations are to be performed (sequential or in parallel), defaults to parallel.
// +kubebuilder:validation:Enum=sequential;parallel
// +kubebuilder:default=parallel
Mode ForEachModeType `json:"mode,omitempty" validate:"required,oneofkind"`
}
func (f *ForEachState) MarshalJSON() ([]byte, error) {
type Alias ForEachState
custom, err := json.Marshal(&struct {
*Alias
Timeouts *ForEachStateTimeout `json:"timeouts,omitempty"`
}{
Alias: (*Alias)(f),
Timeouts: f.Timeouts,
})
return custom, err
}
type forEachStateUnmarshal ForEachState
// UnmarshalJSON implements json.Unmarshaler
func (f *ForEachState) UnmarshalJSON(data []byte) error {
f.ApplyDefault()
return util.UnmarshalObject("forEachState", data, (*forEachStateUnmarshal)(f))
}
// ApplyDefault set the default values for ForEach State
func (f *ForEachState) ApplyDefault() {
f.Mode = ForEachModeTypeParallel
}
// ForEachStateTimeout defines timeout settings for foreach state
type ForEachStateTimeout struct {
// Default workflow state execution timeout (ISO 8601 duration format)
// +optional
StateExecTimeout *StateExecTimeout `json:"stateExecTimeout,omitempty"`
// Default single actions definition execution timeout (ISO 8601 duration format)
// +optional
ActionExecTimeout string `json:"actionExecTimeout,omitempty" validate:"omitempty,iso8601duration"`
}