Class Failure
Implements
Google.Protobuf.IBufferMessage
Assembly: Temporalio.dll
Syntax
public sealed class Failure : Google.Protobuf.IMessage<Failure>, Google.Protobuf.IBufferMessage
Constructors
Failure()
Declaration
Failure(Failure)
Declaration
public Failure(Failure other)
Parameters
Type |
Name |
Description |
Failure |
other |
|
Fields
ActivityFailureInfoFieldNumber
Field number for the "activity_failure_info" field.
Declaration
public const int ActivityFailureInfoFieldNumber = null
Field Value
ApplicationFailureInfoFieldNumber
Field number for the "application_failure_info" field.
Declaration
public const int ApplicationFailureInfoFieldNumber = null
Field Value
CanceledFailureInfoFieldNumber
Field number for the "canceled_failure_info" field.
Declaration
public const int CanceledFailureInfoFieldNumber = null
Field Value
CauseFieldNumber
Field number for the "cause" field.
Declaration
public const int CauseFieldNumber = null
Field Value
ChildWorkflowExecutionFailureInfoFieldNumber
Field number for the "child_workflow_execution_failure_info" field.
Declaration
public const int ChildWorkflowExecutionFailureInfoFieldNumber = null
Field Value
EncodedAttributesFieldNumber
Field number for the "encoded_attributes" field.
Declaration
public const int EncodedAttributesFieldNumber = null
Field Value
MessageFieldNumber
Field number for the "message" field.
Declaration
public const int MessageFieldNumber = null
Field Value
ResetWorkflowFailureInfoFieldNumber
Field number for the "reset_workflow_failure_info" field.
Declaration
public const int ResetWorkflowFailureInfoFieldNumber = null
Field Value
ServerFailureInfoFieldNumber
Field number for the "server_failure_info" field.
Declaration
public const int ServerFailureInfoFieldNumber = null
Field Value
SourceFieldNumber
Field number for the "source" field.
Declaration
public const int SourceFieldNumber = null
Field Value
StackTraceFieldNumber
Field number for the "stack_trace" field.
Declaration
public const int StackTraceFieldNumber = null
Field Value
TerminatedFailureInfoFieldNumber
Field number for the "terminated_failure_info" field.
Declaration
public const int TerminatedFailureInfoFieldNumber = null
Field Value
TimeoutFailureInfoFieldNumber
Field number for the "timeout_failure_info" field.
Declaration
public const int TimeoutFailureInfoFieldNumber = null
Field Value
Properties
ActivityFailureInfo
Declaration
public ActivityFailureInfo ActivityFailureInfo { get; set; }
Property Value
ApplicationFailureInfo
Declaration
public ApplicationFailureInfo ApplicationFailureInfo { get; set; }
Property Value
CanceledFailureInfo
Declaration
public CanceledFailureInfo CanceledFailureInfo { get; set; }
Property Value
Cause
Declaration
public Failure Cause { get; set; }
Property Value
ChildWorkflowExecutionFailureInfo
Declaration
public ChildWorkflowExecutionFailureInfo ChildWorkflowExecutionFailureInfo { get; set; }
Property Value
Descriptor
Declaration
public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
Type |
Description |
Google.Protobuf.Reflection.MessageDescriptor |
|
EncodedAttributes
Alternative way to supply message
and stack_trace
and possibly other attributes, used for encryption of
errors originating in user code which might contain sensitive information.
The encoded_attributes
Payload could represent any serializable object, e.g. JSON object or a Failure
proto
message.
SDK authors:
The SDK should provide a default encodeFailureAttributes
and decodeFailureAttributes
implementation that:
Uses a JSON object to represent { message, stack_trace }
.
Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.
Overwrites the original stack_trace with an empty string.
The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed
by the user-provided PayloadCodec
If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.
(-- api-linter: core::0203::optional=disabled --)
Declaration
public Payload EncodedAttributes { get; set; }
Property Value
FailureInfoCase
Declaration
public Failure.FailureInfoOneofCase FailureInfoCase { get; }
Property Value
Message
Declaration
public string Message { get; set; }
Property Value
Parser
Declaration
public static Google.Protobuf.MessageParser<Failure> Parser { get; }
Property Value
Type |
Description |
Google.Protobuf.MessageParser<Failure> |
|
ResetWorkflowFailureInfo
Declaration
public ResetWorkflowFailureInfo ResetWorkflowFailureInfo { get; set; }
Property Value
ServerFailureInfo
Declaration
public ServerFailureInfo ServerFailureInfo { get; set; }
Property Value
Source
The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK
In some SDKs this is used to rehydrate the stack trace into an exception object.
Declaration
public string Source { get; set; }
Property Value
StackTrace
Declaration
public string StackTrace { get; set; }
Property Value
TerminatedFailureInfo
Declaration
public TerminatedFailureInfo TerminatedFailureInfo { get; set; }
Property Value
TimeoutFailureInfo
Declaration
public TimeoutFailureInfo TimeoutFailureInfo { get; set; }
Property Value
Methods
CalculateSize()
Declaration
public int CalculateSize()
Returns
ClearFailureInfo()
Declaration
public void ClearFailureInfo()
Clone()
Declaration
Returns
Equals(Object)
Declaration
public override bool Equals(object other)
Parameters
Type |
Name |
Description |
Object |
other |
|
Returns
Equals(Failure)
Declaration
public bool Equals(Failure other)
Parameters
Type |
Name |
Description |
Failure |
other |
|
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Declaration
public void MergeFrom(Google.Protobuf.CodedInputStream input)
Parameters
Type |
Name |
Description |
Google.Protobuf.CodedInputStream |
input |
|
MergeFrom(Failure)
Declaration
public void MergeFrom(Failure other)
Parameters
Type |
Name |
Description |
Failure |
other |
|
ToString()
Declaration
public override string ToString()
Returns
WriteTo(Google.Protobuf.CodedOutputStream)
Declaration
public void WriteTo(Google.Protobuf.CodedOutputStream output)
Parameters
Type |
Name |
Description |
Google.Protobuf.CodedOutputStream |
output |
|
Implements
Google.Protobuf.IBufferMessage