# Functions
AllHandlersFinished returns true if all update handlers have finished execution.
Await blocks the calling thread until condition() returns true.
AwaitWithOptions blocks the calling thread until condition() returns true or blocking time exceeds the passed timeout value.
AwaitWithTimeout blocks the calling thread until condition() returns true or blocking time exceeds the passed timeout value.
CompleteSession completes a session.
CreateSession creates a session and returns a new context which contains information of the created session.
DataConverterWithoutDeadlockDetection returns a data converter that disables workflow deadlock detection for each call on the data converter.
DeterministicKeys returns the keys of a map in deterministic (sorted) order.
DeterministicKeysFunc returns the keys of a map in a deterministic (sorted) order.
ExecuteActivity requests activity execution in the context of a workflow.
ExecuteChildWorkflow requests child workflow execution in the context of a workflow.
ExecuteLocalActivity requests to run a local activity.
GetActivityOptions returns all activity options present on the context.
GetChildWorkflowOptions returns all workflow options present on the context.
GetCurrentDetails gets the current details for this workflow.
GetCurrentUpdateInfo returns information about the currently running update if any from the context.
GetInfo extracts info of a current workflow from a context.
GetLastCompletionResult extract last completion result from the last successful run for this cron or schedule workflow.
GetLastError extracts the error from the last run of this workflow.
GetLocalActivityOptions returns all local activity options present on the context.
GetLogger returns a logger to be used in workflow's context.
GetMetricsHandler returns a metrics handler to be used in workflow's context.
GetSessionInfo returns the sessionInfo stored in the context.
GetSignalChannel returns channel corresponding to the signal name.
GetSignalChannelWithOptions returns channel corresponding to the signal name.
GetTypedSearchAttributes returns a collection of the search attributes currently set for this workflow.
GetUnhandledSignalNames returns signal names that have unconsumed signals.
GetVersion is used to safely perform backwards incompatible changes to workflow definitions.
Go creates a new coroutine.
GoNamed creates a new coroutine with a given human-readable name.
HasLastCompletionResult checks if there is completion result from previous runs.
IsContinueAsNewError return if the err is a ContinueAsNewError.
IsReplaying returns whether the current workflow code is replaying.
MutableSideEffect executes the provided function once, then it looks up the history for the value with the given id.
NewBufferedChannel creates a new buffered Channel instance.
NewChannel creates a new Channel instance.
NewContinueAsNewError creates ContinueAsNewError instance If the workflow main function returns this error then the current execution is ended and the new execution with same workflow ID is started automatically with options provided to this function.
NewContinueAsNewErrorWithOptions creates ContinueAsNewError instance with additional options.
NewDisconnectedContext returns a new context that won't propagate parent's cancellation to the new child context.
NewFuture creates a new future as well as an associated Settable that is used to set its value.
NewMutex creates a new Mutex instance.
NewNamedBufferedChannel creates a new BufferedChannel instance with a given human-readable name.
NewNamedChannel creates a new Channel instance with a given human-readable name.
NewNamedSelector creates a new Selector instance with a given human-readable name.
Create a [NexusClient] from an endpoint name and a service name.
NewSelector creates a new Selector instance.
NewSemaphore creates a new Semaphore instance.
NewTimer returns immediately and the future becomes ready after the specified duration d.
NewTimerWithOptions returns immediately and the future becomes ready after the specified duration d.
NewWaitGroup creates a new WaitGroup instance.
Now returns the time when the workflow task was first started, even during replay.
RecreateSession recreate a session based on the sessionInfo passed in.
RequestCancelExternalWorkflow can be used to request cancellation of an external workflow.
SetCurrentDetails sets the current details for this workflow.
SetQueryHandler sets the query handler to handle workflow query.
SetQueryHandlerWithOptions is [SetQueryHandler] with extra options.
SetUpdateHandler forwards to SetUpdateHandlerWithOptions with an zero-initialized UpdateHandlerOptions struct.
SetUpdateHandlerWithOptions binds an update handler function to the specified name such that update invocations specifying that name will invoke the handler.
SideEffect executes the provided function once, records its result into the workflow history.
SignalExternalWorkflow can be used to send signal info to an external workflow.
Sleep pauses the current workflow for at least the duration d.
UpsertMemo is used to add or update workflow memo.
UpsertSearchAttributes is used to add or update workflow search attributes.
UpsertTypedSearchAttributes is used to add, update, or remove workflow search attributes.
WithActivityOptions makes a copy of the context and adds the passed in options to the context.
WithCancel returns a copy of parent with a new Done channel.
WithChildOptions adds all workflow options to the context.
WithDataConverter adds DataConverter to the context.
WithHeartbeatTimeout makes a copy of the current context and update the HeartbeatTimeout field in its activity options.
WithLocalActivityOptions makes a copy of the context and adds the passed in options to the context.
WithRetryPolicy makes a copy of the current context and update the RetryPolicy field in its activity options.
WithScheduleToCloseTimeout makes a copy of the current context and update the ScheduleToCloseTimeout field in its activity options.
WithScheduleToStartTimeout makes a copy of the current context and update the ScheduleToStartTimeout field in its activity options.
WithStartToCloseTimeout makes a copy of the current context and update the StartToCloseTimeout field in its activity options.
WithTaskQueue makes a copy of the current context and update the taskQueue field in its activity options.
WithValue returns a copy of parent in which the value associated with key is val.
WithWaitForCancellation makes a copy of the current context and update the WaitForCancellation field in its activity options.
WithWorkflowID adds a workflowID to the context.
WithWorkflowNamespace adds a namespace to the context.
WithWorkflowRunTimeout adds a run timeout to the context.
WithWorkflowTaskQueue adds a task queue to the context.
WithWorkflowTaskTimeout adds a workflow task timeout to the context.
WithWorkflowVersioningIntent is used to set the VersioningIntent before constructing a ContinueAsNewError with NewContinueAsNewError.
# Constants
DefaultVersion is a version returned by GetVersion for code that wasn't versioned before.
ABANDON the handler.
WarnAndAbandon issue a warning in addition to abandoning.
# Variables
ErrCanceled is the error returned by Context.Err when the context is canceled.
ErrDeadlineExceeded is the error returned by Context.Err when the context's deadline passes.
ErrSessionFailed is the error returned when user tries to execute an activity but the session it belongs to has already failed.
SessionStateClosed means the session was closed by the workflow and new activities will not be scheduled on the session host.
SessionStateFailed means the session worker was detected to be down and the session cannot be used to schedule new activities.
SessionStateOpen means the session worker is heartbeating and new activities will be schedule on the session host.
# Interfaces
No description provided by the author
# Type aliases
ActivityOptions stores all activity-specific invocation parameters that will be stored inside of a context.
No description provided by the author
A CancelFunc tells an operation to abandon its work.
No description provided by the author
No description provided by the author
No description provided by the author
Context is a clone of context.Context with Done() returning Channel instead of native channel.
ContextAware is an optional interface that can be implemented alongside DataConverter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HandlerUnfinishedPolicy defines the actions taken when a workflow exits while update handlers are running.
No description provided by the author
No description provided by the author
No description provided by the author
LocalActivityOptions doc.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author