api

Jan 30, 2026

Changes in this version

+ var ErrStalled = errors.New("workflow is stalled")

+ func IsUnsupportedVersionError(err error) bool

+ func NewUnsupportedVersionError() error

+ type GetInstanceHistoryOptions func(*protos.GetInstanceHistoryRequest) error

+ type ListInstanceIDsOptions func(*protos.ListInstanceIDsRequest) error

+ func WithListInstanceIDsContinuationToken(token string) ListInstanceIDsOptions

+ func WithListInstanceIDsPageSize(pageSize uint32) ListInstanceIDsOptions

type OrchestrationStatus

+ const RUNTIME_STATUS_STALLED

type PurgeOptions

+ func WithForcePurge(force bool) PurgeOptions

+ type UnsupportedVersionError struct

+ func (e *UnsupportedVersionError) Error() string

Dec 3, 2025

Changes in this version

+ func IsUnknownInstanceIDError(err error) bool

+ func IsUnknownTaskIDError(err error) bool

+ func NewUnknownInstanceIDError(instanceID string) error

+ func NewUnknownTaskIDError(instanceID string, taskID int32) error

+ type UnknownInstanceIDError struct

+ InstanceID string

+ func (e *UnknownInstanceIDError) Error() string

+ type UnknownTaskIDError struct

+ InstanceID string

+ TaskID int32

+ func (e *UnknownTaskIDError) Error() string

Aug 21, 2025

Changes in this version

+ var ErrTaskCancelled = errors.New("task was cancelled")

May 6, 2025

Changes in this version

type InstanceID

+ func (i InstanceID) String() string

+ type RerunOptions func(*protos.RerunWorkflowFromEventRequest) error

+ func WithRerunInput(input any) RerunOptions

+ func WithRerunNewInstanceID(id InstanceID) RerunOptions

Jan 24, 2025

Changes in this version

+ var EmptyInstanceID = InstanceID("")

+ var ErrDuplicateInstance = errors.New("orchestration instance already exists")

+ var ErrIgnoreInstance = errors.New("ignore creating orchestration instance")

+ var ErrInstanceNotFound = errors.New("no such instance exists")

+ var ErrNoFailures = errors.New("orchestration did not report failure details")

+ var ErrNotCompleted = errors.New("orchestration has not yet completed")

+ var ErrNotStarted = errors.New("orchestration has not started")

+ func OrchestrationMetadataIsComplete(o *protos.OrchestrationMetadata) bool

+ func OrchestrationMetadataIsRunning(o *protos.OrchestrationMetadata) bool

+ type CreateOrchestrationAction = protos.CreateOrchestrationAction

+ const REUSE_ID_ACTION_ERROR

+ const REUSE_ID_ACTION_IGNORE

+ const REUSE_ID_ACTION_TERMINATE

+ type FetchOrchestrationMetadataOptions func(*protos.GetInstanceRequest)

+ func WithFetchPayloads(fetchPayloads bool) FetchOrchestrationMetadataOptions

+ type InstanceID string

+ type NewOrchestrationOptions func(*protos.CreateInstanceRequest) error

+ func WithInput(input any) NewOrchestrationOptions

+ func WithInstanceID(id InstanceID) NewOrchestrationOptions

+ func WithOrchestrationIdReusePolicy(policy *protos.OrchestrationIdReusePolicy) NewOrchestrationOptions

+ func WithRawInput(rawInput *wrapperspb.StringValue) NewOrchestrationOptions

+ func WithStartTime(startTime time.Time) NewOrchestrationOptions

+ type OrchestrationIdReusePolicy = protos.OrchestrationIdReusePolicy

+ type OrchestrationStatus = protos.OrchestrationStatus

+ const RUNTIME_STATUS_CANCELED

+ const RUNTIME_STATUS_COMPLETED

+ const RUNTIME_STATUS_CONTINUED_AS_NEW

+ const RUNTIME_STATUS_FAILED

+ const RUNTIME_STATUS_PENDING

+ const RUNTIME_STATUS_RUNNING

+ const RUNTIME_STATUS_SUSPENDED

+ const RUNTIME_STATUS_TERMINATED

+ type PurgeOptions func(*protos.PurgeInstancesRequest) error

+ func WithRecursivePurge(recursive bool) PurgeOptions

+ type RaiseEventOptions func(*protos.RaiseEventRequest) error

+ func WithEventPayload(data any) RaiseEventOptions

+ func WithRawEventData(data *wrapperspb.StringValue) RaiseEventOptions

+ type TerminateOptions func(*protos.TerminateRequest) error

+ func WithOutput(data any) TerminateOptions

+ func WithRawOutput(data *wrapperspb.StringValue) TerminateOptions

+ func WithRecursiveTerminate(recursive bool) TerminateOptions