Skip to main content

Class: HistoryEvent

history.v1.HistoryEvent

History events are the method by which Temporal SDKs advance (or recreate) workflow state. See the EventType enum for more info about what each event is for.

Implements

Constructors

constructor

new HistoryEvent(properties?): HistoryEvent

Constructs a new HistoryEvent.

Parameters

NameTypeDescription
properties?IHistoryEventProperties to set

Returns

HistoryEvent

Properties

activityPropertiesModifiedExternallyEventAttributes

Optional activityPropertiesModifiedExternallyEventAttributes: null | IActivityPropertiesModifiedExternallyEventAttributes

HistoryEvent activityPropertiesModifiedExternallyEventAttributes.

Implementation of

IHistoryEvent.activityPropertiesModifiedExternallyEventAttributes


activityTaskCancelRequestedEventAttributes

Optional activityTaskCancelRequestedEventAttributes: null | IActivityTaskCancelRequestedEventAttributes

HistoryEvent activityTaskCancelRequestedEventAttributes.

Implementation of

IHistoryEvent.activityTaskCancelRequestedEventAttributes


activityTaskCanceledEventAttributes

Optional activityTaskCanceledEventAttributes: null | IActivityTaskCanceledEventAttributes

HistoryEvent activityTaskCanceledEventAttributes.

Implementation of

IHistoryEvent.activityTaskCanceledEventAttributes


activityTaskCompletedEventAttributes

Optional activityTaskCompletedEventAttributes: null | IActivityTaskCompletedEventAttributes

HistoryEvent activityTaskCompletedEventAttributes.

Implementation of

IHistoryEvent.activityTaskCompletedEventAttributes


activityTaskFailedEventAttributes

Optional activityTaskFailedEventAttributes: null | IActivityTaskFailedEventAttributes

HistoryEvent activityTaskFailedEventAttributes.

Implementation of

IHistoryEvent.activityTaskFailedEventAttributes


activityTaskScheduledEventAttributes

Optional activityTaskScheduledEventAttributes: null | IActivityTaskScheduledEventAttributes

HistoryEvent activityTaskScheduledEventAttributes.

Implementation of

IHistoryEvent.activityTaskScheduledEventAttributes


activityTaskStartedEventAttributes

Optional activityTaskStartedEventAttributes: null | IActivityTaskStartedEventAttributes

HistoryEvent activityTaskStartedEventAttributes.

Implementation of

IHistoryEvent.activityTaskStartedEventAttributes


activityTaskTimedOutEventAttributes

Optional activityTaskTimedOutEventAttributes: null | IActivityTaskTimedOutEventAttributes

HistoryEvent activityTaskTimedOutEventAttributes.

Implementation of

IHistoryEvent.activityTaskTimedOutEventAttributes


attributes

Optional attributes: "workflowExecutionStartedEventAttributes" | "workflowExecutionCompletedEventAttributes" | "workflowExecutionFailedEventAttributes" | "workflowExecutionTimedOutEventAttributes" | "workflowTaskScheduledEventAttributes" | "workflowTaskStartedEventAttributes" | "workflowTaskCompletedEventAttributes" | "workflowTaskTimedOutEventAttributes" | "workflowTaskFailedEventAttributes" | "activityTaskScheduledEventAttributes" | "activityTaskStartedEventAttributes" | "activityTaskCompletedEventAttributes" | "activityTaskFailedEventAttributes" | "activityTaskTimedOutEventAttributes" | "timerStartedEventAttributes" | "timerFiredEventAttributes" | "activityTaskCancelRequestedEventAttributes" | "activityTaskCanceledEventAttributes" | "timerCanceledEventAttributes" | "markerRecordedEventAttributes" | "workflowExecutionSignaledEventAttributes" | "workflowExecutionTerminatedEventAttributes" | "workflowExecutionCancelRequestedEventAttributes" | "workflowExecutionCanceledEventAttributes" | "requestCancelExternalWorkflowExecutionInitiatedEventAttributes" | "requestCancelExternalWorkflowExecutionFailedEventAttributes" | "externalWorkflowExecutionCancelRequestedEventAttributes" | "workflowExecutionContinuedAsNewEventAttributes" | "startChildWorkflowExecutionInitiatedEventAttributes" | "startChildWorkflowExecutionFailedEventAttributes" | "childWorkflowExecutionStartedEventAttributes" | "childWorkflowExecutionCompletedEventAttributes" | "childWorkflowExecutionFailedEventAttributes" | "childWorkflowExecutionCanceledEventAttributes" | "childWorkflowExecutionTimedOutEventAttributes" | "childWorkflowExecutionTerminatedEventAttributes" | "signalExternalWorkflowExecutionInitiatedEventAttributes" | "signalExternalWorkflowExecutionFailedEventAttributes" | "externalWorkflowExecutionSignaledEventAttributes" | "upsertWorkflowSearchAttributesEventAttributes" | "workflowExecutionUpdateAcceptedEventAttributes" | "workflowExecutionUpdateRejectedEventAttributes" | "workflowExecutionUpdateCompletedEventAttributes" | "workflowPropertiesModifiedExternallyEventAttributes" | "activityPropertiesModifiedExternallyEventAttributes" | "workflowPropertiesModifiedEventAttributes" | "workflowExecutionUpdateAdmittedEventAttributes" | "nexusOperationScheduledEventAttributes" | "nexusOperationStartedEventAttributes" | "nexusOperationCompletedEventAttributes" | "nexusOperationFailedEventAttributes" | "nexusOperationCanceledEventAttributes" | "nexusOperationTimedOutEventAttributes" | "nexusOperationCancelRequestedEventAttributes"

