Skip to main content

Interface: IHistoryEvent

history.v1.IHistoryEvent

Properties of a HistoryEvent.

Implemented by​

Properties​

activityPropertiesModifiedExternallyEventAttributes​

• Optional activityPropertiesModifiedExternallyEventAttributes: null | IActivityPropertiesModifiedExternallyEventAttributes

HistoryEvent activityPropertiesModifiedExternallyEventAttributes

activityTaskCancelRequestedEventAttributes​

• Optional activityTaskCancelRequestedEventAttributes: null | IActivityTaskCancelRequestedEventAttributes

HistoryEvent activityTaskCancelRequestedEventAttributes

activityTaskCanceledEventAttributes​

• Optional activityTaskCanceledEventAttributes: null | IActivityTaskCanceledEventAttributes

HistoryEvent activityTaskCanceledEventAttributes

activityTaskCompletedEventAttributes​

• Optional activityTaskCompletedEventAttributes: null | IActivityTaskCompletedEventAttributes

HistoryEvent activityTaskCompletedEventAttributes

activityTaskFailedEventAttributes​

• Optional activityTaskFailedEventAttributes: null | IActivityTaskFailedEventAttributes

HistoryEvent activityTaskFailedEventAttributes

activityTaskScheduledEventAttributes​

• Optional activityTaskScheduledEventAttributes: null | IActivityTaskScheduledEventAttributes

HistoryEvent activityTaskScheduledEventAttributes

activityTaskStartedEventAttributes​

• Optional activityTaskStartedEventAttributes: null | IActivityTaskStartedEventAttributes

HistoryEvent activityTaskStartedEventAttributes

activityTaskTimedOutEventAttributes​

• Optional activityTaskTimedOutEventAttributes: null | IActivityTaskTimedOutEventAttributes

HistoryEvent activityTaskTimedOutEventAttributes

childWorkflowExecutionCanceledEventAttributes​

• Optional childWorkflowExecutionCanceledEventAttributes: null | IChildWorkflowExecutionCanceledEventAttributes

HistoryEvent childWorkflowExecutionCanceledEventAttributes

childWorkflowExecutionCompletedEventAttributes​

• Optional childWorkflowExecutionCompletedEventAttributes: null | IChildWorkflowExecutionCompletedEventAttributes

HistoryEvent childWorkflowExecutionCompletedEventAttributes

childWorkflowExecutionFailedEventAttributes​

• Optional childWorkflowExecutionFailedEventAttributes: null | IChildWorkflowExecutionFailedEventAttributes

HistoryEvent childWorkflowExecutionFailedEventAttributes

childWorkflowExecutionStartedEventAttributes​

• Optional childWorkflowExecutionStartedEventAttributes: null | IChildWorkflowExecutionStartedEventAttributes

HistoryEvent childWorkflowExecutionStartedEventAttributes

childWorkflowExecutionTerminatedEventAttributes​

• Optional childWorkflowExecutionTerminatedEventAttributes: null | IChildWorkflowExecutionTerminatedEventAttributes

HistoryEvent childWorkflowExecutionTerminatedEventAttributes

childWorkflowExecutionTimedOutEventAttributes​

• Optional childWorkflowExecutionTimedOutEventAttributes: null | IChildWorkflowExecutionTimedOutEventAttributes

HistoryEvent childWorkflowExecutionTimedOutEventAttributes

eventId​

• Optional eventId: null | Long

Monotonically increasing event number, starts at 1.

eventTime​

• Optional eventTime: null | ITimestamp

HistoryEvent eventTime

eventType​

• Optional eventType: null | EventType

HistoryEvent eventType

externalWorkflowExecutionCancelRequestedEventAttributes​

• Optional externalWorkflowExecutionCancelRequestedEventAttributes: null | IExternalWorkflowExecutionCancelRequestedEventAttributes

HistoryEvent externalWorkflowExecutionCancelRequestedEventAttributes

externalWorkflowExecutionSignaledEventAttributes​

• Optional externalWorkflowExecutionSignaledEventAttributes: null | IExternalWorkflowExecutionSignaledEventAttributes

HistoryEvent externalWorkflowExecutionSignaledEventAttributes

• Optional links: null | ILink[]

Links associated with the event.

markerRecordedEventAttributes​

• Optional markerRecordedEventAttributes: null | IMarkerRecordedEventAttributes

HistoryEvent markerRecordedEventAttributes

