Skip to main content

Class: WorkflowExecutionTerminatedEventAttributes

Represents a WorkflowExecutionTerminatedEventAttributes.

Properties​

details?​

optional details?: $Properties | null

WorkflowExecutionTerminatedEventAttributes details.

identity​

identity: string

id of the client who requested termination

reason​

reason: string

User/client provided reason for termination

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecutionTerminatedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecutionTerminatedEventAttributes & $Properties

Creates a new WorkflowExecutionTerminatedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionTerminatedEventAttributes & $Properties

WorkflowExecutionTerminatedEventAttributes instance

Call Signature​

static create(properties?): WorkflowExecutionTerminatedEventAttributes

Creates a new WorkflowExecutionTerminatedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionTerminatedEventAttributes

WorkflowExecutionTerminatedEventAttributes instance

decode()​

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

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

WorkflowExecutionTerminatedEventAttributes & $Properties

WorkflowExecutionTerminatedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecutionTerminatedEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecutionTerminatedEventAttributes & $Properties

WorkflowExecutionTerminatedEventAttributes

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

Parameters​

message​

$Properties

WorkflowExecutionTerminatedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecutionTerminatedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecutionTerminatedEventAttributes

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

Parameters​

object​

Plain object

Returns​

WorkflowExecutionTerminatedEventAttributes

WorkflowExecutionTerminatedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecutionTerminatedEventAttributes

WorkflowExecutionTerminatedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object