The event details. The type must match that in event_type.


childWorkflowExecutionCanceledEventAttributes

Optional childWorkflowExecutionCanceledEventAttributes: null | IChildWorkflowExecutionCanceledEventAttributes

HistoryEvent childWorkflowExecutionCanceledEventAttributes.

Implementation of

IHistoryEvent.childWorkflowExecutionCanceledEventAttributes


childWorkflowExecutionCompletedEventAttributes

Optional childWorkflowExecutionCompletedEventAttributes: null | IChildWorkflowExecutionCompletedEventAttributes

HistoryEvent childWorkflowExecutionCompletedEventAttributes.

Implementation of

IHistoryEvent.childWorkflowExecutionCompletedEventAttributes


childWorkflowExecutionFailedEventAttributes

Optional childWorkflowExecutionFailedEventAttributes: null | IChildWorkflowExecutionFailedEventAttributes

HistoryEvent childWorkflowExecutionFailedEventAttributes.

Implementation of

IHistoryEvent.childWorkflowExecutionFailedEventAttributes


childWorkflowExecutionStartedEventAttributes

Optional childWorkflowExecutionStartedEventAttributes: null | IChildWorkflowExecutionStartedEventAttributes

HistoryEvent childWorkflowExecutionStartedEventAttributes.

Implementation of

IHistoryEvent.childWorkflowExecutionStartedEventAttributes


childWorkflowExecutionTerminatedEventAttributes

Optional childWorkflowExecutionTerminatedEventAttributes: null | IChildWorkflowExecutionTerminatedEventAttributes

HistoryEvent childWorkflowExecutionTerminatedEventAttributes.

Implementation of

IHistoryEvent.childWorkflowExecutionTerminatedEventAttributes


childWorkflowExecutionTimedOutEventAttributes

Optional childWorkflowExecutionTimedOutEventAttributes: null | IChildWorkflowExecutionTimedOutEventAttributes

HistoryEvent childWorkflowExecutionTimedOutEventAttributes.

Implementation of

IHistoryEvent.childWorkflowExecutionTimedOutEventAttributes


eventId

eventId: Long

Monotonically increasing event number, starts at 1.

Implementation of

IHistoryEvent.eventId


eventTime

Optional eventTime: null | ITimestamp

HistoryEvent eventTime.

Implementation of

IHistoryEvent.eventTime


eventType

eventType: EventType

HistoryEvent eventType.

Implementation of

IHistoryEvent.eventType


externalWorkflowExecutionCancelRequestedEventAttributes

Optional externalWorkflowExecutionCancelRequestedEventAttributes: null | IExternalWorkflowExecutionCancelRequestedEventAttributes

HistoryEvent externalWorkflowExecutionCancelRequestedEventAttributes.

Implementation of

IHistoryEvent.externalWorkflowExecutionCancelRequestedEventAttributes


externalWorkflowExecutionSignaledEventAttributes

Optional externalWorkflowExecutionSignaledEventAttributes: null | IExternalWorkflowExecutionSignaledEventAttributes

HistoryEvent externalWorkflowExecutionSignaledEventAttributes.

