Class: 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
Name | Type | Description |
---|---|---|
properties? | IHistoryEvent | Properties to set |
Returns
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"
| "workflowExecutionUpdateRequestedEventAttributes"
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
eventTime
• Optional
eventTime: null
| ITimestamp
HistoryEvent eventTime.
Implementation of
eventType
• eventType: EventType
HistoryEvent eventType.
Implementation of
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
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
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