Skip to main content

Class: TerminateWorkflowExecutionRequest

Represents a TerminateWorkflowExecutionRequest.

Properties​

details?​

optional details?: $Properties | null

Serialized additional information to attach to the termination event

firstExecutionRunId​

firstExecutionRunId: string

If set, this call will error if the most recent (if no run id is set on workflow_execution), or specified (if it is) workflow execution is not part of the same execution chain as this id.

identity​

identity: string

The identity of the worker/client

links: $Properties[]

Links to be associated with the WorkflowExecutionTerminated event.

namespace​

namespace: string

TerminateWorkflowExecutionRequest namespace.

reason​

reason: string

TerminateWorkflowExecutionRequest reason.

workflowExecution?​

optional workflowExecution?: $Properties | null

TerminateWorkflowExecutionRequest workflowExecution.

Methods​

toJSON()​

toJSON(): object

Converts this TerminateWorkflowExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TerminateWorkflowExecutionRequest & $Shape

Creates a new TerminateWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

TerminateWorkflowExecutionRequest & $Shape

TerminateWorkflowExecutionRequest instance

Call Signature​

static create(properties?): TerminateWorkflowExecutionRequest

Creates a new TerminateWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest instance

decode()​

static decode(reader, length?): TerminateWorkflowExecutionRequest & $Shape

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

TerminateWorkflowExecutionRequest & $Shape

TerminateWorkflowExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TerminateWorkflowExecutionRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TerminateWorkflowExecutionRequest & $Shape

TerminateWorkflowExecutionRequest

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

Parameters​

message​

$Properties

TerminateWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TerminateWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TerminateWorkflowExecutionRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object