Implementation of

IHistoryEvent.externalWorkflowExecutionSignaledEventAttributes


markerRecordedEventAttributes

Optional markerRecordedEventAttributes: null | IMarkerRecordedEventAttributes

HistoryEvent markerRecordedEventAttributes.

Implementation of

IHistoryEvent.markerRecordedEventAttributes


nexusOperationCancelRequestedEventAttributes

Optional nexusOperationCancelRequestedEventAttributes: null | INexusOperationCancelRequestedEventAttributes

HistoryEvent nexusOperationCancelRequestedEventAttributes.

Implementation of

IHistoryEvent.nexusOperationCancelRequestedEventAttributes


nexusOperationCanceledEventAttributes

Optional nexusOperationCanceledEventAttributes: null | INexusOperationCanceledEventAttributes

HistoryEvent nexusOperationCanceledEventAttributes.

Implementation of

IHistoryEvent.nexusOperationCanceledEventAttributes


nexusOperationCompletedEventAttributes

Optional nexusOperationCompletedEventAttributes: null | INexusOperationCompletedEventAttributes

HistoryEvent nexusOperationCompletedEventAttributes.

Implementation of

IHistoryEvent.nexusOperationCompletedEventAttributes


nexusOperationFailedEventAttributes

Optional nexusOperationFailedEventAttributes: null | INexusOperationFailedEventAttributes

HistoryEvent nexusOperationFailedEventAttributes.

Implementation of

IHistoryEvent.nexusOperationFailedEventAttributes


nexusOperationScheduledEventAttributes

Optional nexusOperationScheduledEventAttributes: null | INexusOperationScheduledEventAttributes

HistoryEvent nexusOperationScheduledEventAttributes.

Implementation of

IHistoryEvent.nexusOperationScheduledEventAttributes


nexusOperationStartedEventAttributes

Optional nexusOperationStartedEventAttributes: null | INexusOperationStartedEventAttributes

HistoryEvent nexusOperationStartedEventAttributes.

Implementation of

IHistoryEvent.nexusOperationStartedEventAttributes


nexusOperationTimedOutEventAttributes

Optional nexusOperationTimedOutEventAttributes: null | INexusOperationTimedOutEventAttributes

HistoryEvent nexusOperationTimedOutEventAttributes.

Implementation of

IHistoryEvent.nexusOperationTimedOutEventAttributes


requestCancelExternalWorkflowExecutionFailedEventAttributes

Optional requestCancelExternalWorkflowExecutionFailedEventAttributes: null | IRequestCancelExternalWorkflowExecutionFailedEventAttributes

HistoryEvent requestCancelExternalWorkflowExecutionFailedEventAttributes.

Implementation of

IHistoryEvent.requestCancelExternalWorkflowExecutionFailedEventAttributes


requestCancelExternalWorkflowExecutionInitiatedEventAttributes

Optional requestCancelExternalWorkflowExecutionInitiatedEventAttributes: null | IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes

HistoryEvent requestCancelExternalWorkflowExecutionInitiatedEventAttributes.

Implementation of

IHistoryEvent.requestCancelExternalWorkflowExecutionInitiatedEventAttributes


signalExternalWorkflowExecutionFailedEventAttributes

Optional signalExternalWorkflowExecutionFailedEventAttributes: null | ISignalExternalWorkflowExecutionFailedEventAttributes

HistoryEvent signalExternalWorkflowExecutionFailedEventAttributes.

Implementation of

IHistoryEvent.signalExternalWorkflowExecutionFailedEventAttributes


signalExternalWorkflowExecutionInitiatedEventAttributes

Optional signalExternalWorkflowExecutionInitiatedEventAttributes: null | ISignalExternalWorkflowExecutionInitiatedEventAttributes

HistoryEvent signalExternalWorkflowExecutionInitiatedEventAttributes.

Implementation of

IHistoryEvent.signalExternalWorkflowExecutionInitiatedEventAttributes


startChildWorkflowExecutionFailedEventAttributes

Optional startChildWorkflowExecutionFailedEventAttributes: null | IStartChildWorkflowExecutionFailedEventAttributes

HistoryEvent startChildWorkflowExecutionFailedEventAttributes.

Implementation of

IHistoryEvent.startChildWorkflowExecutionFailedEventAttributes


startChildWorkflowExecutionInitiatedEventAttributes

