Class: RespondActivityTaskCanceledRequest

workflowservice.v1.RespondActivityTaskCanceledRequest

Represents a RespondActivityTaskCanceledRequest.

Properties

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.

---

details

• Optional details: null | $Properties

Serialized additional information to attach to the cancellation

---

identity

• identity: string

The identity of the worker/client

---

namespace

• namespace: string

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

Returns

Object

JSON object

---

create

▸ create(properties?): RespondActivityTaskCanceledRequest & $Properties

Creates a new RespondActivityTaskCanceledRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Properties	Properties to set

Returns

RespondActivityTaskCanceledRequest & $Properties

RespondActivityTaskCanceledRequest instance

▸ create(properties?): RespondActivityTaskCanceledRequest

Parameters

Name	Type
properties?	$Properties

Returns

RespondActivityTaskCanceledRequest

---

decode

▸ decode(reader, length?): RespondActivityTaskCanceledRequest & $Properties

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

RespondActivityTaskCanceledRequest & $Properties

RespondActivityTaskCanceledRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): RespondActivityTaskCanceledRequest & $Properties

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

Parameters

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

Returns

RespondActivityTaskCanceledRequest & $Properties

RespondActivityTaskCanceledRequest

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

Parameters

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

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): RespondActivityTaskCanceledRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

RespondActivityTaskCanceledRequest

RespondActivityTaskCanceledRequest

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	RespondActivityTaskCanceledRequest	RespondActivityTaskCanceledRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object