Skip to main content

Interface: IHistoryEvent

Properties of a HistoryEvent.

Extends​

Properties​

activityPropertiesModifiedExternallyEventAttributes?​

optional activityPropertiesModifiedExternallyEventAttributes?: $Properties | null

HistoryEvent activityPropertiesModifiedExternallyEventAttributes

Inherited from​

$Properties.activityPropertiesModifiedExternallyEventAttributes

activityTaskCanceledEventAttributes?​

optional activityTaskCanceledEventAttributes?: $Properties | null

HistoryEvent activityTaskCanceledEventAttributes

Inherited from​

$Properties.activityTaskCanceledEventAttributes

activityTaskCancelRequestedEventAttributes?​

optional activityTaskCancelRequestedEventAttributes?: $Properties | null

HistoryEvent activityTaskCancelRequestedEventAttributes

Inherited from​

$Properties.activityTaskCancelRequestedEventAttributes

activityTaskCompletedEventAttributes?​

optional activityTaskCompletedEventAttributes?: $Properties | null

HistoryEvent activityTaskCompletedEventAttributes

Inherited from​

$Properties.activityTaskCompletedEventAttributes

activityTaskFailedEventAttributes?​

optional activityTaskFailedEventAttributes?: $Properties | null

HistoryEvent activityTaskFailedEventAttributes

Inherited from​

$Properties.activityTaskFailedEventAttributes

activityTaskScheduledEventAttributes?​

optional activityTaskScheduledEventAttributes?: $Properties | null

HistoryEvent activityTaskScheduledEventAttributes

Inherited from​

$Properties.activityTaskScheduledEventAttributes

activityTaskStartedEventAttributes?​

optional activityTaskStartedEventAttributes?: $Properties | null

HistoryEvent activityTaskStartedEventAttributes

Inherited from​

$Properties.activityTaskStartedEventAttributes

activityTaskTimedOutEventAttributes?​

optional activityTaskTimedOutEventAttributes?: $Properties | null

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​

$Properties.attributes

childWorkflowExecutionCanceledEventAttributes?​

optional childWorkflowExecutionCanceledEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionCanceledEventAttributes

Inherited from​

$Properties.childWorkflowExecutionCanceledEventAttributes

childWorkflowExecutionCompletedEventAttributes?​

optional childWorkflowExecutionCompletedEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionCompletedEventAttributes

Inherited from​

$Properties.childWorkflowExecutionCompletedEventAttributes

childWorkflowExecutionFailedEventAttributes?​

optional childWorkflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionFailedEventAttributes

Inherited from​

$Properties.childWorkflowExecutionFailedEventAttributes

childWorkflowExecutionStartedEventAttributes?​

optional childWorkflowExecutionStartedEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionStartedEventAttributes

Inherited from​

$Properties.childWorkflowExecutionStartedEventAttributes

childWorkflowExecutionTerminatedEventAttributes?​

optional childWorkflowExecutionTerminatedEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionTerminatedEventAttributes

Inherited from​

$Properties.childWorkflowExecutionTerminatedEventAttributes

childWorkflowExecutionTimedOutEventAttributes?​

optional childWorkflowExecutionTimedOutEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionTimedOutEventAttributes

Inherited from​

$Properties.childWorkflowExecutionTimedOutEventAttributes

eventGroupMarkers?​

optional eventGroupMarkers?: $Properties[] | null

Event group markers attached to this event.

Inherited from​

$Properties.eventGroupMarkers

eventId?​

optional eventId?: Long | null

Monotonically increasing event number, starts at 1.

Inherited from​

$Properties.eventId

eventTime?​

optional eventTime?: $Properties | null

HistoryEvent eventTime

Inherited from​

$Properties.eventTime

eventType?​

optional eventType?: EventType | null

HistoryEvent eventType

Inherited from​

$Properties.eventType

externalWorkflowExecutionCancelRequestedEventAttributes?​

optional externalWorkflowExecutionCancelRequestedEventAttributes?: $Properties | null

HistoryEvent externalWorkflowExecutionCancelRequestedEventAttributes

