Class: Failure
Represents a Failure.
Implements
Constructors
constructor
• new Failure(properties?): Failure
Constructs a new Failure.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFailure | Properties to set |
Returns
Properties
activityFailureInfo
• Optional activityFailureInfo: null | IActivityFailureInfo
Failure activityFailureInfo.
Implementation of
applicationFailureInfo
• Optional applicationFailureInfo: null | IApplicationFailureInfo
Failure applicationFailureInfo.
Implementation of
IFailure.applicationFailureInfo
canceledFailureInfo
• Optional canceledFailureInfo: null | ICanceledFailureInfo
Failure canceledFailureInfo.
Implementation of
cause
• Optional cause: null | IFailure
Failure cause.
Implementation of
childWorkflowExecutionFailureInfo
• Optional childWorkflowExecutionFailureInfo: null | IChildWorkflowExecutionFailureInfo
Failure childWorkflowExecutionFailureInfo.
Implementation of
IFailure.childWorkflowExecutionFailureInfo
encodedAttributes
• Optional encodedAttributes: null | IPayload
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
encodeFailureAttributesanddecodeFailureAttributesimplementation 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 --)
Implementation of
failureInfo
• Optional failureInfo: "applicationFailureInfo" | "timeoutFailureInfo" | "canceledFailureInfo" | "terminatedFailureInfo" | "serverFailureInfo" | "resetWorkflowFailureInfo" | "activityFailureInfo" | "childWorkflowExecutionFailureInfo" | "nexusOperationExecutionFailureInfo"
Failure failureInfo.
message
• message: string
Failure message.
Implementation of
nexusOperationExecutionFailureInfo
• Optional nexusOperationExecutionFailureInfo: null | INexusOperationFailureInfo
Failure nexusOperationExecutionFailureInfo.
Implementation of
IFailure.nexusOperationExecutionFailureInfo
resetWorkflowFailureInfo
• Optional resetWorkflowFailureInfo: null | IResetWorkflowFailureInfo
Failure resetWorkflowFailureInfo.
Implementation of
IFailure.resetWorkflowFailureInfo
serverFailureInfo
• Optional serverFailureInfo: null | IServerFailureInfo
Failure serverFailureInfo.
Implementation of
source
• source: string
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.
Implementation of
stackTrace
• stackTrace: string
Failure stackTrace.
Implementation of
terminatedFailureInfo
• Optional terminatedFailureInfo: null | ITerminatedFailureInfo
Failure terminatedFailureInfo.
Implementation of
IFailure.terminatedFailureInfo
timeoutFailureInfo
• Optional timeoutFailureInfo: null | ITimeoutFailureInfo
Failure timeoutFailureInfo.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Failure to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Failure
Creates a new Failure instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IFailure | Properties to set |
Returns
Failure instance
decode
▸ decode(reader, length?): Failure
Decodes a Failure message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Failure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Failure
Decodes a Failure message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Failure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Failure message. Does not implicitly temporal.api.failure.v1.Failure.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFailure | Failure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Failure message, length delimited. Does not implicitly temporal.api.failure.v1.Failure.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IFailure | Failure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Failure
Creates a Failure message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Failure
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Failure
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Failure message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Failure | Failure |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object