Class: RespondActivityTaskCanceledByIdRequest

Represents a RespondActivityTaskCanceledByIdRequest.

Properties

activityId

activityId: string

Id of the activity to confirm is cancelled

---

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

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

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): RespondActivityTaskCanceledByIdRequest & $Properties

Creates a new RespondActivityTaskCanceledByIdRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

RespondActivityTaskCanceledByIdRequest & $Properties

RespondActivityTaskCanceledByIdRequest instance

Call Signature

static create(properties?): RespondActivityTaskCanceledByIdRequest

Creates a new RespondActivityTaskCanceledByIdRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

RespondActivityTaskCanceledByIdRequest

RespondActivityTaskCanceledByIdRequest instance

---

decode()

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

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

RespondActivityTaskCanceledByIdRequest & $Properties

RespondActivityTaskCanceledByIdRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): RespondActivityTaskCanceledByIdRequest & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

RespondActivityTaskCanceledByIdRequest & $Properties

RespondActivityTaskCanceledByIdRequest

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

Parameters

message

$Properties

RespondActivityTaskCanceledByIdRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

RespondActivityTaskCanceledByIdRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): RespondActivityTaskCanceledByIdRequest

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

Parameters

object

Plain object

Returns

RespondActivityTaskCanceledByIdRequest

RespondActivityTaskCanceledByIdRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

RespondActivityTaskCanceledByIdRequest

RespondActivityTaskCanceledByIdRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object