Inherited from​

$Properties.externalWorkflowExecutionCancelRequestedEventAttributes

externalWorkflowExecutionSignaledEventAttributes?​

optional externalWorkflowExecutionSignaledEventAttributes?: $Properties | null

HistoryEvent externalWorkflowExecutionSignaledEventAttributes

Inherited from​

$Properties.externalWorkflowExecutionSignaledEventAttributes

optional links?: $Properties[] | null

Links to related entities, such as the entity that started this event's workflow.

Inherited from​

$Properties.links

markerRecordedEventAttributes?​

optional markerRecordedEventAttributes?: $Properties | null

HistoryEvent markerRecordedEventAttributes

Inherited from​

$Properties.markerRecordedEventAttributes

nexusOperationCanceledEventAttributes?​

optional nexusOperationCanceledEventAttributes?: $Properties | null

HistoryEvent nexusOperationCanceledEventAttributes

Inherited from​

$Properties.nexusOperationCanceledEventAttributes

nexusOperationCancelRequestCompletedEventAttributes?​

optional nexusOperationCancelRequestCompletedEventAttributes?: $Properties | null

HistoryEvent nexusOperationCancelRequestCompletedEventAttributes

Inherited from​

$Properties.nexusOperationCancelRequestCompletedEventAttributes

nexusOperationCancelRequestedEventAttributes?​

optional nexusOperationCancelRequestedEventAttributes?: $Properties | null

HistoryEvent nexusOperationCancelRequestedEventAttributes

Inherited from​

$Properties.nexusOperationCancelRequestedEventAttributes

nexusOperationCancelRequestFailedEventAttributes?​

optional nexusOperationCancelRequestFailedEventAttributes?: $Properties | null

HistoryEvent nexusOperationCancelRequestFailedEventAttributes

Inherited from​

$Properties.nexusOperationCancelRequestFailedEventAttributes

nexusOperationCompletedEventAttributes?​

optional nexusOperationCompletedEventAttributes?: $Properties | null

HistoryEvent nexusOperationCompletedEventAttributes

Inherited from​

$Properties.nexusOperationCompletedEventAttributes

nexusOperationFailedEventAttributes?​

optional nexusOperationFailedEventAttributes?: $Properties | null

HistoryEvent nexusOperationFailedEventAttributes

Inherited from​

$Properties.nexusOperationFailedEventAttributes

nexusOperationScheduledEventAttributes?​

optional nexusOperationScheduledEventAttributes?: $Properties | null

HistoryEvent nexusOperationScheduledEventAttributes

Inherited from​

$Properties.nexusOperationScheduledEventAttributes

nexusOperationStartedEventAttributes?​

optional nexusOperationStartedEventAttributes?: $Properties | null

HistoryEvent nexusOperationStartedEventAttributes

Inherited from​

$Properties.nexusOperationStartedEventAttributes

nexusOperationTimedOutEventAttributes?​

optional nexusOperationTimedOutEventAttributes?: $Properties | null

HistoryEvent nexusOperationTimedOutEventAttributes

Inherited from​

$Properties.nexusOperationTimedOutEventAttributes

principal?​

optional principal?: $Properties | null

Server-computed authenticated caller identity associated with this event.

Inherited from​

$Properties.principal

requestCancelExternalWorkflowExecutionFailedEventAttributes?​

optional requestCancelExternalWorkflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent requestCancelExternalWorkflowExecutionFailedEventAttributes

Inherited from​

$Properties.requestCancelExternalWorkflowExecutionFailedEventAttributes

requestCancelExternalWorkflowExecutionInitiatedEventAttributes?​

optional requestCancelExternalWorkflowExecutionInitiatedEventAttributes?: $Properties | null

HistoryEvent requestCancelExternalWorkflowExecutionInitiatedEventAttributes

Inherited from​

$Properties.requestCancelExternalWorkflowExecutionInitiatedEventAttributes

signalExternalWorkflowExecutionFailedEventAttributes?​

optional signalExternalWorkflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent signalExternalWorkflowExecutionFailedEventAttributes

Inherited from​

