Skip to main content

Class: WorkflowExecutionTerminatedEventAttributes

history.v1.WorkflowExecutionTerminatedEventAttributes

Represents a WorkflowExecutionTerminatedEventAttributes.

Properties​

details​

• Optional details: null | $Properties

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​

▸ create(properties?): WorkflowExecutionTerminatedEventAttributes & $Properties

Creates a new WorkflowExecutionTerminatedEventAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

WorkflowExecutionTerminatedEventAttributes & $Properties

WorkflowExecutionTerminatedEventAttributes instance

▸ create(properties?): WorkflowExecutionTerminatedEventAttributes

Parameters​

NameType
properties?$Properties

Returns​

WorkflowExecutionTerminatedEventAttributes


decode​

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

Decodes a WorkflowExecutionTerminatedEventAttributes message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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​

▸ decodeDelimited(reader): WorkflowExecutionTerminatedEventAttributes & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader 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​

▸ encode(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesWorkflowExecutionTerminatedEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesWorkflowExecutionTerminatedEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): WorkflowExecutionTerminatedEventAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

WorkflowExecutionTerminatedEventAttributes

WorkflowExecutionTerminatedEventAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageWorkflowExecutionTerminatedEventAttributesWorkflowExecutionTerminatedEventAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object