Skip to main content

Class: RespondActivityTaskFailedRequest

workflowservice.v1.RespondActivityTaskFailedRequest

Represents a RespondActivityTaskFailedRequest.

Properties​

cause​

• cause: ActivityTaskFailedCause

Why did the task fail? When unset, the failure is treated as an unspecified activity failure.


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

Detailed failure information


identity​

• identity: string

The identity of the worker/client


lastHeartbeatDetails​

• Optional lastHeartbeatDetails: null | $Properties

Additional details to be stored as last activity heartbeat


namespace​

• namespace: string

RespondActivityTaskFailedRequest namespace.


resourceId​

• resourceId: string

Resource ID for routing. Contains the workflow ID or activity ID for standalone activities.


taskToken​

• taskToken: Uint8Array

The task token as received in PollActivityTaskQueueResponse


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 RespondActivityTaskFailedRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): RespondActivityTaskFailedRequest & $Shape

Creates a new RespondActivityTaskFailedRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

RespondActivityTaskFailedRequest & $Shape

RespondActivityTaskFailedRequest instance

▸ create(properties?): RespondActivityTaskFailedRequest

Parameters​

NameType
properties?$Properties

Returns​

RespondActivityTaskFailedRequest


decode​

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

Decodes a RespondActivityTaskFailedRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

RespondActivityTaskFailedRequest & $Shape

RespondActivityTaskFailedRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): RespondActivityTaskFailedRequest & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

RespondActivityTaskFailedRequest & $Shape

RespondActivityTaskFailedRequest

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

Parameters​

NameTypeDescription
message$PropertiesRespondActivityTaskFailedRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesRespondActivityTaskFailedRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): RespondActivityTaskFailedRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

RespondActivityTaskFailedRequest

RespondActivityTaskFailedRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageRespondActivityTaskFailedRequestRespondActivityTaskFailedRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object