$Properties.signalExternalWorkflowExecutionFailedEventAttributes

signalExternalWorkflowExecutionInitiatedEventAttributes?​

optional signalExternalWorkflowExecutionInitiatedEventAttributes?: $Properties | null

HistoryEvent signalExternalWorkflowExecutionInitiatedEventAttributes

Inherited from​

$Properties.signalExternalWorkflowExecutionInitiatedEventAttributes

startChildWorkflowExecutionFailedEventAttributes?​

optional startChildWorkflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent startChildWorkflowExecutionFailedEventAttributes

Inherited from​

$Properties.startChildWorkflowExecutionFailedEventAttributes

startChildWorkflowExecutionInitiatedEventAttributes?​

optional startChildWorkflowExecutionInitiatedEventAttributes?: $Properties | null

HistoryEvent startChildWorkflowExecutionInitiatedEventAttributes

Inherited from​

$Properties.startChildWorkflowExecutionInitiatedEventAttributes

taskId?​

optional taskId?: Long | null

Identifier used by the service to order replication and transfer tasks associated with this event. SDKs generally ignore this field.

Inherited from​

$Properties.taskId

timerCanceledEventAttributes?​

optional timerCanceledEventAttributes?: $Properties | null

HistoryEvent timerCanceledEventAttributes

Inherited from​

$Properties.timerCanceledEventAttributes

timerFiredEventAttributes?​

optional timerFiredEventAttributes?: $Properties | null

HistoryEvent timerFiredEventAttributes

Inherited from​

$Properties.timerFiredEventAttributes

timerStartedEventAttributes?​

optional timerStartedEventAttributes?: $Properties | null

HistoryEvent timerStartedEventAttributes

Inherited from​

$Properties.timerStartedEventAttributes

upsertWorkflowSearchAttributesEventAttributes?​

optional upsertWorkflowSearchAttributesEventAttributes?: $Properties | null

HistoryEvent upsertWorkflowSearchAttributesEventAttributes

Inherited from​

$Properties.upsertWorkflowSearchAttributesEventAttributes

userMetadata?​

optional userMetadata?: $Properties | null

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​

$Properties.userMetadata

version?​

optional version?: Long | null

Failover version of the event, used by the server for multi-cluster replication and history versioning. SDKs generally ignore this field.

Inherited from​

$Properties.version

workerMayIgnore?​

optional workerMayIgnore?: boolean | null

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​

$Properties.workerMayIgnore

workflowExecutionCanceledEventAttributes?​

optional workflowExecutionCanceledEventAttributes?: $Properties | null

HistoryEvent workflowExecutionCanceledEventAttributes

Inherited from​

$Properties.workflowExecutionCanceledEventAttributes

workflowExecutionCancelRequestedEventAttributes?​

optional workflowExecutionCancelRequestedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionCancelRequestedEventAttributes

Inherited from​

$Properties.workflowExecutionCancelRequestedEventAttributes

workflowExecutionCompletedEventAttributes?​

optional workflowExecutionCompletedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionCompletedEventAttributes

Inherited from​

$Properties.workflowExecutionCompletedEventAttributes

workflowExecutionContinuedAsNewEventAttributes?​

optional workflowExecutionContinuedAsNewEventAttributes?: $Properties | null

HistoryEvent workflowExecutionContinuedAsNewEventAttributes

Inherited from​

$Properties.workflowExecutionContinuedAsNewEventAttributes

workflowExecutionFailedEventAttributes?​

optional workflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionFailedEventAttributes

Inherited from​

$Properties.workflowExecutionFailedEventAttributes

workflowExecutionOptionsUpdatedEventAttributes?​

optional workflowExecutionOptionsUpdatedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionOptionsUpdatedEventAttributes

Inherited from​

$Properties.workflowExecutionOptionsUpdatedEventAttributes

workflowExecutionPausedEventAttributes?​

optional workflowExecutionPausedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionPausedEventAttributes

Inherited from​

$Properties.workflowExecutionPausedEventAttributes

workflowExecutionSignaledEventAttributes?​

