Class: SystemWorkflowFailure
errordetails.v1.SystemWorkflowFailure
Represents a SystemWorkflowFailure.
Implements
Constructors
constructor
• new SystemWorkflowFailure(properties?): SystemWorkflowFailure
Constructs a new SystemWorkflowFailure.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISystemWorkflowFailure | Properties to set |
Returns
Properties
workflowError
• workflowError: string
Serialized error returned by the system workflow performing the underlying operation.
Implementation of
ISystemWorkflowFailure.workflowError
workflowExecution
• Optional workflowExecution: null | IWorkflowExecution
WorkflowId and RunId of the Temporal system workflow performing the underlying operation. Looking up the info of the system workflow run may help identify the issue causing the failure.
Implementation of
ISystemWorkflowFailure.workflowExecution
Methods
toJSON
▸ toJSON(): Object
Converts this SystemWorkflowFailure to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SystemWorkflowFailure
Creates a new SystemWorkflowFailure instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISystemWorkflowFailure | Properties to set |
Returns
SystemWorkflowFailure instance
decode
▸ decode(reader, length?): SystemWorkflowFailure
Decodes a SystemWorkflowFailure 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
SystemWorkflowFailure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SystemWorkflowFailure
Decodes a SystemWorkflowFailure message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SystemWorkflowFailure
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 SystemWorkflowFailure message. Does not implicitly temporal.api.errordetails.v1.SystemWorkflowFailure.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISystemWorkflowFailure | SystemWorkflowFailure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SystemWorkflowFailure message, length delimited. Does not implicitly temporal.api.errordetails.v1.SystemWorkflowFailure.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISystemWorkflowFailure | SystemWorkflowFailure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SystemWorkflowFailure
Creates a SystemWorkflowFailure message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SystemWorkflowFailure
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SystemWorkflowFailure
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 SystemWorkflowFailure message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SystemWorkflowFailure | SystemWorkflowFailure |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object