nexusOperationCancelRequestedEventAttributes​

• Optional nexusOperationCancelRequestedEventAttributes: null | INexusOperationCancelRequestedEventAttributes

HistoryEvent nexusOperationCancelRequestedEventAttributes

nexusOperationCanceledEventAttributes​

• Optional nexusOperationCanceledEventAttributes: null | INexusOperationCanceledEventAttributes

HistoryEvent nexusOperationCanceledEventAttributes

nexusOperationCompletedEventAttributes​

• Optional nexusOperationCompletedEventAttributes: null | INexusOperationCompletedEventAttributes

HistoryEvent nexusOperationCompletedEventAttributes

nexusOperationFailedEventAttributes​

• Optional nexusOperationFailedEventAttributes: null | INexusOperationFailedEventAttributes

HistoryEvent nexusOperationFailedEventAttributes

nexusOperationScheduledEventAttributes​

• Optional nexusOperationScheduledEventAttributes: null | INexusOperationScheduledEventAttributes

HistoryEvent nexusOperationScheduledEventAttributes

nexusOperationStartedEventAttributes​

• Optional nexusOperationStartedEventAttributes: null | INexusOperationStartedEventAttributes

HistoryEvent nexusOperationStartedEventAttributes

nexusOperationTimedOutEventAttributes​

• Optional nexusOperationTimedOutEventAttributes: null | INexusOperationTimedOutEventAttributes

HistoryEvent nexusOperationTimedOutEventAttributes

requestCancelExternalWorkflowExecutionFailedEventAttributes​

• Optional requestCancelExternalWorkflowExecutionFailedEventAttributes: null | IRequestCancelExternalWorkflowExecutionFailedEventAttributes

HistoryEvent requestCancelExternalWorkflowExecutionFailedEventAttributes

requestCancelExternalWorkflowExecutionInitiatedEventAttributes​

• Optional requestCancelExternalWorkflowExecutionInitiatedEventAttributes: null | IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes

HistoryEvent requestCancelExternalWorkflowExecutionInitiatedEventAttributes

signalExternalWorkflowExecutionFailedEventAttributes​

• Optional signalExternalWorkflowExecutionFailedEventAttributes: null | ISignalExternalWorkflowExecutionFailedEventAttributes

HistoryEvent signalExternalWorkflowExecutionFailedEventAttributes

signalExternalWorkflowExecutionInitiatedEventAttributes​

• Optional signalExternalWorkflowExecutionInitiatedEventAttributes: null | ISignalExternalWorkflowExecutionInitiatedEventAttributes

HistoryEvent signalExternalWorkflowExecutionInitiatedEventAttributes

startChildWorkflowExecutionFailedEventAttributes​

• Optional startChildWorkflowExecutionFailedEventAttributes: null | IStartChildWorkflowExecutionFailedEventAttributes

HistoryEvent startChildWorkflowExecutionFailedEventAttributes

startChildWorkflowExecutionInitiatedEventAttributes​

• Optional startChildWorkflowExecutionInitiatedEventAttributes: null | IStartChildWorkflowExecutionInitiatedEventAttributes

HistoryEvent startChildWorkflowExecutionInitiatedEventAttributes

taskId​

• Optional taskId: null | Long

TODO: What is this? Appears unused by SDKs

timerCanceledEventAttributes​

• Optional timerCanceledEventAttributes: null | ITimerCanceledEventAttributes

HistoryEvent timerCanceledEventAttributes

timerFiredEventAttributes​

• Optional timerFiredEventAttributes: null | ITimerFiredEventAttributes

HistoryEvent timerFiredEventAttributes

timerStartedEventAttributes​

• Optional timerStartedEventAttributes: null | ITimerStartedEventAttributes

HistoryEvent timerStartedEventAttributes

upsertWorkflowSearchAttributesEventAttributes​

• Optional upsertWorkflowSearchAttributesEventAttributes: null | IUpsertWorkflowSearchAttributesEventAttributes

HistoryEvent 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.

version​

• Optional version: null | Long

TODO: What is this? Appears unused by SDKs

workerMayIgnore​

• Optional workerMayIgnore: null | 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.

workflowExecutionCancelRequestedEventAttributes​

• Optional workflowExecutionCancelRequestedEventAttributes: null | IWorkflowExecutionCancelRequestedEventAttributes

HistoryEvent workflowExecutionCancelRequestedEventAttributes

workflowExecutionCanceledEventAttributes​

