Skip to main content

Class: WorkflowExecutionExtendedInfo

Holds all the extra information about workflow execution that is not part of Visibility.

Properties​

cancelRequested​

cancelRequested: boolean

indicates if the workflow received a cancel request

executionExpirationTime?​

optional executionExpirationTime?: $Properties | null

Workflow execution expiration time is defined as workflow start time plus expiration timeout. Workflow start time may change after workflow reset.

lastResetTime?​

optional lastResetTime?: $Properties | null

Last workflow reset time. Nil if the workflow was never reset.

originalStartTime?​

optional originalStartTime?: $Properties | null

Original workflow start time.

pauseInfo?​

optional pauseInfo?: $Properties | null

Information about the workflow execution pause operation.

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

Serialization context propagated from the Nexus caller that started this workflow.

requestIdInfos​

requestIdInfos: object

Request ID information (eg: history event information associated with the request ID). Note: It only contains request IDs from StartWorkflowExecution requests, including indirect calls (eg: if SignalWithStartWorkflowExecution starts a new workflow, then the request ID is used in the StartWorkflowExecution request).

Index Signature​

[k: string]: $Properties

resetRunId​

resetRunId: string

Reset Run ID points to the new run when this execution is reset. If the execution is reset multiple times, it points to the latest run.

runExpirationTime?​

optional runExpirationTime?: $Properties | null

Workflow run expiration time is defined as current workflow run start time plus workflow run timeout.

timeSkippingInfo?​

optional timeSkippingInfo?: $Properties | null

Information about time skipping of the workflow execution. If the execution has never enabled time skipping, it will be nil.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecutionExtendedInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecutionExtendedInfo & $Properties

Creates a new WorkflowExecutionExtendedInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionExtendedInfo & $Properties

WorkflowExecutionExtendedInfo instance

Call Signature​

static create(properties?): WorkflowExecutionExtendedInfo

Creates a new WorkflowExecutionExtendedInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionExtendedInfo

WorkflowExecutionExtendedInfo instance

decode()​

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

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

WorkflowExecutionExtendedInfo & $Properties

WorkflowExecutionExtendedInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecutionExtendedInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecutionExtendedInfo & $Properties

WorkflowExecutionExtendedInfo

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

Parameters​

message​

$Properties

WorkflowExecutionExtendedInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecutionExtendedInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecutionExtendedInfo

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

Parameters​

object​

Plain object

Returns​

WorkflowExecutionExtendedInfo

WorkflowExecutionExtendedInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecutionExtendedInfo

WorkflowExecutionExtendedInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object