Skip to main content

Class: WorkflowExecutionInfo

workflow.v1.WorkflowExecutionInfo

Represents a WorkflowExecutionInfo.

Implements

Constructors

constructor

new WorkflowExecutionInfo(properties?)

Constructs a new WorkflowExecutionInfo.

Parameters

NameTypeDescription
properties?IWorkflowExecutionInfoProperties to set

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


create

Static create(properties?): WorkflowExecutionInfo

Creates a new WorkflowExecutionInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowExecutionInfoProperties to set

Returns

WorkflowExecutionInfo

WorkflowExecutionInfo instance


decode

Static decode(reader, length?): WorkflowExecutionInfo

Decodes a WorkflowExecutionInfo message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

WorkflowExecutionInfo

WorkflowExecutionInfo


decodeDelimited

Static decodeDelimited(reader): WorkflowExecutionInfo

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

Throws

If the payload is not a reader or valid buffer

Throws

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 temporal.api.workflow.v1.WorkflowExecutionInfo.verify|verify messages.

Parameters

NameTypeDescription
messageIWorkflowExecutionInfoWorkflowExecutionInfo message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIWorkflowExecutionInfoWorkflowExecutionInfo message or plain object to encode
writer?WriterWriter to encode to

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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecutionInfo

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object