workflow

package

Go to main page

Versions in this module

v0

v0.11.2

Mar 6, 2026

v0.11.1

Mar 4, 2026

v0.11.0

Jan 30, 2026

Changes in this version

+ const StatusStalled

type Client

+ func (c *Client) GetInstanceHistory(ctx context.Context, id string, opts ...GetInstanceHistoryOptions) (*GetInstanceHistoryResponse, error)

+ func (c *Client) ListInstanceIDs(ctx context.Context, opts ...ListInstanceIDsOptions) (*ListInstanceIDsResponse, error)

+ type GetInstanceHistoryOptions api.GetInstanceHistoryOptions

+ type GetInstanceHistoryResponse protos.GetInstanceHistoryResponse

+ type ListInstanceIDsOptions api.ListInstanceIDsOptions

+ func WithListInstanceIDsContinuationToken(token string) ListInstanceIDsOptions

+ func WithListInstanceIDsPageSize(pageSize uint32) ListInstanceIDsOptions

+ type ListInstanceIDsResponse protos.ListInstanceIDsResponse

type PurgeOptions

+ func WithForcePurge(force bool) PurgeOptions

type Registry

+ func (r *Registry) AddVersionedWorkflow(canonicalName string, isLatest bool, w Workflow) error

+ func (r *Registry) AddVersionedWorkflowN(canonicalName string, name string, isLatest bool, w Workflow) error

type RerunOptions

+ func WithRerunNewChildInstanceID(id string) RerunOptions

type WorkflowContext

+ func (w *WorkflowContext) IsPatched(patchName string) bool

v0.10.2

Dec 3, 2025

v0.10.1

Oct 3, 2025

v0.10.0

Sep 11, 2025

Changes in this version

+ const StatusCanceled

+ const StatusCompleted

+ const StatusContinuedAsNew

+ const StatusFailed

+ const StatusPending

+ const StatusRunning

+ const StatusSuspended

+ const StatusTerminated

+ func WorkflowMetadataIsComplete(o *WorkflowMetadata) bool

+ func WorkflowMetadataIsRunning(o *WorkflowMetadata) bool

+ type Activity func(ActivityContext) (any, error)

+ type ActivityContext task.ActivityContext

+ type CallActivityOption task.CallActivityOption

+ func WithActivityAppID(targetAppID string) CallActivityOption

+ func WithActivityInput(input any) CallActivityOption

+ func WithActivityRetryPolicy(policy *RetryPolicy) CallActivityOption

+ func WithRawActivityInput(input *wrapperspb.StringValue) CallActivityOption

+ type ChildWorkflowOption task.SubOrchestratorOption

+ func WithChildWorkflowAppID(appID string) ChildWorkflowOption

+ func WithChildWorkflowInput(input any) ChildWorkflowOption

+ func WithChildWorkflowInstanceID(instanceID string) ChildWorkflowOption

+ func WithChildWorkflowRetryPolicy(policy *RetryPolicy) ChildWorkflowOption

+ func WithRawChildWorkflowInput(input *wrapperspb.StringValue) ChildWorkflowOption

+ type Client struct

+ func NewClient(cc grpc.ClientConnInterface) *Client

+ func NewClientWithLogger(cc grpc.ClientConnInterface, logger backend.Logger) *Client

+ func (c *Client) FetchWorkflowMetadata(ctx context.Context, id string, opts ...FetchWorkflowMetadataOptions) (*WorkflowMetadata, error)

+ func (c *Client) PurgeWorkflowState(ctx context.Context, id string, opts ...PurgeOptions) error

+ func (c *Client) RaiseEvent(ctx context.Context, id, eventName string, opts ...RaiseEventOptions) error

+ func (c *Client) RerunWorkflowFromEvent(ctx context.Context, id string, eventID uint32, opts ...RerunOptions) (string, error)

+ func (c *Client) ResumeWorkflow(ctx context.Context, id, reason string) error

