Class: WorkflowExecutionExtendedInfo

workflow.v1.WorkflowExecutionExtendedInfo

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

Implements

• IWorkflowExecutionExtendedInfo

Constructors

constructor

• new WorkflowExecutionExtendedInfo(properties?): WorkflowExecutionExtendedInfo

Constructs a new WorkflowExecutionExtendedInfo.

Parameters

Name	Type	Description
properties?	IWorkflowExecutionExtendedInfo	Properties to set

Returns

WorkflowExecutionExtendedInfo

Properties

cancelRequested

• cancelRequested: boolean

indicates if the workflow received a cancel request

Implementation of

IWorkflowExecutionExtendedInfo.cancelRequested

---

executionExpirationTime

• Optional executionExpirationTime: null | ITimestamp

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

Implementation of

IWorkflowExecutionExtendedInfo.executionExpirationTime

---

lastResetTime

• Optional lastResetTime: null | ITimestamp

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

Implementation of

IWorkflowExecutionExtendedInfo.lastResetTime

---

originalStartTime

• Optional originalStartTime: null | ITimestamp

Original workflow start time.

Implementation of

IWorkflowExecutionExtendedInfo.originalStartTime

---

runExpirationTime

• Optional runExpirationTime: null | ITimestamp

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

Implementation of

IWorkflowExecutionExtendedInfo.runExpirationTime

Methods

toJSON

▸ toJSON(): Object

Converts this WorkflowExecutionExtendedInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkflowExecutionExtendedInfo

Creates a new WorkflowExecutionExtendedInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkflowExecutionExtendedInfo	Properties to set

Returns

WorkflowExecutionExtendedInfo

WorkflowExecutionExtendedInfo instance

---

decode

▸ decode(reader, length?): WorkflowExecutionExtendedInfo

Decodes a WorkflowExecutionExtendedInfo message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

WorkflowExecutionExtendedInfo

WorkflowExecutionExtendedInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkflowExecutionExtendedInfo

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

WorkflowExecutionExtendedInfo

WorkflowExecutionExtendedInfo

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

Parameters

Name	Type	Description
message	IWorkflowExecutionExtendedInfo	WorkflowExecutionExtendedInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkflowExecutionExtendedInfo	WorkflowExecutionExtendedInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkflowExecutionExtendedInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkflowExecutionExtendedInfo

WorkflowExecutionExtendedInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecutionExtendedInfo

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	WorkflowExecutionExtendedInfo	WorkflowExecutionExtendedInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object