ZWorkflow
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- ZWorkflow.type
Members list
Value members
Concrete methods
Suspends workflow execution until the given predicate holds
Suspends workflow execution until the given predicate holds
Attributes
- cond
await condition
- Returns:
unblocks when condition becomes true
- See also:
Workflow.await
Suspends workflow execution until either the given predicate holds or timeout elapsed
Suspends workflow execution until either the given predicate holds or timeout elapsed
Attributes
- cond
await condition
- timeout
await timeout
- Returns:
unblocks when condition becomes true or timeout elapsed. '''False''' if timed out
- See also:
Workflow.await
Suspends workflow execution while the given predicate holds
Suspends workflow execution while the given predicate holds
Attributes
- cond
await condition
- Returns:
unblocks when condition becomes false
- See also:
Workflow.await
Suspends workflow execution while either the given predicate holds or timeout elapsed
Suspends workflow execution while either the given predicate holds or timeout elapsed
Attributes
- cond
await condition
- timeout
await timeout
- Returns:
unblocks when condition becomes false or timeout elapsed. '''False''' if timed out
- See also:
Workflow.await
Returns current timestamp
Returns current timestamp
Should be used instead of java.lang.System.currentTimeMillis() to guarantee determinism
Attributes
- Returns:
current time millis as ZCurrentTimeMillis
- See also:
Workflow.currentTimeMillis()
GetLastCompletionResult extract last completion result from previous run for this cron workflow. This is used in combination with cron schedule. A workflow can be started with an optional cron schedule. If a cron workflow wants to pass some data to next schedule, it can return any data and that data will become available when next run starts.
GetLastCompletionResult extract last completion result from previous run for this cron workflow. This is used in combination with cron schedule. A workflow can be started with an optional cron schedule. If a cron workflow wants to pass some data to next schedule, it can return any data and that data will become available when next run starts.
Attributes
- R
type of the return data from last run
- Returns:
result of last run
- See also:
io.temporal.client.WorkflowOptions.Builder#setCronSchedule(String)
Get logger to use inside workflow. Logs in replay mode are omitted unless zio.temporal.worker.ZWorkerFactoryOptions.enableLoggingInReplay is set to 'true'.
Get logger to use inside workflow. Logs in replay mode are omitted unless zio.temporal.worker.ZWorkerFactoryOptions.enableLoggingInReplay is set to 'true'.
Attributes
- name
name to appear in logging.
- Returns:
logger to use in workflow logic.
Get logger to use inside workflow. Logs in replay mode are omitted unless zio.temporal.worker.ZWorkerFactoryOptions.enableLoggingInReplay is set to 'true'.
Get logger to use inside workflow. Logs in replay mode are omitted unless zio.temporal.worker.ZWorkerFactoryOptions.enableLoggingInReplay is set to 'true'.
Attributes
- clazz
class name to appear in logging.
- Returns:
logger to use in workflow logic.
Extract the latest failure from a previous run of this workflow. If any previous run of this workflow has failed, this function returns that failure. If no previous runs have failed, an empty optional is returned. The run you are calling this from may have been created as a retry of the previous failed run or as a next cron invocation for cron workflows.
Extract the latest failure from a previous run of this workflow. If any previous run of this workflow has failed, this function returns that failure. If no previous runs have failed, an empty optional is returned. The run you are calling this from may have been created as a retry of the previous failed run or as a next cron invocation for cron workflows.
Attributes
- Returns:
The last Exceptionthat occurred in this workflow, if there has been one.
Retrieves workflow info
Creates a builder of client stub to activities that implement given interface.
Creates a builder of client stub to activities that implement given interface.
Attributes
- A
activity interface
- Returns:
activity stub builder
Wraps a procedure in a CancellationScope. The procedure receives the wrapping CancellationScope as a parameter. Useful when cancellation is requested from within the wrapped code. The following example cancels the sibling activity on any failure.
Wraps a procedure in a CancellationScope. The procedure receives the wrapping CancellationScope as a parameter. Useful when cancellation is requested from within the wrapped code. The following example cancels the sibling activity on any failure.
Attributes
- thunk
code to wrap in the cancellation scope
- Returns:
wrapped proc
- See also:
Workflow.newCancellationScope
Wraps a procedure in a CancellationScope. The procedure receives the wrapping CancellationScope as a parameter. Useful when cancellation is requested from within the wrapped code. The following example cancels the sibling activity on any failure.
Wraps a procedure in a CancellationScope. The procedure receives the wrapping CancellationScope as a parameter. Useful when cancellation is requested from within the wrapped code. The following example cancels the sibling activity on any failure.
Attributes
- thunk
code to wrap in the cancellation scope
- Returns:
wrapped proc
- See also:
Workflow.newCancellationScope
Creates a builder of client stub that can be used to start a child workflow that implements given interface.
Creates a builder of client stub that can be used to start a child workflow that implements given interface.
Attributes
- A
workflow interface
- Returns:
child workflow stub builder
Creates a CancellationScope that is not linked to a parent scope. ZCancellationScope.run must be called to execute the code the scope wraps. The detached scope is needed to execute cleanup code after a workflow is canceled which cancels the root scope that wraps the @WorkflowMethod invocation. Here is an example usage:
Creates a CancellationScope that is not linked to a parent scope. ZCancellationScope.run must be called to execute the code the scope wraps. The detached scope is needed to execute cleanup code after a workflow is canceled which cancels the root scope that wraps the @WorkflowMethod invocation. Here is an example usage:
Attributes
- thunk
parameter to wrap in a cancellation scope.
- Returns:
wrapped parameter.
- See also:
Workflow.newDetachedCancellationScope
Creates client stub that can be used to signal or cancel an existing workflow
Creates client stub that can be used to signal or cancel an existing workflow
Attributes
- A
workflow interface
- workflowId
id of the workflow to communicate with.
- Returns:
external workflow stub
Creates client stub that can be used to signal or cancel an existing workflow
Creates client stub that can be used to signal or cancel an existing workflow
Attributes
- A
workflow interface
- workflowExecution
execution of the workflow to communicate with.
- Returns:
external workflow stub
Creates a builder of client stub to local activities that implement given interface.
Creates a builder of client stub to local activities that implement given interface.
Attributes
- A
activity interface
- Returns:
local activity stub builder
Creates a builder of untyped client stub to activities
Creates a builder of untyped client stub to activities
Attributes
- Returns:
untyped activity stub builder
Creates a builder of untyped client stub that can be used to start a child workflow that implements given interface.
Creates a builder of untyped client stub that can be used to start a child workflow that implements given interface.
Attributes
- Returns:
child workflow stub builder
Creates untyped client stub that can be used to signal or cancel an existing workflow
Creates untyped client stub that can be used to signal or cancel an existing workflow
Attributes
- workflowId
id of the workflow to communicate with.
- Returns:
external workflow stub
Creates untyped client stub that can be used to signal or cancel an existing workflow
Creates untyped client stub that can be used to signal or cancel an existing workflow
Attributes
- workflowExecution
execution of the workflow to communicate with.
- Returns:
external workflow stub
Creates a builder of untyped client stub to local activities that implement given interface.
Creates a builder of untyped client stub to local activities that implement given interface.
Attributes
- Returns:
local activity stub builder
Generated random UUID
Generated random UUID
Should be used instead of UUID.randomUUID() to guarantee determinism
Attributes
- Returns:
generated UUID
- See also:
Workflow.randomUUID()
Suspends workflow execution until the given duration elapsed
Suspends workflow execution until the given duration elapsed
Attributes
- duration
time to sleep
- Returns:
unblocks when duration elapsed
- See also:
Workflow.sleep
Adds or updates workflow search attributes.
Adds or updates workflow search attributes.
Attributes
- attrs
map of String to ZSearchAttribute value that can be used to search in list APIs
- See also:
Workflow.upsertSearchAttributes
Returns current workflow version
Returns current workflow version
Attributes
- changeId
identifier of a particular change. All calls to getVersion that share a changeId are guaranteed to return the same version number. Use this to perform multiple coordinated changes that should be enabled together.
- maxSupported
max version supported for the change
- minSupported
min version supported for the change
- Returns:
version
- See also:
Workflow.getVersion