Class ApplicationFailureException

Namespace

Temporalio.Exceptions

Assembly

Temporalio.dll

Exception representing an error in user code.

public class ApplicationFailureException : FailureException, ISerializable

Inheritance

object

Exception

TemporalException

FailureException

ApplicationFailureException

Implements

ISerializable

Inherited Members

FailureException.Failure

FailureException.StackTrace

TemporalException.IsCanceledException(Exception)

Exception.GetBaseException()

Exception.GetObjectData(SerializationInfo, StreamingContext)

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.TargetSite

Exception.SerializeObjectState

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

For workflows, users should throw this exception to signal a workflow failure. Other non-Temporal exceptions will not fail the workflow.

In activities, all non-Temporal exceptions are translated to this exception as retryable with the Type as the unqualified exception class name.

Constructors

ApplicationFailureException(string, Exception?, string?, bool, IReadOnlyCollection<object?>?, TimeSpan?, ApplicationErrorCategory)

Initializes a new instance of the ApplicationFailureException class.

public ApplicationFailureException(string message, Exception? inner, string? errorType = null, bool nonRetryable = false, IReadOnlyCollection<object?>? details = null, TimeSpan? nextRetryDelay = null, ApplicationErrorCategory category = ApplicationErrorCategory.Unspecified)

Parameters

message string

Required message for the exception.

inner Exception

Cause of the exception (can use other constructor if no cause).

errorType string

Optional string type name of the exception.

nonRetryable bool

If true, marks the exception as non-retryable.

details IReadOnlyCollection<object>

Collection of details to serialize into the exception.

nextRetryDelay TimeSpan?

Override the next retry delay with this value.

category ApplicationErrorCategory

Error category.

ApplicationFailureException(string, string?, bool, IReadOnlyCollection<object?>?, TimeSpan?, ApplicationErrorCategory)

Initializes a new instance of the ApplicationFailureException class.

public ApplicationFailureException(string message, string? errorType = null, bool nonRetryable = false, IReadOnlyCollection<object?>? details = null, TimeSpan? nextRetryDelay = null, ApplicationErrorCategory category = ApplicationErrorCategory.Unspecified)

Parameters

message string

Required message for the exception.

errorType string

Optional string type name of the exception.

nonRetryable bool

If true, marks the exception as non-retryable.

details IReadOnlyCollection<object>

Collection of details to serialize into the exception.

nextRetryDelay TimeSpan?

Override the next retry delay with this value.

category ApplicationErrorCategory

Error category.

ApplicationFailureException(Failure, Exception?, IPayloadConverter)

Initializes a new instance of the ApplicationFailureException class.

protected ApplicationFailureException(Failure failure, Exception? inner, IPayloadConverter converter)

Parameters

failure Failure

Underlying proto failure.

inner Exception

Inner exception if any.

converter IPayloadConverter

Converter used for converting details.

Properties

Category

Gets the error category.

public ApplicationErrorCategory Category { get; protected init; }

Property Value

ApplicationErrorCategory

Details

Gets the details of the exception. This is never null.

public IFailureDetails Details { get; protected init; }

Property Value

IFailureDetails

Remarks

This will be OutboundFailureDetails for user-created exceptions and InboundFailureDetails for server-serialized exceptions.

ErrorType

Gets the string "type" of the exception if any.

public string? ErrorType { get; protected init; }

Property Value

string

NextRetryDelay

Gets the next retry delay override if any was set.

public TimeSpan? NextRetryDelay { get; protected init; }

Property Value

TimeSpan?

NonRetryable

Gets a value indicating whether this exception is non-retryable.

public bool NonRetryable { get; protected init; }

Property Value

bool