Class: RespondActivityTaskCanceledRequest

Represents a RespondActivityTaskCanceledRequest.

Properties

deployment?

optional deployment?: $Properties | null

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?: $Properties | null

Worker deployment options that user has set in the worker.

---

details?

optional details?: $Properties | null

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?: $Properties | null

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()

Call Signature

static create(properties?): RespondActivityTaskCanceledRequest & $Properties

Creates a new RespondActivityTaskCanceledRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

RespondActivityTaskCanceledRequest & $Properties

RespondActivityTaskCanceledRequest instance

Call Signature

static create(properties?): RespondActivityTaskCanceledRequest

Creates a new RespondActivityTaskCanceledRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

RespondActivityTaskCanceledRequest

RespondActivityTaskCanceledRequest instance

---

decode()

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

Decodes a RespondActivityTaskCanceledRequest message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | 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()

static decodeDelimited(reader): RespondActivityTaskCanceledRequest & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | 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()

static encode(message, writer?): Writer

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

Parameters

message

$Properties

RespondActivityTaskCanceledRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

RespondActivityTaskCanceledRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): RespondActivityTaskCanceledRequest

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

Parameters

object

Plain object

Returns

RespondActivityTaskCanceledRequest

RespondActivityTaskCanceledRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

RespondActivityTaskCanceledRequest

RespondActivityTaskCanceledRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object