Class: RespondWorkflowTaskFailedRequest

workflowservice.v1.RespondWorkflowTaskFailedRequest

Represents a RespondWorkflowTaskFailedRequest.

Properties

binaryChecksum

• binaryChecksum: string

Deprecated. Use deployment_options instead. Worker process' unique binary id

---

cause

• cause: WorkflowTaskFailedCause

Why did the task fail? It's important to note that many of the variants in this enum cannot apply to worker responses. See the type's doc for more.

---

deployment

• Optional deployment: null | $Properties

Deployment info of the worker that completed this task. Must be present if user has set WorkerDeploymentOptions regardless of versioning being enabled or not. Deprecated. Replaced with deployment_options.

---

deploymentOptions

• Optional deploymentOptions: null | $Properties

Worker deployment options that user has set in the worker.

---

failure

• Optional failure: null | $Properties

Failure details

---

identity

• identity: string

The identity of the worker/client

---

messages

• messages: $Properties[]

Protocol messages piggybacking on a WFT as a transport

---

namespace

• namespace: string

RespondWorkflowTaskFailedRequest namespace.

---

resourceId

• resourceId: string

Resource ID for routing. Contains the workflow ID from the original task.

---

taskToken

• taskToken: Uint8Array

The task token as received in PollWorkflowTaskQueueResponse

---

workerVersion

• Optional workerVersion: null | $Properties

Version info of the worker who processed this task. This message's build_id field should always be set by SDKs. Workers opting into versioning will also set the use_versioning field to true. See message docstrings for more. Deprecated. Use deployment_options instead.

Methods

toJSON

▸ toJSON(): Object

Converts this RespondWorkflowTaskFailedRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): RespondWorkflowTaskFailedRequest & $Shape

Creates a new RespondWorkflowTaskFailedRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Shape	Properties to set

Returns

RespondWorkflowTaskFailedRequest & $Shape

RespondWorkflowTaskFailedRequest instance

▸ create(properties?): RespondWorkflowTaskFailedRequest

Parameters

Name	Type
properties?	$Properties

Returns

RespondWorkflowTaskFailedRequest

---

decode

▸ decode(reader, length?): RespondWorkflowTaskFailedRequest & $Shape

Decodes a RespondWorkflowTaskFailedRequest 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

RespondWorkflowTaskFailedRequest & $Shape

RespondWorkflowTaskFailedRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): RespondWorkflowTaskFailedRequest & $Shape

Decodes a RespondWorkflowTaskFailedRequest message from the specified reader or buffer, length delimited.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

RespondWorkflowTaskFailedRequest & $Shape

RespondWorkflowTaskFailedRequest

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 RespondWorkflowTaskFailedRequest message. Does not implicitly temporal.api.workflowservice.v1.RespondWorkflowTaskFailedRequest.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	RespondWorkflowTaskFailedRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified RespondWorkflowTaskFailedRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RespondWorkflowTaskFailedRequest.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	RespondWorkflowTaskFailedRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): RespondWorkflowTaskFailedRequest

Creates a RespondWorkflowTaskFailedRequest message from a plain object. Also converts values to their respective internal types.

Parameters

Name	Type	Description
object	Object	Plain object

Returns

RespondWorkflowTaskFailedRequest

RespondWorkflowTaskFailedRequest

---

toObject

▸ toObject(message, options?): Object

Creates a plain object from a RespondWorkflowTaskFailedRequest message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	RespondWorkflowTaskFailedRequest	RespondWorkflowTaskFailedRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object