WorkflowHandle
in package
implements
WorkflowHandleInterface
FinalYes
Operations bound to one stable workflow ID and, optionally, its originally selected run.
Table of Contents
Interfaces
- WorkflowHandleInterface
- Workflow interactions shared by live and in-memory handles.
Properties
- $selectedRunId : string|null
- $workflowId : string
- $workflowType : string
- $client : Client
Methods
- __construct() : mixed
- cancel() : void
- cancelSelectedRun() : void
- describe() : WorkflowExecution
- describeSelectedRun() : WorkflowExecution
- query() : mixed
- querySelectedRun() : mixed
- result() : mixed
- resultOfSelectedRun() : mixed
- runs() : array<int, WorkflowRun>
- signal() : void
- signalSelectedRun() : void
- terminate() : void
- terminateSelectedRun() : void
- update() : mixed
- updateSelectedRun() : mixed
- requireSelectedRun() : string
Properties
$selectedRunId read-only
public
string|null
$selectedRunId
= null
$workflowId read-only
public
string
$workflowId
$workflowType read-only
public
string
$workflowType
= ''
$client read-only
private
Client
$client
Methods
__construct()
public
__construct(Client $client, string $workflowId[, string|null $selectedRunId = null ][, string $workflowType = '' ]) : mixed
Parameters
- $client : Client
- $workflowId : string
- $selectedRunId : string|null = null
- $workflowType : string = ''
cancel()
public
cancel([string|null $reason = null ]) : void
Parameters
- $reason : string|null = null
cancelSelectedRun()
public
cancelSelectedRun([string|null $reason = null ]) : void
Parameters
- $reason : string|null = null
describe()
public
describe() : WorkflowExecution
Return values
WorkflowExecutiondescribeSelectedRun()
public
describeSelectedRun() : WorkflowExecution
Return values
WorkflowExecutionquery()
public
query(string $name[, array<int, mixed> $arguments = [] ]) : mixed
Parameters
- $name : string
- $arguments : array<int, mixed> = []
querySelectedRun()
public
querySelectedRun(string $name[, array<int, mixed> $arguments = [] ]) : mixed
Parameters
- $name : string
- $arguments : array<int, mixed> = []
result()
public
result([float $timeoutSeconds = 30.0 ][, float $pollIntervalSeconds = 0.5 ]) : mixed
Parameters
- $timeoutSeconds : float = 30.0
- $pollIntervalSeconds : float = 0.5
resultOfSelectedRun()
public
resultOfSelectedRun([float $timeoutSeconds = 30.0 ][, float $pollIntervalSeconds = 0.5 ]) : mixed
Parameters
- $timeoutSeconds : float = 30.0
- $pollIntervalSeconds : float = 0.5
runs()
public
runs() : array<int, WorkflowRun>
Return values
array<int, WorkflowRun>signal()
public
signal(string $name[, array<int, mixed> $arguments = [] ]) : void
Parameters
- $name : string
- $arguments : array<int, mixed> = []
signalSelectedRun()
public
signalSelectedRun(string $name[, array<int, mixed> $arguments = [] ]) : void
Parameters
- $name : string
- $arguments : array<int, mixed> = []
terminate()
public
terminate([string|null $reason = null ]) : void
Parameters
- $reason : string|null = null
terminateSelectedRun()
public
terminateSelectedRun([string|null $reason = null ]) : void
Parameters
- $reason : string|null = null
update()
public
update(string $name[, array<int, mixed> $arguments = [] ][, string $waitFor = 'completed' ][, int|null $waitTimeoutSeconds = null ][, string|null $requestId = null ]) : mixed
Parameters
- $name : string
- $arguments : array<int, mixed> = []
- $waitFor : string = 'completed'
- $waitTimeoutSeconds : int|null = null
- $requestId : string|null = null
updateSelectedRun()
public
updateSelectedRun(string $name[, array<int, mixed> $arguments = [] ][, string $waitFor = 'completed' ][, int|null $waitTimeoutSeconds = null ][, string|null $requestId = null ]) : mixed
Parameters
- $name : string
- $arguments : array<int, mixed> = []
- $waitFor : string = 'completed'
- $waitTimeoutSeconds : int|null = null
- $requestId : string|null = null
requireSelectedRun()
private
requireSelectedRun() : string