UpdateHandle
in package
FinalYes
UpdateHandle is a handle to an update workflow execution request that can be used to get the status of that update request.
Table of Contents
Properties
- $client : ServiceClientInterface
- $clientOptions : ClientOptions
- $converter : DataConverterInterface
- $result : ValuesInterface|WorkflowUpdateException|null
- $updateInput : UpdateInput
- $updateRef : UpdateRef
Methods
- __construct() : mixed
- getEncodedValues() : ValuesInterface
- Fetch and return the encoded result of this update request.
- getExecution() : WorkflowExecution
- Gets the workflow execution this update request was sent to.
- getId() : string
- Gets the unique ID of this update.
- getResult() : mixed
- Fetch and decode the result of this update request.
- hasResult() : bool
- Check there is a cached accepted result or failure for this update request.
- fetchResult() : void
Properties
$client read-only
private
ServiceClientInterface
$client
$clientOptions read-only
private
ClientOptions
$clientOptions
$converter read-only
private
DataConverterInterface
$converter
$result
private
ValuesInterface|WorkflowUpdateException|null
$result
$updateInput read-only
private
UpdateInput
$updateInput
$updateRef read-only
private
UpdateRef
$updateRef
Methods
__construct()
public
__construct(ServiceClientInterface $client, ClientOptions $clientOptions, DataConverterInterface $converter, UpdateInput $updateInput, UpdateRef $updateRef, ValuesInterface|WorkflowUpdateException|null $result) : mixed
Parameters
- $client : ServiceClientInterface
- $clientOptions : ClientOptions
- $converter : DataConverterInterface
- $updateInput : UpdateInput
- $updateRef : UpdateRef
- $result : ValuesInterface|WorkflowUpdateException|null
getEncodedValues()
Fetch and return the encoded result of this update request.
public
getEncodedValues([int|float|null $timeout = null ]) : ValuesInterface
Parameters
- $timeout : int|float|null = null
-
Timeout in seconds. Accuracy to milliseconds.
Tags
Return values
ValuesInterfacegetExecution()
Gets the workflow execution this update request was sent to.
public
getExecution() : WorkflowExecution
Return values
WorkflowExecutiongetId()
Gets the unique ID of this update.
public
getId() : string
Return values
stringgetResult()
Fetch and decode the result of this update request.
public
getResult([int|float|null $timeout = null ]) : mixed
Parameters
- $timeout : int|float|null = null
-
Timeout in seconds. Accuracy to milliseconds.
Tags
hasResult()
Check there is a cached accepted result or failure for this update request.
public
hasResult() : bool
Return values
boolfetchResult()
private
fetchResult([int|float|null $timeout = null ]) : void
Parameters
- $timeout : int|float|null = null
-
Timeout in seconds. Accuracy to milliseconds.