Optional startChildWorkflowExecutionInitiatedEventAttributes: null | IStartChildWorkflowExecutionInitiatedEventAttributes

HistoryEvent startChildWorkflowExecutionInitiatedEventAttributes.

Implementation of

IHistoryEvent.startChildWorkflowExecutionInitiatedEventAttributes


taskId

taskId: Long

TODO: What is this? Appears unused by SDKs

Implementation of

IHistoryEvent.taskId


timerCanceledEventAttributes

Optional timerCanceledEventAttributes: null | ITimerCanceledEventAttributes

HistoryEvent timerCanceledEventAttributes.

Implementation of

IHistoryEvent.timerCanceledEventAttributes


timerFiredEventAttributes

Optional timerFiredEventAttributes: null | ITimerFiredEventAttributes

HistoryEvent timerFiredEventAttributes.

Implementation of

IHistoryEvent.timerFiredEventAttributes


timerStartedEventAttributes

Optional timerStartedEventAttributes: null | ITimerStartedEventAttributes

HistoryEvent timerStartedEventAttributes.

Implementation of

IHistoryEvent.timerStartedEventAttributes


upsertWorkflowSearchAttributesEventAttributes

Optional upsertWorkflowSearchAttributesEventAttributes: null | IUpsertWorkflowSearchAttributesEventAttributes

HistoryEvent upsertWorkflowSearchAttributesEventAttributes.

Implementation of

IHistoryEvent.upsertWorkflowSearchAttributesEventAttributes


userMetadata

Optional userMetadata: null | IUserMetadata

Metadata on the event. This is often carried over from commands and client calls. Most events won't have this information, and how this information is used is dependent upon the interface that reads it.

Current well-known uses:

  • workflow_execution_started_event_attributes - summary and details from start workflow.
  • timer_started_event_attributes - summary represents an identifier for the timer for use by user interfaces.

Implementation of

IHistoryEvent.userMetadata


version

version: Long

TODO: What is this? Appears unused by SDKs

Implementation of

IHistoryEvent.version


workerMayIgnore

workerMayIgnore: boolean

Set to true when the SDK may ignore the event as it does not impact workflow state or information in any way that the SDK need be concerned with. If an SDK encounters an event type which it does not understand, it must error unless this is true. If it is true, it's acceptable for the event type and/or attributes to be uninterpretable.

Implementation of

IHistoryEvent.workerMayIgnore


workflowExecutionCancelRequestedEventAttributes

Optional workflowExecutionCancelRequestedEventAttributes: null | IWorkflowExecutionCancelRequestedEventAttributes

HistoryEvent workflowExecutionCancelRequestedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionCancelRequestedEventAttributes


workflowExecutionCanceledEventAttributes

Optional workflowExecutionCanceledEventAttributes: null | IWorkflowExecutionCanceledEventAttributes

HistoryEvent workflowExecutionCanceledEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionCanceledEventAttributes


workflowExecutionCompletedEventAttributes

Optional workflowExecutionCompletedEventAttributes: null | IWorkflowExecutionCompletedEventAttributes

HistoryEvent workflowExecutionCompletedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionCompletedEventAttributes


workflowExecutionContinuedAsNewEventAttributes

Optional workflowExecutionContinuedAsNewEventAttributes: null | IWorkflowExecutionContinuedAsNewEventAttributes

HistoryEvent workflowExecutionContinuedAsNewEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionContinuedAsNewEventAttributes


workflowExecutionFailedEventAttributes

Optional workflowExecutionFailedEventAttributes: null | IWorkflowExecutionFailedEventAttributes

HistoryEvent workflowExecutionFailedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionFailedEventAttributes


workflowExecutionSignaledEventAttributes

Optional workflowExecutionSignaledEventAttributes: null | IWorkflowExecutionSignaledEventAttributes

HistoryEvent workflowExecutionSignaledEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionSignaledEventAttributes


workflowExecutionStartedEventAttributes

Optional workflowExecutionStartedEventAttributes: null | IWorkflowExecutionStartedEventAttributes

HistoryEvent workflowExecutionStartedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionStartedEventAttributes


workflowExecutionTerminatedEventAttributes

Optional workflowExecutionTerminatedEventAttributes: null | IWorkflowExecutionTerminatedEventAttributes

HistoryEvent workflowExecutionTerminatedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionTerminatedEventAttributes


workflowExecutionTimedOutEventAttributes

