Class: RespondWorkflowTaskFailedRequest
workflowservice.v1.RespondWorkflowTaskFailedRequest
Represents a RespondWorkflowTaskFailedRequest.
Implements
Constructors
constructor
• new RespondWorkflowTaskFailedRequest(properties?): RespondWorkflowTaskFailedRequest
Constructs a new RespondWorkflowTaskFailedRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRespondWorkflowTaskFailedRequest | Properties to set |
Returns
RespondWorkflowTaskFailedRequest
Properties
binaryChecksum
• binaryChecksum: string
DEPRECATED since 1.21 - use worker_version_stamp instead.
Worker process' unique binary id
Implementation of
IRespondWorkflowTaskFailedRequest.binaryChecksum
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.
Implementation of
IRespondWorkflowTaskFailedRequest.cause
failure
• Optional failure: null | IFailure
Failure details
Implementation of
IRespondWorkflowTaskFailedRequest.failure
identity
• identity: string
The identity of the worker/client
Implementation of
IRespondWorkflowTaskFailedRequest.identity
messages
• messages: IMessage[]
Protocol messages piggybacking on a WFT as a transport
Implementation of
IRespondWorkflowTaskFailedRequest.messages
namespace
• namespace: string
RespondWorkflowTaskFailedRequest namespace.
Implementation of
IRespondWorkflowTaskFailedRequest.namespace
taskToken
• taskToken: Uint8Array
The task token as received in PollWorkflowTaskQueueResponse
Implementation of
IRespondWorkflowTaskFailedRequest.taskToken
workerVersion
• Optional workerVersion: null | IWorkerVersionStamp
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.
Implementation of
IRespondWorkflowTaskFailedRequest.workerVersion
Methods
toJSON
▸ toJSON(): Object
Converts this RespondWorkflowTaskFailedRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RespondWorkflowTaskFailedRequest
Creates a new RespondWorkflowTaskFailedRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRespondWorkflowTaskFailedRequest | Properties to set |
Returns
RespondWorkflowTaskFailedRequest
RespondWorkflowTaskFailedRequest instance
decode
▸ decode(reader, length?): RespondWorkflowTaskFailedRequest
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
RespondWorkflowTaskFailedRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RespondWorkflowTaskFailedRequest
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
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 | IRespondWorkflowTaskFailedRequest | 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 | IRespondWorkflowTaskFailedRequest | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RespondWorkflowTaskFailedRequest
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 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