client

Documentation

Index

• Variables
• func GetWorkflowResult[T any](ctx context.Context, c *Client, instance *workflow.Instance, ...) (T, error)
• type Client
  • func New(backend backend.Backend) *Client
  • func (c *Client) CancelWorkflowInstance(ctx context.Context, instance *workflow.Instance) error
  • func (c *Client) CreateWorkflowInstance(ctx context.Context, options WorkflowInstanceOptions, wf workflow.Workflow, ...) (*workflow.Instance, error)
  • func (c *Client) GetStats(ctx context.Context) (*backend.Stats, error)
  • func (c *Client) RemoveWorkflowInstance(ctx context.Context, instance *core.WorkflowInstance) error
  • func (c *Client) SignalWorkflow(ctx context.Context, instanceID string, name string, arg any) error
  • func (c *Client) WaitForWorkflowInstance(ctx context.Context, instance *workflow.Instance, timeout time.Duration) error
• type WorkflowInstanceOptions

Variables

var ErrWorkflowCanceled = errors.New("workflow canceled")

var ErrWorkflowTerminated = errors.New("workflow terminated")

Functions

func GetWorkflowResult

func GetWorkflowResult[T any](ctx context.Context, c *Client, instance *workflow.Instance, timeout time.Duration) (T, error)

GetWorkflowResult gets the workflow result for the given workflow result. It first waits for the workflow to finish or until the given timeout has expired.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(backend backend.Backend) *Client

func (*Client) CancelWorkflowInstance

func (c *Client) CancelWorkflowInstance(ctx context.Context, instance *workflow.Instance) error

CancelWorkflowInstance cancels a running workflow instance.

func (*Client) CreateWorkflowInstance

func (c *Client) CreateWorkflowInstance(ctx context.Context, options WorkflowInstanceOptions, wf workflow.Workflow, args ...any) (*workflow.Instance, error)

CreateWorkflowInstance creates a new workflow instance of the given workflow.

func (*Client) GetStats

func (c *Client) GetStats(ctx context.Context) (*backend.Stats, error)

GetStats returns backend stats.

func (*Client) RemoveWorkflowInstance

func (c *Client) RemoveWorkflowInstance(ctx context.Context, instance *core.WorkflowInstance) error

RemoveWorkflowInstance removes the given workflow instance from the backend.

func (*Client) SignalWorkflow

func (c *Client) SignalWorkflow(ctx context.Context, instanceID string, name string, arg any) error

SignalWorkflow signals a running workflow instance.

func (*Client) WaitForWorkflowInstance

func (c *Client) WaitForWorkflowInstance(ctx context.Context, instance *workflow.Instance, timeout time.Duration) error

WaitForWorkflowInstance waits for the given workflow instance to finish or until the given timeout has expired.

type WorkflowInstanceOptions

type WorkflowInstanceOptions struct {
	InstanceID string
}