Skip to main content

Class: TerminateWorkflowExecutionRequest

workflowservice.v1.TerminateWorkflowExecutionRequest

Represents a TerminateWorkflowExecutionRequest.

Implements#

Constructors#

constructor#

new TerminateWorkflowExecutionRequest(properties?)

Constructs a new TerminateWorkflowExecutionRequest.

Parameters#

NameType
properties?ITerminateWorkflowExecutionRequest

Properties#

details#

Optional details: null | IPayloads

TerminateWorkflowExecutionRequest details.

Implementation of#

ITerminateWorkflowExecutionRequest.details


firstExecutionRunId#

firstExecutionRunId: string

TerminateWorkflowExecutionRequest firstExecutionRunId.

Implementation of#

ITerminateWorkflowExecutionRequest.firstExecutionRunId


identity#

identity: string

TerminateWorkflowExecutionRequest identity.

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


decode#

Static decode(reader, length?): TerminateWorkflowExecutionRequest

Decodes a TerminateWorkflowExecutionRequest message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest


decodeDelimited#

Static decodeDelimited(reader): TerminateWorkflowExecutionRequest

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

TerminateWorkflowExecutionRequest

TerminateWorkflowExecutionRequest


encode#

Static encode(message, writer?): Writer

Encodes the specified TerminateWorkflowExecutionRequest message. Does not implicitly {@link temporal.api.workflowservice.v1.TerminateWorkflowExecutionRequest.verify|verify} messages.

Parameters#

NameTypeDescription
messageITerminateWorkflowExecutionRequestTerminateWorkflowExecutionRequest message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageITerminateWorkflowExecutionRequestTerminateWorkflowExecutionRequest message or plain object to encode
writer?Writer-

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageTerminateWorkflowExecutionRequestTerminateWorkflowExecutionRequest
options?IConversionOptions-

Returns#

Object

Plain object