UpdateMethod
in package
FinalYes
Indicates that the method is an update handler method.
An update method gets executed when a workflow receives an update after the validator is called.
Tags
Table of Contents
Properties
- $name : string|null
- $unfinishedPolicy : HandlerUnfinishedPolicy
Methods
- __construct() : mixed
Attributes
#[Attribute]
#[Attribute]
#[NamedArgumentConstructor]
#[NamedArgumentConstructor]
Properties
$name read-only
public
string|null
$name
= null
$unfinishedPolicy read-only
public
HandlerUnfinishedPolicy
$unfinishedPolicy
= HandlerUnfinishedPolicy::WarnAndAbandon
Methods
__construct()
public
__construct([non-empty-string|null $name = null ][, HandlerUnfinishedPolicy $unfinishedPolicy = HandlerUnfinishedPolicy::WarnAndAbandon ]) : mixed
Parameters
- $name : non-empty-string|null = null
-
Name of the update handler. Default is method name. Be careful about names that contain special characters. These names can be used as metric tags. And systems like prometheus ignore metrics which have tags with unsupported characters.
- $unfinishedPolicy : HandlerUnfinishedPolicy = HandlerUnfinishedPolicy::WarnAndAbandon
-
Actions taken if a workflow exits with a running instance of this handler.