Class: WorkflowTaskFailedEventAttributes
history.v1.WorkflowTaskFailedEventAttributes
Represents a WorkflowTaskFailedEventAttributes.
Properties
baseRunId
• baseRunId: string
The original run id of the workflow. For reset workflow.
binaryChecksum
• binaryChecksum: string
Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv] If a worker explicitly failed this task, its binary id
cause
• cause: WorkflowTaskFailedCause
WorkflowTaskFailedEventAttributes cause.
failure
• Optional failure: null | $Properties
The failure details
forkEventVersion
• forkEventVersion: Long
Version of the event where the history branch was forked. Used by multi-cluster replication during resets to identify the correct history branch.
identity
• identity: string
If a worker explicitly failed this task, this field contains the worker's identity. When the server generates the failure internally this field is set as 'history-service'.
newRunId
• newRunId: string
If the workflow is being reset, the new run id.
scheduledEventId
• scheduledEventId: Long
The id of the WORKFLOW_TASK_SCHEDULED event this task corresponds to
startedEventId
• startedEventId: Long
The id of the WORKFLOW_TASK_STARTED event this task corresponds to
workerVersion
• Optional workerVersion: null | $Properties
Version info of the worker who processed this workflow task. If present, the build_id field
within is also used as binary_checksum, which may be omitted in that case (it may also be
populated to preserve compatibility).
Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowTaskFailedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowTaskFailedEventAttributes & $Shape
Creates a new WorkflowTaskFailedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkflowTaskFailedEventAttributes & $Shape
WorkflowTaskFailedEventAttributes instance
▸ create(properties?): WorkflowTaskFailedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
WorkflowTaskFailedEventAttributes
decode
▸ decode(reader, length?): WorkflowTaskFailedEventAttributes & $Shape
Decodes a WorkflowTaskFailedEventAttributes 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
WorkflowTaskFailedEventAttributes & $Shape
WorkflowTaskFailedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowTaskFailedEventAttributes & $Shape
Decodes a WorkflowTaskFailedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowTaskFailedEventAttributes & $Shape
WorkflowTaskFailedEventAttributes
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 WorkflowTaskFailedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowTaskFailedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowTaskFailedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowTaskFailedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowTaskFailedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowTaskFailedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowTaskFailedEventAttributes
Creates a WorkflowTaskFailedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowTaskFailedEventAttributes
WorkflowTaskFailedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowTaskFailedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowTaskFailedEventAttributes | WorkflowTaskFailedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object