+ func (c *Client) ScheduleWorkflow(ctx context.Context, orchestrator string, opts ...NewWorkflowOptions) (string, error)

+ func (c *Client) StartWorker(ctx context.Context, r *Registry) error

+ func (c *Client) SuspendWorkflow(ctx context.Context, id, reason string) error

+ func (c *Client) TerminateWorkflow(ctx context.Context, id string, opts ...TerminateOptions) error

+ func (c *Client) WaitForWorkflowCompletion(ctx context.Context, id string, opts ...FetchWorkflowMetadataOptions) (*WorkflowMetadata, error)

+ func (c *Client) WaitForWorkflowStart(ctx context.Context, id string, opts ...FetchWorkflowMetadataOptions) (*WorkflowMetadata, error)

+ type ContinueAsNewOption task.ContinueAsNewOption

+ func WithKeepUnprocessedEvents() ContinueAsNewOption

+ type CreateTimerOption task.CreateTimerOption

+ func WithTimerName(name string) CreateTimerOption

+ type FetchWorkflowMetadataOptions api.FetchOrchestrationMetadataOptions

+ func WithFetchPayloads(fetchPayloads bool) FetchWorkflowMetadataOptions

+ type NewWorkflowOptions api.NewOrchestrationOptions

+ func WithInput(input any) NewWorkflowOptions

+ func WithInstanceID(id string) NewWorkflowOptions

+ func WithRawInput(rawInput *wrapperspb.StringValue) NewWorkflowOptions

+ func WithStartTime(startTime time.Time) NewWorkflowOptions

+ type PurgeOptions api.PurgeOptions

+ func WithRecursivePurge(recursive bool) PurgeOptions

+ type RaiseEventOptions api.RaiseEventOptions

+ func WithEventPayload(data any) RaiseEventOptions

+ func WithRawEventData(data *wrapperspb.StringValue) RaiseEventOptions

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) AddActivity(a Activity) error

+ func (r *Registry) AddActivityN(name string, a Activity) error

+ func (r *Registry) AddWorkflow(w Workflow) error

+ func (r *Registry) AddWorkflowN(name string, w Workflow) error

+ type RerunOptions api.RerunOptions

+ func WithRerunInput(input any) RerunOptions

+ func WithRerunNewInstanceID(id string) RerunOptions

+ type RetryPolicy struct

+ BackoffCoefficient float64

+ Handle func(error) bool

+ InitialRetryInterval time.Duration

+ MaxAttempts int

+ MaxRetryInterval time.Duration

+ RetryTimeout time.Duration

+ type Task task.Task

+ type TerminateOptions api.TerminateOptions

+ func WithOutput(data any) TerminateOptions

+ func WithRawOutput(data *wrapperspb.StringValue) TerminateOptions

+ func WithRecursiveTerminate(recursive bool) TerminateOptions

+ type Workflow func(ctx *WorkflowContext) (any, error)

+ type WorkflowContext struct

+ func (w *WorkflowContext) CallActivity(activity any, opts ...CallActivityOption) Task

+ func (w *WorkflowContext) CallChildWorkflow(workflow any, opts ...ChildWorkflowOption) Task

+ func (w *WorkflowContext) ContinueAsNew(newInput any, options ...ContinueAsNewOption)

+ func (w *WorkflowContext) CreateTimer(delay time.Duration, opts ...CreateTimerOption) Task

+ func (w *WorkflowContext) CurrentTimeUTC() time.Time

+ func (w *WorkflowContext) GetInput(v any) error

+ func (w *WorkflowContext) ID() string

+ func (w *WorkflowContext) IsReplaying() bool

+ func (w *WorkflowContext) Name() string

+ func (w *WorkflowContext) SetCustomStatus(cs string)

+ func (w *WorkflowContext) WaitForExternalEvent(eventName string, timeout time.Duration) Task

+ type WorkflowMetadata protos.OrchestrationMetadata

+ func (w WorkflowMetadata) String() string

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