Skip to main content

Class: RespondActivityTaskFailedByIdRequest

workflowservice.v1.RespondActivityTaskFailedByIdRequest

Represents a RespondActivityTaskFailedByIdRequest.

Properties

activityId

activityId: string

Id of the activity to fail


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

Namespace of the workflow which scheduled this activity


resourceId

resourceId: string

Resource ID for routing. Contains "workflow:workflow_id" or "activity:activity_id" for standalone activities.


runId

runId: string

For a workflow activity - the run ID of the workflow which scheduled this activity. For a standalone activity - the run ID of the activity.


workflowId

workflowId: string

Id of the workflow which scheduled this activity, leave empty to target a standalone activity

Methods

toJSON

toJSON(): Object

Converts this RespondActivityTaskFailedByIdRequest to JSON.

Returns

Object

JSON object


create

create(properties?): RespondActivityTaskFailedByIdRequest & $Shape

Creates a new RespondActivityTaskFailedByIdRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?$ShapeProperties to set

Returns

RespondActivityTaskFailedByIdRequest & $Shape

RespondActivityTaskFailedByIdRequest instance

create(properties?): RespondActivityTaskFailedByIdRequest

Parameters

NameType
properties?$Properties

Returns

RespondActivityTaskFailedByIdRequest


decode

decode(reader, length?): RespondActivityTaskFailedByIdRequest & $Shape

Decodes a RespondActivityTaskFailedByIdRequest message from the specified reader or buffer.

Parameters

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

Returns

RespondActivityTaskFailedByIdRequest & $Shape

RespondActivityTaskFailedByIdRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): RespondActivityTaskFailedByIdRequest & $Shape

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

RespondActivityTaskFailedByIdRequest & $Shape

RespondActivityTaskFailedByIdRequest

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): RespondActivityTaskFailedByIdRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

RespondActivityTaskFailedByIdRequest

RespondActivityTaskFailedByIdRequest


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRespondActivityTaskFailedByIdRequestRespondActivityTaskFailedByIdRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object