CanceledFailure
extends TemporalFailure
in package
Represents failures that can cross workflow and activity boundaries.
Only exceptions that extend this class will be propagated to the caller.
Never extend this class or any of its derivatives. They are to be used by the SDK code only. Throw an instance [](ApplicationFailure) to pass application specific errors between workflows and activities.
Any unhandled exception thrown by an activity or workflow will be converted to an instance of [](ApplicationFailure).
Table of Contents
Properties
- $details : ValuesInterface
- $failure : Failure|null
- $originalMessage : string
- $originalStackTrace : string|null
Methods
- __construct() : mixed
- __toString() : string
- getDetails() : ValuesInterface
- getFailure() : Failure|null
- getOriginalMessage() : string
- getOriginalStackTrace() : string|null
- hasOriginalStackTrace() : bool
- setDataConverter() : void
- setFailure() : void
- setOriginalStackTrace() : void
- buildMessage() : string
- Explain known types of key=>value pairs.
Properties
$details
private
ValuesInterface
$details
$failure
private
Failure|null
$failure
= null
$originalMessage
private
string
$originalMessage
$originalStackTrace
private
string|null
$originalStackTrace
= null
Methods
__construct()
public
__construct(string $message[, ValuesInterface|null $details = null ][, Throwable|null $previous = null ]) : mixed
Parameters
- $message : string
- $details : ValuesInterface|null = null
- $previous : Throwable|null = null
__toString()
public
__toString() : string
Return values
stringgetDetails()
public
getDetails() : ValuesInterface
Return values
ValuesInterfacegetFailure()
public
getFailure() : Failure|null
Return values
Failure|nullgetOriginalMessage()
public
getOriginalMessage() : string
Return values
stringgetOriginalStackTrace()
public
getOriginalStackTrace() : string|null
Return values
string|nullhasOriginalStackTrace()
public
hasOriginalStackTrace() : bool
Tags
Return values
boolsetDataConverter()
public
setDataConverter(DataConverterInterface $converter) : void
Parameters
- $converter : DataConverterInterface
setFailure()
public
setFailure(Failure|null $failure) : void
Parameters
- $failure : Failure|null
setOriginalStackTrace()
public
setOriginalStackTrace(string $stackTrace) : void
Parameters
- $stackTrace : string
buildMessage()
Explain known types of key=>value pairs.
protected
static buildMessage(array<string|int, mixed> $values) : string
Parameters
- $values : array<string|int, mixed>