Optional workflowExecutionTimedOutEventAttributes: null | IWorkflowExecutionTimedOutEventAttributes

HistoryEvent workflowExecutionTimedOutEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionTimedOutEventAttributes


workflowExecutionUpdateAcceptedEventAttributes

Optional workflowExecutionUpdateAcceptedEventAttributes: null | IWorkflowExecutionUpdateAcceptedEventAttributes

HistoryEvent workflowExecutionUpdateAcceptedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionUpdateAcceptedEventAttributes


workflowExecutionUpdateAdmittedEventAttributes

Optional workflowExecutionUpdateAdmittedEventAttributes: null | IWorkflowExecutionUpdateAdmittedEventAttributes

HistoryEvent workflowExecutionUpdateAdmittedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionUpdateAdmittedEventAttributes


workflowExecutionUpdateCompletedEventAttributes

Optional workflowExecutionUpdateCompletedEventAttributes: null | IWorkflowExecutionUpdateCompletedEventAttributes

HistoryEvent workflowExecutionUpdateCompletedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionUpdateCompletedEventAttributes


workflowExecutionUpdateRejectedEventAttributes

Optional workflowExecutionUpdateRejectedEventAttributes: null | IWorkflowExecutionUpdateRejectedEventAttributes

HistoryEvent workflowExecutionUpdateRejectedEventAttributes.

Implementation of

IHistoryEvent.workflowExecutionUpdateRejectedEventAttributes


workflowPropertiesModifiedEventAttributes

Optional workflowPropertiesModifiedEventAttributes: null | IWorkflowPropertiesModifiedEventAttributes

HistoryEvent workflowPropertiesModifiedEventAttributes.

Implementation of

IHistoryEvent.workflowPropertiesModifiedEventAttributes


workflowPropertiesModifiedExternallyEventAttributes

Optional workflowPropertiesModifiedExternallyEventAttributes: null | IWorkflowPropertiesModifiedExternallyEventAttributes

HistoryEvent workflowPropertiesModifiedExternallyEventAttributes.

Implementation of

IHistoryEvent.workflowPropertiesModifiedExternallyEventAttributes


workflowTaskCompletedEventAttributes

Optional workflowTaskCompletedEventAttributes: null | IWorkflowTaskCompletedEventAttributes

HistoryEvent workflowTaskCompletedEventAttributes.

Implementation of

IHistoryEvent.workflowTaskCompletedEventAttributes


workflowTaskFailedEventAttributes

Optional workflowTaskFailedEventAttributes: null | IWorkflowTaskFailedEventAttributes

HistoryEvent workflowTaskFailedEventAttributes.

Implementation of

IHistoryEvent.workflowTaskFailedEventAttributes


workflowTaskScheduledEventAttributes

Optional workflowTaskScheduledEventAttributes: null | IWorkflowTaskScheduledEventAttributes

HistoryEvent workflowTaskScheduledEventAttributes.

Implementation of

IHistoryEvent.workflowTaskScheduledEventAttributes


workflowTaskStartedEventAttributes

Optional workflowTaskStartedEventAttributes: null | IWorkflowTaskStartedEventAttributes

HistoryEvent workflowTaskStartedEventAttributes.

Implementation of

IHistoryEvent.workflowTaskStartedEventAttributes


workflowTaskTimedOutEventAttributes

Optional workflowTaskTimedOutEventAttributes: null | IWorkflowTaskTimedOutEventAttributes

HistoryEvent workflowTaskTimedOutEventAttributes.

Implementation of

IHistoryEvent.workflowTaskTimedOutEventAttributes

Methods

toJSON

toJSON(): Object

Converts this HistoryEvent to JSON.

Returns

Object

JSON object


create

create(properties?): HistoryEvent

Creates a new HistoryEvent instance using the specified properties.

Parameters

NameTypeDescription
properties?IHistoryEventProperties to set

Returns

HistoryEvent

HistoryEvent instance


decode

decode(reader, length?): HistoryEvent

Decodes a HistoryEvent message from the specified reader or buffer.

Parameters

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

Returns

HistoryEvent

HistoryEvent

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): HistoryEvent

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

HistoryEvent

HistoryEvent

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): HistoryEvent

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

HistoryEvent

HistoryEvent


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for HistoryEvent

Parameters

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

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageHistoryEventHistoryEvent
options?IConversionOptionsConversion options

Returns

Object

Plain object