UpdateOptions
in package
uses
CloneWith
Table of Contents
Properties
- $firstExecutionRunId : string|null
- $resultType : mixed
- $updateId : string|null
- $updateName : string
- $waitPolicy : WaitPolicy
Methods
- new() : self
- withFirstExecutionRunId() : self
- The RunID expected to identify the first run in the workflow execution chain. If this expectation does not match then the server will reject the update request with an error.
- withResultType() : self
- The type of the update return value.
- withUpdateId() : self
- The update ID is an application-layer identifier for the requested update. It must be unique within the scope of a workflow execution.
- withUpdateName() : self
- Name of the update handler. Usually it is a method name.
- withWaitPolicy() : self
- Specifies at what point in the update request life cycles this request should return.
- __construct() : mixed
Properties
$firstExecutionRunId read-only
public
string|null
$firstExecutionRunId
$resultType read-only
public
mixed
$resultType
$updateId read-only
public
string|null
$updateId
$updateName read-only
public
string
$updateName
$waitPolicy read-only
public
WaitPolicy
$waitPolicy
Methods
new()
public
static new(non-empty-string $updateName[, LifecycleStage $lifecycleStage = LifecycleStage::StageAccepted ]) : self
Parameters
- $updateName : non-empty-string
-
Name of the update handler. Usually it is a method name.
- $lifecycleStage : LifecycleStage = LifecycleStage::StageAccepted
-
Specifies at what point in the update request life cycles this request should return. By default, it is set to LifecycleStage::StageAccepted that means that the handle will return immediately after successful validation of the Update call. However, also note that the processing Workflow worker must be available. Otherwise, the request may block indefinitely or fail due to a timeout.
Tags
Return values
selfwithFirstExecutionRunId()
The RunID expected to identify the first run in the workflow execution chain. If this expectation does not match then the server will reject the update request with an error.
public
withFirstExecutionRunId(string|null $runId) : self
Parameters
- $runId : string|null
Return values
selfwithResultType()
The type of the update return value.
public
withResultType(mixed $type) : self
Parameters
- $type : mixed
Return values
selfwithUpdateId()
The update ID is an application-layer identifier for the requested update. It must be unique within the scope of a workflow execution.
public
withUpdateId(string|null $id) : self
Parameters
- $id : string|null
Return values
selfwithUpdateName()
Name of the update handler. Usually it is a method name.
public
withUpdateName(string $name) : self
Parameters
- $name : string
Return values
selfwithWaitPolicy()
Specifies at what point in the update request life cycles this request should return.
public
withWaitPolicy(WaitPolicy $policy) : self
Parameters
- $policy : WaitPolicy
Return values
self__construct()
private
__construct(string $updateName, LifecycleStage $lifecycleStage) : mixed
Parameters
- $updateName : string
- $lifecycleStage : LifecycleStage