Documentation
¶
Index ¶
- func TotalsOf[T OKer](items []T) (total, oks, noks int)
- func ValidStateStrings() []string
- type API
- type CancelReport
- type CancelReports
- type DeleteReport
- type DeleteReports
- type OKer
- type ProcessDefinition
- type ProcessDefinitionFilter
- type ProcessDefinitionStatistics
- type ProcessDefinitions
- type ProcessInstance
- type ProcessInstanceData
- type ProcessInstanceFilter
- type ProcessInstances
- type Reporter
- type State
- type StateReport
- type StateReports
- type States
- type Walker
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidStateStrings ¶ added in v1.2.0
func ValidStateStrings() []string
Types ¶
type API ¶
type API interface {
SearchProcessDefinitions(ctx context.Context, filter ProcessDefinitionFilter, opts ...options.FacadeOption) (ProcessDefinitions, error)
SearchProcessDefinitionsLatest(ctx context.Context, filter ProcessDefinitionFilter, opts ...options.FacadeOption) (ProcessDefinitions, error)
GetProcessDefinition(ctx context.Context, key string, opts ...options.FacadeOption) (ProcessDefinition, error)
CreateProcessInstance(ctx context.Context, data ProcessInstanceData, opts ...options.FacadeOption) (ProcessInstance, error)
CreateProcessInstances(ctx context.Context, datas []ProcessInstanceData, opts ...options.FacadeOption) ([]ProcessInstance, error)
GetProcessInstance(ctx context.Context, key string, opts ...options.FacadeOption) (ProcessInstance, error)
SearchProcessInstances(ctx context.Context, filter ProcessInstanceFilter, size int32, opts ...options.FacadeOption) (ProcessInstances, error)
CancelProcessInstance(ctx context.Context, key string, opts ...options.FacadeOption) (CancelReport, ProcessInstances, error)
DeleteProcessInstance(ctx context.Context, key string, opts ...options.FacadeOption) (DeleteReport, error)
GetDirectChildrenOfProcessInstance(ctx context.Context, key string, opts ...options.FacadeOption) (ProcessInstances, error)
FilterProcessInstanceWithOrphanParent(ctx context.Context, items []ProcessInstance, opts ...options.FacadeOption) ([]ProcessInstance, error)
WaitForProcessInstanceState(ctx context.Context, key string, desired States, opts ...options.FacadeOption) (StateReport, ProcessInstance, error)
Walker
GetProcessInstances(ctx context.Context, keys types.Keys, wantedWorkers int, opts ...options.FacadeOption) (ProcessInstances, error)
CreateNProcessInstances(ctx context.Context, data ProcessInstanceData, n int, wantedWorkers int, opts ...options.FacadeOption) ([]ProcessInstance, error)
CancelProcessInstances(ctx context.Context, keys types.Keys, wantedWorkers int, opts ...options.FacadeOption) (CancelReports, error)
DeleteProcessInstances(ctx context.Context, keys types.Keys, wantedWorkers int, opts ...options.FacadeOption) (DeleteReports, error)
WaitForProcessInstancesState(ctx context.Context, keys types.Keys, desired States, wantedWorkers int, opts ...options.FacadeOption) (StateReports, error)
DryRunCancelOrDeleteGetPIKeys(ctx context.Context, keys types.Keys, opts ...options.FacadeOption) (types.Keys, types.Keys, error)
}
type CancelReport ¶ added in v0.1.71
type CancelReport = Reporter
type CancelReports ¶ added in v0.1.71
type CancelReports struct {
Items []CancelReport `json:"items,omitempty"`
}
type DeleteReport ¶ added in v0.1.71
type DeleteReport = Reporter
type DeleteReports ¶ added in v0.1.71
type DeleteReports struct {
Items []DeleteReport `json:"items,omitempty"`
}
type ProcessDefinition ¶
type ProcessDefinition struct {
BpmnProcessId string `json:"bpmnProcessId,omitempty"`
Key string `json:"key,omitempty"`
Name string `json:"name,omitempty"`
TenantId string `json:"tenantId,omitempty"`
ProcessVersion int32 `json:"processVersion,omitempty"`
ProcessVersionTag string `json:"processVersionTag,omitempty"`
Statistics *ProcessDefinitionStatistics `json:"statistics,omitempty"`
}
type ProcessDefinitionFilter ¶ added in v0.1.71
type ProcessDefinitionStatistics ¶ added in v1.1.0
type ProcessDefinitions ¶
type ProcessDefinitions struct {
Total int32 `json:"total,omitempty"`
Items []ProcessDefinition `json:"items,omitempty"`
}
type ProcessInstance ¶
type ProcessInstance struct {
BpmnProcessId string `json:"bpmnProcessId,omitempty"`
EndDate string `json:"endDate,omitempty"`
Incident bool `json:"incident,omitempty"`
Key string `json:"key,omitempty"`
ParentFlowNodeInstanceKey string `json:"parentFlowNodeInstanceKey,omitempty"`
ParentKey string `json:"parentKey,omitempty"`
ParentProcessInstanceKey string `json:"parentProcessInstanceKey,omitempty"`
ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
ProcessVersion int32 `json:"processVersion,omitempty"`
ProcessVersionTag string `json:"processVersionTag,omitempty"`
StartDate string `json:"startDate,omitempty"`
State State `json:"state,omitempty"`
TenantId string `json:"tenantId,omitempty"`
Variables map[string]interface{} `json:"variables,omitempty"`
}
type ProcessInstanceData ¶ added in v0.1.64
type ProcessInstanceData struct {
BpmnProcessId string `json:"bpmnProcessId,omitempty"` // ProcessDefinitionId in API
ProcessDefinitionSpecificId string `json:"processDefinitionSpecificId,omitempty"` // ProcessDefinitionKey in API
ProcessDefinitionVersion int32 `json:"processDefinitionVersion,omitempty"`
Variables map[string]interface{} `json:"variables,omitempty"`
TenantId string `json:"tenantId,omitempty"`
}
type ProcessInstanceFilter ¶ added in v0.1.71
type ProcessInstanceFilter struct {
Key string `json:"key,omitempty"`
BpmnProcessId string `json:"bpmnProcessId,omitempty"`
ProcessVersion int32 `json:"version,omitempty"`
ProcessVersionTag string `json:"versionTag,omitempty"`
ProcessDefinitionKey string `json:"processDefinitionKey,omitempty"`
State State `json:"state,omitempty"`
ParentKey string `json:"parentKey,omitempty"`
}
type ProcessInstances ¶
type ProcessInstances struct {
Total int32 `json:"total,omitempty"`
Items []ProcessInstance `json:"items,omitempty"`
}
func (ProcessInstances) FilterByHavingIncidents ¶
func (r ProcessInstances) FilterByHavingIncidents(has bool) ProcessInstances
func (ProcessInstances) FilterChildrenOnly ¶
func (r ProcessInstances) FilterChildrenOnly() ProcessInstances
func (ProcessInstances) FilterRootsOnly ¶ added in v0.1.72
func (r ProcessInstances) FilterRootsOnly() ProcessInstances
type Reporter ¶ added in v0.1.71
type State ¶
type State string
func ParseState ¶
func (State) EqualsIgnoreCase ¶
func (State) IsTerminal ¶
type StateReport ¶ added in v1.2.0
type StateReport struct {
Key string `json:"key,omitempty"`
State State `json:"state,omitempty"`
Status string `json:"status,omitempty"`
}
func MapStateResponseToReport ¶ added in v1.2.0
func MapStateResponseToReport(in d.StateResponse) StateReport
type StateReports ¶ added in v1.2.0
type StateReports struct {
Items []StateReport `json:"items,omitempty"`
}
func MapStateResponsesToReports ¶ added in v1.2.0
func MapStateResponsesToReports(in d.StateResponses) StateReports
type Walker ¶
type Walker interface {
Ancestry(ctx context.Context, startKey string, opts ...options.FacadeOption) (rootKey string, path []string, chain map[string]ProcessInstance, err error)
Descendants(ctx context.Context, rootKey string, opts ...options.FacadeOption) (desc []string, edges map[string][]string, chain map[string]ProcessInstance, err error)
Family(ctx context.Context, startKey string, opts ...options.FacadeOption) (fam []string, edges map[string][]string, chain map[string]ProcessInstance, err error)
}
Click to show internal directories.
Click to hide internal directories.