Class: WorkflowTaskFailedEventAttributes
history.v1.WorkflowTaskFailedEventAttributes
Represents a WorkflowTaskFailedEventAttributes.
Implements
Constructors
constructor
• new WorkflowTaskFailedEventAttributes(properties?): WorkflowTaskFailedEventAttributes
Constructs a new WorkflowTaskFailedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowTaskFailedEventAttributes | Properties to set |
Returns
WorkflowTaskFailedEventAttributes
Properties
baseRunId
• baseRunId: string
The original run id of the workflow. For reset workflow.
Implementation of
IWorkflowTaskFailedEventAttributes.baseRunId
binaryChecksum
• binaryChecksum: string
DEPRECATED since 1.21 - use worker_version instead.
If a worker explicitly failed this task, its binary id
Implementation of
IWorkflowTaskFailedEventAttributes.binaryChecksum
cause
• cause: WorkflowTaskFailedCause
WorkflowTaskFailedEventAttributes cause.
Implementation of
IWorkflowTaskFailedEventAttributes.cause
failure
• Optional failure: null | IFailure
The failure details
Implementation of
IWorkflowTaskFailedEventAttributes.failure
forkEventVersion
• forkEventVersion: Long
TODO: ?
Implementation of
IWorkflowTaskFailedEventAttributes.forkEventVersion
identity
• identity: string
If a worker explicitly failed this task, it's identity. TODO: What is this set to if server fails the task?
Implementation of
IWorkflowTaskFailedEventAttributes.identity
newRunId
• newRunId: string
If the workflow is being reset, the new run id.
Implementation of
IWorkflowTaskFailedEventAttributes.newRunId
scheduledEventId
• scheduledEventId: Long
The id of the WORKFLOW_TASK_SCHEDULED event this task corresponds to
Implementation of
IWorkflowTaskFailedEventAttributes.scheduledEventId
startedEventId
• startedEventId: Long
The id of the WORKFLOW_TASK_STARTED event this task corresponds to
Implementation of
IWorkflowTaskFailedEventAttributes.startedEventId
workerVersion
• Optional workerVersion: null | IWorkerVersionStamp
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. Use the info inside the corresponding WorkflowTaskStartedEvent
Implementation of
IWorkflowTaskFailedEventAttributes.workerVersion
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowTaskFailedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowTaskFailedEventAttributes
Creates a new WorkflowTaskFailedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowTaskFailedEventAttributes | Properties to set |
Returns
WorkflowTaskFailedEventAttributes
WorkflowTaskFailedEventAttributes instance
decode
▸ decode(reader, length?): WorkflowTaskFailedEventAttributes
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
WorkflowTaskFailedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowTaskFailedEventAttributes
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
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 | IWorkflowTaskFailedEventAttributes | 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 | IWorkflowTaskFailedEventAttributes | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowTaskFailedEventAttributes
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 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