workflow

type Action struct {
	// ID is a unique identifier for the object. Should not be set by the user.
	ID uuid.UUID
	// Key is a unique identifier within a Plan that the user supplies and can use to reference
	// the action. Optional.
	Key uuid.UUID
	// Name is the name of the Action. Required.
	Name string
	// Descr is a description of the Action. Required.
	Descr string
	// Plugin is the name of the plugin that is executed. Required.
	Plugin string
	// Timeout is the amount of time to wait for the Action to complete. This defaults to 30 seconds and
	// must be at least 5 seconds.
	Timeout time.Duration `json:",format:iso8601"`
	// Retries is the number of times to retry the Action if it fails. This defaults to 0.
	Retries int
	// Req is the request object that is passed to the plugin.
	Req any
	// Attempts is the attempts of the action. This should not be set by the user.
	Attempts []*Attempt
	// State represents settings that should not be set by the user, but users can query.
	State *State
	// contains filtered or unexported fields
}

type Attempt struct {
	// Resp is the response object that is returned by the plugin.
	Resp any
	// Err is the plugin error that is returned by the plugin. If this is not nil, the attempt failed.
	Err *plugins.Error

	// Start is the time the attempt started.
	Start time.Time
	// End is the time the attempt ended.
	End time.Time
}

type Block struct {
	// ID is a unique identifier for the object. Should not be set by the user.
	ID uuid.UUID
	// Key is a unique identifier within a Plan that the user supplies and can use to reference
	// the block. Optional.
	Key uuid.UUID
	// Name is the name of the block. Required.
	Name string
	// Descr is a description of the block. Required.
	Descr string

	// EntranceDelay is the amount of time to wait before the block starts. This defaults to 0.
	EntranceDelay time.Duration `json:",format:iso8601"`
	// ExitDelay is the amount of time to wait after the block has completed. This defaults to 0.
	ExitDelay time.Duration `json:",format:iso8601"`

	// BypassChecks are actions that if they succeed will cause the block to be skipped.
	// If any gate fails, the workflow will be executed. Optional.
	BypassChecks *Checks
	// PreChecks are actions that are executed before the block starts.
	// Any error will cause the block to fail. Optional.
	PreChecks *Checks
	// Checks are actions that are executed while the block is running. Optional.
	ContChecks *Checks
	// PostChecks are actions that are executed after the block has completed.
	// Any error will cause the block to fail. Optional.
	PostChecks *Checks
	// DeferredChecks are actions that are executed after the workflow has completed.
	// This is executed regardless of Plan success or failure. However, if the
	// Block is bypassed via BypassChecks, this will not run.
	// Useful for logging and similar operations. Optional.
	DeferredChecks *Checks

	// Sequences is a list of sequences that are executed. Required..
	Sequences []*Sequence

	// Concurrency is the number of sequences that are executed in parallel. This defaults to 1.
	Concurrency int
	// ToleratedFailures is the number of sequences that are allowed to fail before the block fails. This defaults to 0.
	// If set to -1, all sequences are allowed to fail.
	ToleratedFailures int

	// State represents settings that should not be set by the user, but users can query.
	State *State
	// contains filtered or unexported fields
}

type Checks struct {
	// ID is a unique identifier for the object. Should not be set by the user.
	ID uuid.UUID
	// Key is a unique identifier within a Plan that the user supplies and can use to reference
	// the checks. Optional.
	Key uuid.UUID
	// Delay is the amount of time to wait before executing the checks. This
	// is only used by continuous checks. Optional. Defaults to 30 seconds.
	Delay time.Duration `json:",format:iso8601"`
	// Actions is a list of actions that are executed in parallel. Any error will
	// cause the workflow to fail. Required.
	Actions []*Action

	// State represents the internal state of the object. Should not be set by the user.
	State *State
	// contains filtered or unexported fields
}

type FailureReason int

type Object interface {
	// Type returns the type of the object.
	Type() ObjectType
	// contains filtered or unexported methods
}

type ObjectType int

type Plan struct {
	// ID is a unique identifier for the object. Should not be set by the user.
	ID uuid.UUID
	// Name is the name of the workflow. Required.
	Name string
	// Descr is a human-readable description of the workflow. Required.
	Descr string
	// GroupID is a unique identifier for a group of workflows. This is used to group
	// workflows together for informational purposes. This is not required.
	GroupID uuid.UUID
	// Meta is any type of metadata that the user wants to store with the workflow.
	// This is not used by the workflow engine. Optional.
	Meta []byte
	// BypassChecks are actions that if they succeed will cause the workflow to be skipped.
	// If any gate fails, the workflow will be executed. Optional.
	BypassChecks *Checks
	// PreChecks are actions that are executed before the workflow starts.
	// Any error will cause the workflow to fail. Optional.
	PreChecks *Checks
	// ContChecks are actions that are executed while the workflow is running.
	// Any error will cause the workflow to fail. Optional.
	ContChecks *Checks
	// Checks are actions that are executed after the workflow has completed.
	// Any error will cause the workflow to fail. Optional.
	PostChecks *Checks
	// DeferredChecks are actions that are executed after the workflow has completed.
	// This is executed regardless of Plan success or failure. However, if the
	// Plan is bypassed via BypassChecks, this will not run.
	// Useful for logging and similar operations. Optional.
	DeferredChecks *Checks

	// Blocks is a list of blocks that are executed in sequence.
	// If a block fails, the workflow will fail.
	// Only one block can be executed at a time. Required.
	Blocks []*Block

	// State is the internal state of the object. Should not be set by the user.
	State *State
	// SubmitTime is the time that the object was submitted. This is only
	// set for the Plan object
	SubmitTime time.Time
	// Reason is the reason that the object failed.
	// This will be set to FRUnknown if not in a failed state.
	Reason FailureReason
}

type Sequence struct {
	// ID is a unique identifier for the object. Should not be set by the user.
	ID uuid.UUID
	// Key is a unique identifier within a Plan that the user supplies and can use to reference
	// the sequence. Optional.
	Key uuid.UUID
	// Name is the name of the sequence. Required.
	Name string
	// Descr is a description of the sequence. Required.
	Descr string
	// Actions is a list of actions that are executed in sequence. Any error will cause the workflow to fail. Required.
	Actions []*Action

	// State represents settings that should not be set by the user, but users can query.
	State *State
	// contains filtered or unexported fields
}

type State struct {
	// Status is the status of the object.
	Status Status
	// Start is the time that the object was started.
	Start time.Time
	// End is the time that the object was completed.
	End time.Time
	// Etag is a field that may be used internally by storage implementations for concurrency control.
	ETag string
}

type Status int