optional workflowExecutionSignaledEventAttributes?: $Properties | null

HistoryEvent workflowExecutionSignaledEventAttributes

Inherited from​

$Properties.workflowExecutionSignaledEventAttributes

workflowExecutionStartedEventAttributes?​

optional workflowExecutionStartedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionStartedEventAttributes

Inherited from​

$Properties.workflowExecutionStartedEventAttributes

workflowExecutionTerminatedEventAttributes?​

optional workflowExecutionTerminatedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionTerminatedEventAttributes

Inherited from​

$Properties.workflowExecutionTerminatedEventAttributes

workflowExecutionTimedOutEventAttributes?​

optional workflowExecutionTimedOutEventAttributes?: $Properties | null

HistoryEvent workflowExecutionTimedOutEventAttributes

Inherited from​

$Properties.workflowExecutionTimedOutEventAttributes

workflowExecutionTimeSkippingTransitionedEventAttributes?​

optional workflowExecutionTimeSkippingTransitionedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionTimeSkippingTransitionedEventAttributes

Inherited from​

$Properties.workflowExecutionTimeSkippingTransitionedEventAttributes

workflowExecutionUnpausedEventAttributes?​

optional workflowExecutionUnpausedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUnpausedEventAttributes

Inherited from​

$Properties.workflowExecutionUnpausedEventAttributes

workflowExecutionUpdateAcceptedEventAttributes?​

optional workflowExecutionUpdateAcceptedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUpdateAcceptedEventAttributes

Inherited from​

$Properties.workflowExecutionUpdateAcceptedEventAttributes

workflowExecutionUpdateAdmittedEventAttributes?​

optional workflowExecutionUpdateAdmittedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUpdateAdmittedEventAttributes

Inherited from​

$Properties.workflowExecutionUpdateAdmittedEventAttributes

workflowExecutionUpdateCompletedEventAttributes?​

optional workflowExecutionUpdateCompletedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUpdateCompletedEventAttributes

Inherited from​

$Properties.workflowExecutionUpdateCompletedEventAttributes

workflowExecutionUpdateRejectedEventAttributes?​

optional workflowExecutionUpdateRejectedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUpdateRejectedEventAttributes

Inherited from​

$Properties.workflowExecutionUpdateRejectedEventAttributes

workflowPropertiesModifiedEventAttributes?​

optional workflowPropertiesModifiedEventAttributes?: $Properties | null

HistoryEvent workflowPropertiesModifiedEventAttributes

Inherited from​

$Properties.workflowPropertiesModifiedEventAttributes

workflowPropertiesModifiedExternallyEventAttributes?​

optional workflowPropertiesModifiedExternallyEventAttributes?: $Properties | null

HistoryEvent workflowPropertiesModifiedExternallyEventAttributes

Inherited from​

$Properties.workflowPropertiesModifiedExternallyEventAttributes

workflowTaskCompletedEventAttributes?​

optional workflowTaskCompletedEventAttributes?: $Properties | null

HistoryEvent workflowTaskCompletedEventAttributes

Inherited from​

$Properties.workflowTaskCompletedEventAttributes

workflowTaskFailedEventAttributes?​

optional workflowTaskFailedEventAttributes?: $Properties | null

HistoryEvent workflowTaskFailedEventAttributes

Inherited from​

$Properties.workflowTaskFailedEventAttributes

workflowTaskScheduledEventAttributes?​

optional workflowTaskScheduledEventAttributes?: $Properties | null

HistoryEvent workflowTaskScheduledEventAttributes

Inherited from​

$Properties.workflowTaskScheduledEventAttributes

workflowTaskStartedEventAttributes?​

optional workflowTaskStartedEventAttributes?: $Properties | null

HistoryEvent workflowTaskStartedEventAttributes

Inherited from​

$Properties.workflowTaskStartedEventAttributes

workflowTaskTimedOutEventAttributes?​

optional workflowTaskTimedOutEventAttributes?: $Properties | null

HistoryEvent workflowTaskTimedOutEventAttributes

Inherited from​

$Properties.workflowTaskTimedOutEventAttributes