Class: TerminateWorkflowExecutionRequest

workflowservice.v1.TerminateWorkflowExecutionRequest

Represents a TerminateWorkflowExecutionRequest.

Implements

• ITerminateWorkflowExecutionRequest

Constructors

constructor

• new TerminateWorkflowExecutionRequest(properties?): TerminateWorkflowExecutionRequest

Constructs a new TerminateWorkflowExecutionRequest.

Parameters

Name	Type	Description
properties?	ITerminateWorkflowExecutionRequest	Properties to set

Returns

TerminateWorkflowExecutionRequest

Properties

details

• Optional details: null | IPayloads

Serialized additional information to attach to the termination event

Implementation of

ITerminateWorkflowExecutionRequest.details

---

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.

Implementation of

ITerminateWorkflowExecutionRequest.firstExecutionRunId

---

identity

• identity: string

The identity of the worker/client

Implementation of

ITerminateWorkflowExecutionRequest.identity

---

namespace

• namespace: string

TerminateWorkflowExecutionRequest namespace.

Implementation of

ITerminateWorkflowExecutionRequest.namespace

---

reason

• reason: string

TerminateWorkflowExecutionRequest reason.

Implementation of

ITerminateWorkflowExecutionRequest.reason

---

workflowExecution

• Optional workflowExecution: null | IWorkflowExecution

TerminateWorkflowExecutionRequest workflowExecution.

Implementation of

ITerminateWorkflowExecutionRequest.workflowExecution

Methods

toJSON

▸ toJSON(): Object

Converts this TerminateWorkflowExecutionRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): TerminateWorkflowExecutionRequest

Creates a new TerminateWorkflowExecutionRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	ITerminateWorkflowExecutionRequest	Properties to set

Returns

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest instance

---

decode

▸ decode(reader, length?): TerminateWorkflowExecutionRequest

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

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): TerminateWorkflowExecutionRequest

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

Parameters

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

Returns

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest

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

Parameters

Name	Type	Description
message	ITerminateWorkflowExecutionRequest	TerminateWorkflowExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ITerminateWorkflowExecutionRequest	TerminateWorkflowExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): TerminateWorkflowExecutionRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TerminateWorkflowExecutionRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	TerminateWorkflowExecutionRequest	TerminateWorkflowExecutionRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object