Interface: IHistoryEvent
Properties of a HistoryEvent.
Hierarchy
-
↳
IHistoryEvent
Properties
activityPropertiesModifiedExternallyEventAttributes
• Optional activityPropertiesModifiedExternallyEventAttributes: null | $Properties
HistoryEvent activityPropertiesModifiedExternallyEventAttributes
Inherited from
$Properties.activityPropertiesModifiedExternallyEventAttributes
activityTaskCancelRequestedEventAttributes
• Optional activityTaskCancelRequestedEventAttributes: null | $Properties
HistoryEvent activityTaskCancelRequestedEventAttributes
Inherited from
$Properties.activityTaskCancelRequestedEventAttributes
activityTaskCanceledEventAttributes
• Optional activityTaskCanceledEventAttributes: null | $Properties
HistoryEvent activityTaskCanceledEventAttributes
Inherited from
$Properties.activityTaskCanceledEventAttributes
activityTaskCompletedEventAttributes
• Optional activityTaskCompletedEventAttributes: null | $Properties
HistoryEvent activityTaskCompletedEventAttributes
Inherited from
$Properties.activityTaskCompletedEventAttributes
activityTaskFailedEventAttributes
• Optional activityTaskFailedEventAttributes: null | $Properties
HistoryEvent activityTaskFailedEventAttributes
Inherited from
$Properties.activityTaskFailedEventAttributes
activityTaskScheduledEventAttributes
• Optional activityTaskScheduledEventAttributes: null | $Properties
HistoryEvent activityTaskScheduledEventAttributes
Inherited from
$Properties.activityTaskScheduledEventAttributes
activityTaskStartedEventAttributes
• Optional activityTaskStartedEventAttributes: null | $Properties
HistoryEvent activityTaskStartedEventAttributes
Inherited from
$Properties.activityTaskStartedEventAttributes
activityTaskTimedOutEventAttributes
• Optional activityTaskTimedOutEventAttributes: null | $Properties
HistoryEvent activityTaskTimedOutEventAttributes
Inherited from
$Properties.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" | "workflowExecutionOptionsUpdatedEventAttributes" | "nexusOperationCancelRequestCompletedEventAttributes" | "nexusOperationCancelRequestFailedEventAttributes" | "workflowExecutionPausedEventAttributes" | "workflowExecutionUnpausedEventAttributes" | "workflowExecutionTimeSkippingTransitionedEventAttributes"
The event details. The type must match that in event_type.
Inherited from
childWorkflowExecutionCanceledEventAttributes
• Optional childWorkflowExecutionCanceledEventAttributes: null | $Properties
HistoryEvent childWorkflowExecutionCanceledEventAttributes
Inherited from
$Properties.childWorkflowExecutionCanceledEventAttributes
childWorkflowExecutionCompletedEventAttributes
• Optional childWorkflowExecutionCompletedEventAttributes: null | $Properties
HistoryEvent childWorkflowExecutionCompletedEventAttributes
Inherited from
$Properties.childWorkflowExecutionCompletedEventAttributes
childWorkflowExecutionFailedEventAttributes
• Optional childWorkflowExecutionFailedEventAttributes: null | $Properties
HistoryEvent childWorkflowExecutionFailedEventAttributes
Inherited from
$Properties.childWorkflowExecutionFailedEventAttributes
childWorkflowExecutionStartedEventAttributes
• Optional childWorkflowExecutionStartedEventAttributes: null | $Properties
HistoryEvent childWorkflowExecutionStartedEventAttributes
Inherited from
$Properties.childWorkflowExecutionStartedEventAttributes
childWorkflowExecutionTerminatedEventAttributes
• Optional childWorkflowExecutionTerminatedEventAttributes: null | $Properties
HistoryEvent childWorkflowExecutionTerminatedEventAttributes
Inherited from
$Properties.childWorkflowExecutionTerminatedEventAttributes
childWorkflowExecutionTimedOutEventAttributes
• Optional childWorkflowExecutionTimedOutEventAttributes: null | $Properties
HistoryEvent childWorkflowExecutionTimedOutEventAttributes
Inherited from
$Properties.childWorkflowExecutionTimedOutEventAttributes
eventGroupMarkers
• Optional eventGroupMarkers: null | $Properties[]
Event group markers attached to this event.
Inherited from
eventId
• Optional eventId: null | Long
Monotonically increasing event number, starts at 1.
Inherited from
eventTime
• Optional eventTime: null | $Properties
HistoryEvent eventTime
Inherited from
eventType
• Optional eventType: null | EventType
HistoryEvent eventType
Inherited from
externalWorkflowExecutionCancelRequestedEventAttributes
• Optional externalWorkflowExecutionCancelRequestedEventAttributes: null | $Properties
HistoryEvent externalWorkflowExecutionCancelRequestedEventAttributes
Inherited from
$Properties.externalWorkflowExecutionCancelRequestedEventAttributes
externalWorkflowExecutionSignaledEventAttributes
• Optional externalWorkflowExecutionSignaledEventAttributes: null | $Properties
HistoryEvent externalWorkflowExecutionSignaledEventAttributes
Inherited from
$Properties.externalWorkflowExecutionSignaledEventAttributes
links
• Optional links: null | $Properties[]
Links to related entities, such as the entity that started this event's workflow.
Inherited from
markerRecordedEventAttributes
• Optional markerRecordedEventAttributes: null | $Properties
HistoryEvent markerRecordedEventAttributes
Inherited from
$Properties.markerRecordedEventAttributes
nexusOperationCancelRequestCompletedEventAttributes
• Optional nexusOperationCancelRequestCompletedEventAttributes: null | $Properties
HistoryEvent nexusOperationCancelRequestCompletedEventAttributes
Inherited from
$Properties.nexusOperationCancelRequestCompletedEventAttributes
nexusOperationCancelRequestFailedEventAttributes
• Optional nexusOperationCancelRequestFailedEventAttributes: null | $Properties
HistoryEvent nexusOperationCancelRequestFailedEventAttributes
Inherited from
$Properties.nexusOperationCancelRequestFailedEventAttributes
nexusOperationCancelRequestedEventAttributes
• Optional nexusOperationCancelRequestedEventAttributes: null | $Properties
HistoryEvent nexusOperationCancelRequestedEventAttributes
Inherited from
$Properties.nexusOperationCancelRequestedEventAttributes
nexusOperationCanceledEventAttributes
• Optional nexusOperationCanceledEventAttributes: null | $Properties
HistoryEvent nexusOperationCanceledEventAttributes
Inherited from
$Properties.nexusOperationCanceledEventAttributes
nexusOperationCompletedEventAttributes
• Optional nexusOperationCompletedEventAttributes: null | $Properties
HistoryEvent nexusOperationCompletedEventAttributes
Inherited from
$Properties.nexusOperationCompletedEventAttributes
nexusOperationFailedEventAttributes
• Optional nexusOperationFailedEventAttributes: null | $Properties
HistoryEvent nexusOperationFailedEventAttributes
Inherited from
$Properties.nexusOperationFailedEventAttributes
nexusOperationScheduledEventAttributes
• Optional nexusOperationScheduledEventAttributes: null | $Properties
HistoryEvent nexusOperationScheduledEventAttributes
Inherited from
$Properties.nexusOperationScheduledEventAttributes
nexusOperationStartedEventAttributes
• Optional nexusOperationStartedEventAttributes: null | $Properties
HistoryEvent nexusOperationStartedEventAttributes
Inherited from
$Properties.nexusOperationStartedEventAttributes
nexusOperationTimedOutEventAttributes
• Optional nexusOperationTimedOutEventAttributes: null | $Properties
HistoryEvent nexusOperationTimedOutEventAttributes
Inherited from
$Properties.nexusOperationTimedOutEventAttributes
principal
• Optional principal: null | $Properties
Server-computed authenticated caller identity associated with this event.
Inherited from
requestCancelExternalWorkflowExecutionFailedEventAttributes
• Optional requestCancelExternalWorkflowExecutionFailedEventAttributes: null | $Properties
HistoryEvent requestCancelExternalWorkflowExecutionFailedEventAttributes
Inherited from
$Properties.requestCancelExternalWorkflowExecutionFailedEventAttributes
requestCancelExternalWorkflowExecutionInitiatedEventAttributes
• Optional requestCancelExternalWorkflowExecutionInitiatedEventAttributes: null | $Properties
HistoryEvent requestCancelExternalWorkflowExecutionInitiatedEventAttributes
Inherited from
$Properties.requestCancelExternalWorkflowExecutionInitiatedEventAttributes
signalExternalWorkflowExecutionFailedEventAttributes
• Optional signalExternalWorkflowExecutionFailedEventAttributes: null | $Properties
HistoryEvent signalExternalWorkflowExecutionFailedEventAttributes
Inherited from
$Properties.signalExternalWorkflowExecutionFailedEventAttributes
signalExternalWorkflowExecutionInitiatedEventAttributes
• Optional signalExternalWorkflowExecutionInitiatedEventAttributes: null | $Properties
HistoryEvent signalExternalWorkflowExecutionInitiatedEventAttributes
Inherited from
$Properties.signalExternalWorkflowExecutionInitiatedEventAttributes
startChildWorkflowExecutionFailedEventAttributes
• Optional startChildWorkflowExecutionFailedEventAttributes: null | $Properties
HistoryEvent startChildWorkflowExecutionFailedEventAttributes
Inherited from
$Properties.startChildWorkflowExecutionFailedEventAttributes
startChildWorkflowExecutionInitiatedEventAttributes
• Optional startChildWorkflowExecutionInitiatedEventAttributes: null | $Properties
HistoryEvent startChildWorkflowExecutionInitiatedEventAttributes
Inherited from
$Properties.startChildWorkflowExecutionInitiatedEventAttributes
taskId
• Optional taskId: null | Long
Identifier used by the service to order replication and transfer tasks associated with this event. SDKs generally ignore this field.
Inherited from
timerCanceledEventAttributes
• Optional timerCanceledEventAttributes: null | $Properties
HistoryEvent timerCanceledEventAttributes
Inherited from
$Properties.timerCanceledEventAttributes
timerFiredEventAttributes
• Optional timerFiredEventAttributes: null | $Properties
HistoryEvent timerFiredEventAttributes
Inherited from
$Properties.timerFiredEventAttributes
timerStartedEventAttributes
• Optional timerStartedEventAttributes: null | $Properties
HistoryEvent timerStartedEventAttributes
Inherited from
$Properties.timerStartedEventAttributes
upsertWorkflowSearchAttributesEventAttributes
• Optional upsertWorkflowSearchAttributesEventAttributes: null | $Properties
HistoryEvent upsertWorkflowSearchAttributesEventAttributes
Inherited from
$Properties.upsertWorkflowSearchAttributesEventAttributes
userMetadata
• Optional userMetadata: null | $Properties
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.
Inherited from
version
• Optional version: null | Long
Failover version of the event, used by the server for multi-cluster replication and history versioning. SDKs generally ignore this field.
Inherited from
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.
Inherited from
workflowExecutionCancelRequestedEventAttributes
• Optional workflowExecutionCancelRequestedEventAttributes: null | $Properties
HistoryEvent workflowExecutionCancelRequestedEventAttributes
Inherited from
$Properties.workflowExecutionCancelRequestedEventAttributes
workflowExecutionCanceledEventAttributes
• Optional workflowExecutionCanceledEventAttributes: null | $Properties
HistoryEvent workflowExecutionCanceledEventAttributes
Inherited from
$Properties.workflowExecutionCanceledEventAttributes
workflowExecutionCompletedEventAttributes
• Optional workflowExecutionCompletedEventAttributes: null | $Properties
HistoryEvent workflowExecutionCompletedEventAttributes
Inherited from
$Properties.workflowExecutionCompletedEventAttributes
workflowExecutionContinuedAsNewEventAttributes
• Optional workflowExecutionContinuedAsNewEventAttributes: null | $Properties
HistoryEvent workflowExecutionContinuedAsNewEventAttributes
Inherited from
$Properties.workflowExecutionContinuedAsNewEventAttributes
workflowExecutionFailedEventAttributes
• Optional workflowExecutionFailedEventAttributes: null | $Properties
HistoryEvent workflowExecutionFailedEventAttributes
Inherited from
$Properties.workflowExecutionFailedEventAttributes
workflowExecutionOptionsUpdatedEventAttributes
• Optional workflowExecutionOptionsUpdatedEventAttributes: null | $Properties
HistoryEvent workflowExecutionOptionsUpdatedEventAttributes
Inherited from
$Properties.workflowExecutionOptionsUpdatedEventAttributes
workflowExecutionPausedEventAttributes
• Optional workflowExecutionPausedEventAttributes: null | $Properties
HistoryEvent workflowExecutionPausedEventAttributes
Inherited from
$Properties.workflowExecutionPausedEventAttributes
workflowExecutionSignaledEventAttributes
• Optional workflowExecutionSignaledEventAttributes: null | $Properties
HistoryEvent workflowExecutionSignaledEventAttributes
Inherited from
$Properties.workflowExecutionSignaledEventAttributes
workflowExecutionStartedEventAttributes
• Optional workflowExecutionStartedEventAttributes: null | $Properties
HistoryEvent workflowExecutionStartedEventAttributes
Inherited from
$Properties.workflowExecutionStartedEventAttributes
workflowExecutionTerminatedEventAttributes
• Optional workflowExecutionTerminatedEventAttributes: null | $Properties
HistoryEvent workflowExecutionTerminatedEventAttributes
Inherited from
$Properties.workflowExecutionTerminatedEventAttributes
workflowExecutionTimeSkippingTransitionedEventAttributes
• Optional workflowExecutionTimeSkippingTransitionedEventAttributes: null | $Properties
HistoryEvent workflowExecutionTimeSkippingTransitionedEventAttributes
Inherited from
$Properties.workflowExecutionTimeSkippingTransitionedEventAttributes
workflowExecutionTimedOutEventAttributes
• Optional workflowExecutionTimedOutEventAttributes: null | $Properties
HistoryEvent workflowExecutionTimedOutEventAttributes
Inherited from
$Properties.workflowExecutionTimedOutEventAttributes
workflowExecutionUnpausedEventAttributes
• Optional workflowExecutionUnpausedEventAttributes: null | $Properties
HistoryEvent workflowExecutionUnpausedEventAttributes
Inherited from
$Properties.workflowExecutionUnpausedEventAttributes
workflowExecutionUpdateAcceptedEventAttributes
• Optional workflowExecutionUpdateAcceptedEventAttributes: null | $Properties
HistoryEvent workflowExecutionUpdateAcceptedEventAttributes
Inherited from
$Properties.workflowExecutionUpdateAcceptedEventAttributes
workflowExecutionUpdateAdmittedEventAttributes
• Optional workflowExecutionUpdateAdmittedEventAttributes: null | $Properties
HistoryEvent workflowExecutionUpdateAdmittedEventAttributes
Inherited from
$Properties.workflowExecutionUpdateAdmittedEventAttributes
workflowExecutionUpdateCompletedEventAttributes
• Optional workflowExecutionUpdateCompletedEventAttributes: null | $Properties
HistoryEvent workflowExecutionUpdateCompletedEventAttributes
Inherited from
$Properties.workflowExecutionUpdateCompletedEventAttributes
workflowExecutionUpdateRejectedEventAttributes
• Optional workflowExecutionUpdateRejectedEventAttributes: null | $Properties
HistoryEvent workflowExecutionUpdateRejectedEventAttributes
Inherited from
$Properties.workflowExecutionUpdateRejectedEventAttributes
workflowPropertiesModifiedEventAttributes
• Optional workflowPropertiesModifiedEventAttributes: null | $Properties
HistoryEvent workflowPropertiesModifiedEventAttributes
Inherited from
$Properties.workflowPropertiesModifiedEventAttributes
workflowPropertiesModifiedExternallyEventAttributes
• Optional workflowPropertiesModifiedExternallyEventAttributes: null | $Properties
HistoryEvent workflowPropertiesModifiedExternallyEventAttributes
Inherited from
$Properties.workflowPropertiesModifiedExternallyEventAttributes
workflowTaskCompletedEventAttributes
• Optional workflowTaskCompletedEventAttributes: null | $Properties
HistoryEvent workflowTaskCompletedEventAttributes
Inherited from
$Properties.workflowTaskCompletedEventAttributes
workflowTaskFailedEventAttributes
• Optional workflowTaskFailedEventAttributes: null | $Properties
HistoryEvent workflowTaskFailedEventAttributes
Inherited from
$Properties.workflowTaskFailedEventAttributes
workflowTaskScheduledEventAttributes
• Optional workflowTaskScheduledEventAttributes: null | $Properties
HistoryEvent workflowTaskScheduledEventAttributes
Inherited from
$Properties.workflowTaskScheduledEventAttributes
workflowTaskStartedEventAttributes
• Optional workflowTaskStartedEventAttributes: null | $Properties
HistoryEvent workflowTaskStartedEventAttributes
Inherited from
$Properties.workflowTaskStartedEventAttributes
workflowTaskTimedOutEventAttributes
• Optional workflowTaskTimedOutEventAttributes: null | $Properties
HistoryEvent workflowTaskTimedOutEventAttributes