• Optional workflowExecutionCanceledEventAttributes: null | IWorkflowExecutionCanceledEventAttributes

HistoryEvent workflowExecutionCanceledEventAttributes

workflowExecutionCompletedEventAttributes​

• Optional workflowExecutionCompletedEventAttributes: null | IWorkflowExecutionCompletedEventAttributes

HistoryEvent workflowExecutionCompletedEventAttributes

workflowExecutionContinuedAsNewEventAttributes​

• Optional workflowExecutionContinuedAsNewEventAttributes: null | IWorkflowExecutionContinuedAsNewEventAttributes

HistoryEvent workflowExecutionContinuedAsNewEventAttributes

workflowExecutionFailedEventAttributes​

• Optional workflowExecutionFailedEventAttributes: null | IWorkflowExecutionFailedEventAttributes

HistoryEvent workflowExecutionFailedEventAttributes

workflowExecutionSignaledEventAttributes​

• Optional workflowExecutionSignaledEventAttributes: null | IWorkflowExecutionSignaledEventAttributes

HistoryEvent workflowExecutionSignaledEventAttributes

workflowExecutionStartedEventAttributes​

• Optional workflowExecutionStartedEventAttributes: null | IWorkflowExecutionStartedEventAttributes

HistoryEvent workflowExecutionStartedEventAttributes

workflowExecutionTerminatedEventAttributes​

• Optional workflowExecutionTerminatedEventAttributes: null | IWorkflowExecutionTerminatedEventAttributes

HistoryEvent workflowExecutionTerminatedEventAttributes

workflowExecutionTimedOutEventAttributes​

• Optional workflowExecutionTimedOutEventAttributes: null | IWorkflowExecutionTimedOutEventAttributes

HistoryEvent workflowExecutionTimedOutEventAttributes

workflowExecutionUpdateAcceptedEventAttributes​

• Optional workflowExecutionUpdateAcceptedEventAttributes: null | IWorkflowExecutionUpdateAcceptedEventAttributes

HistoryEvent workflowExecutionUpdateAcceptedEventAttributes

workflowExecutionUpdateAdmittedEventAttributes​

• Optional workflowExecutionUpdateAdmittedEventAttributes: null | IWorkflowExecutionUpdateAdmittedEventAttributes

HistoryEvent workflowExecutionUpdateAdmittedEventAttributes

workflowExecutionUpdateCompletedEventAttributes​

• Optional workflowExecutionUpdateCompletedEventAttributes: null | IWorkflowExecutionUpdateCompletedEventAttributes

HistoryEvent workflowExecutionUpdateCompletedEventAttributes

workflowExecutionUpdateRejectedEventAttributes​

• Optional workflowExecutionUpdateRejectedEventAttributes: null | IWorkflowExecutionUpdateRejectedEventAttributes

HistoryEvent workflowExecutionUpdateRejectedEventAttributes

workflowPropertiesModifiedEventAttributes​

• Optional workflowPropertiesModifiedEventAttributes: null | IWorkflowPropertiesModifiedEventAttributes

HistoryEvent workflowPropertiesModifiedEventAttributes

workflowPropertiesModifiedExternallyEventAttributes​

• Optional workflowPropertiesModifiedExternallyEventAttributes: null | IWorkflowPropertiesModifiedExternallyEventAttributes

HistoryEvent workflowPropertiesModifiedExternallyEventAttributes

workflowTaskCompletedEventAttributes​

• Optional workflowTaskCompletedEventAttributes: null | IWorkflowTaskCompletedEventAttributes

HistoryEvent workflowTaskCompletedEventAttributes

workflowTaskFailedEventAttributes​

• Optional workflowTaskFailedEventAttributes: null | IWorkflowTaskFailedEventAttributes

HistoryEvent workflowTaskFailedEventAttributes

workflowTaskScheduledEventAttributes​

• Optional workflowTaskScheduledEventAttributes: null | IWorkflowTaskScheduledEventAttributes

HistoryEvent workflowTaskScheduledEventAttributes

workflowTaskStartedEventAttributes​

• Optional workflowTaskStartedEventAttributes: null | IWorkflowTaskStartedEventAttributes

HistoryEvent workflowTaskStartedEventAttributes

workflowTaskTimedOutEventAttributes​

• Optional workflowTaskTimedOutEventAttributes: null | IWorkflowTaskTimedOutEventAttributes

HistoryEvent workflowTaskTimedOutEventAttributes