Skip to main content

Class: WorkflowExecutionInfo

workflow.v1.WorkflowExecutionInfo

Represents a WorkflowExecutionInfo.

Implements#

Constructors#

constructor#

new WorkflowExecutionInfo(properties?)

Constructs a new WorkflowExecutionInfo.

Parameters#

NameType
properties?IWorkflowExecutionInfo

Properties#

autoResetPoints#

Optional autoResetPoints: null | IResetPoints

WorkflowExecutionInfo autoResetPoints.

Implementation of#

IWorkflowExecutionInfo.autoResetPoints


closeTime#

Optional closeTime: null | ITimestamp

WorkflowExecutionInfo closeTime.

Implementation of#

IWorkflowExecutionInfo.closeTime


execution#

Optional execution: null | IWorkflowExecution

WorkflowExecutionInfo execution.

Implementation of#

IWorkflowExecutionInfo.execution


executionTime#

Optional executionTime: null | ITimestamp

WorkflowExecutionInfo executionTime.

Implementation of#

IWorkflowExecutionInfo.executionTime


historyLength#

historyLength: Long

WorkflowExecutionInfo historyLength.

Implementation of#

IWorkflowExecutionInfo.historyLength


memo#

Optional memo: null | IMemo

WorkflowExecutionInfo memo.

Implementation of#

IWorkflowExecutionInfo.memo


parentExecution#

Optional parentExecution: null | IWorkflowExecution

WorkflowExecutionInfo parentExecution.

Implementation of#

IWorkflowExecutionInfo.parentExecution


parentNamespaceId#

parentNamespaceId: string

WorkflowExecutionInfo parentNamespaceId.

Implementation of#

IWorkflowExecutionInfo.parentNamespaceId


searchAttributes#

Optional searchAttributes: null | ISearchAttributes

WorkflowExecutionInfo searchAttributes.

Implementation of#

IWorkflowExecutionInfo.searchAttributes


startTime#

Optional startTime: null | ITimestamp

WorkflowExecutionInfo startTime.

Implementation of#

IWorkflowExecutionInfo.startTime


stateTransitionCount#

stateTransitionCount: Long

WorkflowExecutionInfo stateTransitionCount.

Implementation of#

IWorkflowExecutionInfo.stateTransitionCount


status#

status: WorkflowExecutionStatus

WorkflowExecutionInfo status.

Implementation of#

IWorkflowExecutionInfo.status


taskQueue#

taskQueue: string

WorkflowExecutionInfo taskQueue.

Implementation of#

IWorkflowExecutionInfo.taskQueue


type#

Optional type: null | IWorkflowType

WorkflowExecutionInfo type.

Implementation of#

IWorkflowExecutionInfo.type

Methods#

toJSON#

toJSON(): Object

Converts this WorkflowExecutionInfo to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): WorkflowExecutionInfo

Decodes a WorkflowExecutionInfo 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#

WorkflowExecutionInfo

WorkflowExecutionInfo


decodeDelimited#

Static decodeDelimited(reader): WorkflowExecutionInfo

Decodes a WorkflowExecutionInfo 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#

WorkflowExecutionInfo

WorkflowExecutionInfo


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): WorkflowExecutionInfo

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

WorkflowExecutionInfo

WorkflowExecutionInfo


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageWorkflowExecutionInfoWorkflowExecutionInfo
options?IConversionOptions-

Returns#

Object

Plain object