Skip to main content

Class: TerminateActivityExecutionRequest

Represents a TerminateActivityExecutionRequest.

Properties​

activityId​

activityId: string

TerminateActivityExecutionRequest activityId.

identity​

identity: string

The identity of the worker/client.

namespace​

namespace: string

TerminateActivityExecutionRequest namespace.

reason​

reason: string

Reason for requesting the termination, recorded in in the activity's result failure outcome.

requestId​

requestId: string

Used to de-dupe termination requests.

runId​

runId: string

Activity run ID. If empty, targets the latest run.

Methods​

toJSON()​

toJSON(): object

Converts this TerminateActivityExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TerminateActivityExecutionRequest & $Properties

Creates a new TerminateActivityExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TerminateActivityExecutionRequest & $Properties

TerminateActivityExecutionRequest instance

Call Signature​

static create(properties?): TerminateActivityExecutionRequest

Creates a new TerminateActivityExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TerminateActivityExecutionRequest

TerminateActivityExecutionRequest instance

decode()​

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

Decodes a TerminateActivityExecutionRequest 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​

TerminateActivityExecutionRequest & $Properties

TerminateActivityExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TerminateActivityExecutionRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TerminateActivityExecutionRequest & $Properties

TerminateActivityExecutionRequest

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

Parameters​

message​

$Properties

TerminateActivityExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TerminateActivityExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TerminateActivityExecutionRequest

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

Parameters​

object​

Plain object

Returns​

TerminateActivityExecutionRequest

TerminateActivityExecutionRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TerminateActivityExecutionRequest

TerminateActivityExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object