processinstance

package

v0.0.29 Latest Latest Go to latest Published: Sep 15, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grafvonb/camunder

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type API
type CancelResponse
type ProcessInstance
type ProcessInstanceState
type SearchFilterOpts
type State
- func ParseState(in string) (State, error)
- func (s State) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrUnknownStateFilter = errors.New("is unknown (valid: all, active, canceled, completed)")
)

Functions ¶

This section is empty.

Types ¶

type API ¶

type API interface {
	camunda.Base
	CancelProcessInstance(ctx context.Context, key int64) (*CancelResponse, error)
	WaitForProcessInstanceState(ctx context.Context, key string, desiredState string) error
}

type CancelResponse ¶

type CancelResponse struct {
	StatusCode int
	Status     string
}

type ProcessInstance ¶

type ProcessInstance struct {
	BpmnProcessId             string               `json:"bpmnProcessId,omitempty"`
	EndDate                   string               `json:"endDate,omitempty"`
	Incident                  bool                 `json:"incident,omitempty"`
	Key                       int64                `json:"key,omitempty"`
	ParentFlowNodeInstanceKey int64                `json:"parentFlowNodeInstanceKey,omitempty"`
	ParentKey                 int64                `json:"parentKey,omitempty"`
	ParentProcessInstanceKey  *ProcessInstance     `json:"parentProcessInstanceKey,omitempty"`
	ProcessDefinitionKey      int64                `json:"processDefinitionKey,omitempty"`
	ProcessVersion            int32                `json:"processVersion,omitempty"`
	ProcessVersionTag         string               `json:"processVersionTag,omitempty"`
	StartDate                 string               `json:"startDate,omitempty"`
	State                     ProcessInstanceState `json:"state,omitempty"`
	TenantId                  string               `json:"tenantId,omitempty"`
}

type ProcessInstanceState ¶

type ProcessInstanceState string

ProcessInstanceState defines model for ProcessInstance.State.

type SearchFilterOpts ¶

type SearchFilterOpts struct {
	Key               int64
	BpmnProcessId     string
	ProcessVersion    int32
	ProcessVersionTag string
	State             State
	ParentKey         int64
}

type State ¶

type State string

State is the process-instance state filter.

const (
	StateAll       State = "all"
	StateActive    State = "active"
	StateCompleted State = "completed"
	StateCanceled  State = "canceled"
)

func ParseState ¶

func ParseState(in string) (State, error)

ParseState parses a string (case-insensitive) into a State.

func (State) String ¶

func (s State) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL