Class: WorkflowExecutionFailedEventAttributes
history.v1.WorkflowExecutionFailedEventAttributes
Represents a WorkflowExecutionFailedEventAttributes.
Properties
failure
• Optional failure: null | $Properties
Serialized result of workflow failure (ex: An exception thrown, or error returned)
newExecutionRunId
• newExecutionRunId: string
If another run is started by cron or retry, this contains the new run id.
retryState
• retryState: RetryState
WorkflowExecutionFailedEventAttributes retryState.
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED event which this command was reported with
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionFailedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionFailedEventAttributes & $Shape
Creates a new WorkflowExecutionFailedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkflowExecutionFailedEventAttributes & $Shape
WorkflowExecutionFailedEventAttributes instance
▸ create(properties?): WorkflowExecutionFailedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
WorkflowExecutionFailedEventAttributes
decode
▸ decode(reader, length?): WorkflowExecutionFailedEventAttributes & $Shape
Decodes a WorkflowExecutionFailedEventAttributes 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
WorkflowExecutionFailedEventAttributes & $Shape
WorkflowExecutionFailedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionFailedEventAttributes & $Shape
Decodes a WorkflowExecutionFailedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionFailedEventAttributes & $Shape
WorkflowExecutionFailedEventAttributes
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 WorkflowExecutionFailedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionFailedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionFailedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionFailedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionFailedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionFailedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionFailedEventAttributes
Creates a WorkflowExecutionFailedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionFailedEventAttributes
WorkflowExecutionFailedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowExecutionFailedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionFailedEventAttributes | WorkflowExecutionFailedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object