QueryMethod
in package
FinalYes
Indicates that the method is a query method. Query method can be used to query a workflow state by external process at any time during its execution.
This annotation/attribute applies only to workflow interface methods.
Query methods must never change any workflow state including starting activities or block threads in any way.
Tags
Table of Contents
Properties
- $description : string
- $name : string|null
Methods
- __construct() : mixed
Attributes
#[Attribute]
#[Attribute]
#[NamedArgumentConstructor]
#[NamedArgumentConstructor]
Properties
$description read-only
public
string
$description
= ''
$name read-only
public
string|null
$name
= null
Methods
__construct()
public
__construct([non-empty-string|null $name = null ][, string $description = '' ]) : mixed
Parameters
- $name : non-empty-string|null = null
-
Query method name. Default is method name. Name cannot start with
__temporalas it is reserved for internal use. The name also cannot be__stack_traceor__enhanced_stack_traceas they are reserved for internal use. - $description : string = ''
-
Short description of the query type.