Skip to main content

Interface: $Properties

v1.HistoryEvent.$Properties

Properties of a HistoryEvent.

Hierarchy​

Properties​

activityPropertiesModifiedExternallyEventAttributes​

• Optional activityPropertiesModifiedExternallyEventAttributes: null | $Properties

HistoryEvent activityPropertiesModifiedExternallyEventAttributes

activityTaskCancelRequestedEventAttributes​

• Optional activityTaskCancelRequestedEventAttributes: null | $Properties

HistoryEvent activityTaskCancelRequestedEventAttributes

activityTaskCanceledEventAttributes​

• Optional activityTaskCanceledEventAttributes: null | $Properties

HistoryEvent activityTaskCanceledEventAttributes

activityTaskCompletedEventAttributes​

• Optional activityTaskCompletedEventAttributes: null | $Properties

HistoryEvent activityTaskCompletedEventAttributes

activityTaskFailedEventAttributes​

• Optional activityTaskFailedEventAttributes: null | $Properties

HistoryEvent activityTaskFailedEventAttributes

activityTaskScheduledEventAttributes​

• Optional activityTaskScheduledEventAttributes: null | $Properties

HistoryEvent activityTaskScheduledEventAttributes

activityTaskStartedEventAttributes​

• Optional activityTaskStartedEventAttributes: null | $Properties

HistoryEvent activityTaskStartedEventAttributes

activityTaskTimedOutEventAttributes​

• Optional activityTaskTimedOutEventAttributes: null | $Properties

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

childWorkflowExecutionCanceledEventAttributes​

• Optional childWorkflowExecutionCanceledEventAttributes: null | $Properties

HistoryEvent childWorkflowExecutionCanceledEventAttributes

childWorkflowExecutionCompletedEventAttributes​

• Optional childWorkflowExecutionCompletedEventAttributes: null | $Properties

HistoryEvent childWorkflowExecutionCompletedEventAttributes

childWorkflowExecutionFailedEventAttributes​

• Optional childWorkflowExecutionFailedEventAttributes: null | $Properties

HistoryEvent childWorkflowExecutionFailedEventAttributes

childWorkflowExecutionStartedEventAttributes​

• Optional childWorkflowExecutionStartedEventAttributes: null | $Properties

HistoryEvent childWorkflowExecutionStartedEventAttributes

childWorkflowExecutionTerminatedEventAttributes​

• Optional childWorkflowExecutionTerminatedEventAttributes: null | $Properties

HistoryEvent childWorkflowExecutionTerminatedEventAttributes

childWorkflowExecutionTimedOutEventAttributes​

• Optional childWorkflowExecutionTimedOutEventAttributes: null | $Properties

HistoryEvent childWorkflowExecutionTimedOutEventAttributes

eventGroupMarkers​

• Optional eventGroupMarkers: null | $Properties[]

Event group markers attached to this event.

eventId​

• Optional eventId: null | Long

Monotonically increasing event number, starts at 1.

eventTime​

• Optional eventTime: null | $Properties

HistoryEvent eventTime

eventType​

• Optional eventType: null | EventType

HistoryEvent eventType

externalWorkflowExecutionCancelRequestedEventAttributes​

• Optional externalWorkflowExecutionCancelRequestedEventAttributes: null | $Properties

HistoryEvent externalWorkflowExecutionCancelRequestedEventAttributes

externalWorkflowExecutionSignaledEventAttributes​

• Optional externalWorkflowExecutionSignaledEventAttributes: null | $Properties

HistoryEvent externalWorkflowExecutionSignaledEventAttributes

• Optional links: null | $Properties[]

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

markerRecordedEventAttributes​

• Optional markerRecordedEventAttributes: null | $Properties

HistoryEvent markerRecordedEventAttributes

nexusOperationCancelRequestCompletedEventAttributes​

• Optional nexusOperationCancelRequestCompletedEventAttributes: null | $Properties

HistoryEvent nexusOperationCancelRequestCompletedEventAttributes

nexusOperationCancelRequestFailedEventAttributes​

• Optional nexusOperationCancelRequestFailedEventAttributes: null | $Properties

HistoryEvent nexusOperationCancelRequestFailedEventAttributes

nexusOperationCancelRequestedEventAttributes​

• Optional nexusOperationCancelRequestedEventAttributes: null | $Properties

HistoryEvent nexusOperationCancelRequestedEventAttributes

nexusOperationCanceledEventAttributes​

• Optional nexusOperationCanceledEventAttributes: null | $Properties

HistoryEvent nexusOperationCanceledEventAttributes

nexusOperationCompletedEventAttributes​

• Optional nexusOperationCompletedEventAttributes: null | $Properties

HistoryEvent nexusOperationCompletedEventAttributes

nexusOperationFailedEventAttributes​

• Optional nexusOperationFailedEventAttributes: null | $Properties

HistoryEvent nexusOperationFailedEventAttributes

nexusOperationScheduledEventAttributes​

• Optional nexusOperationScheduledEventAttributes: null | $Properties

HistoryEvent nexusOperationScheduledEventAttributes

nexusOperationStartedEventAttributes​

• Optional nexusOperationStartedEventAttributes: null | $Properties

HistoryEvent nexusOperationStartedEventAttributes

nexusOperationTimedOutEventAttributes​

• Optional nexusOperationTimedOutEventAttributes: null | $Properties

HistoryEvent nexusOperationTimedOutEventAttributes

principal​

• Optional principal: null | $Properties

Server-computed authenticated caller identity associated with this event.

requestCancelExternalWorkflowExecutionFailedEventAttributes​

• Optional requestCancelExternalWorkflowExecutionFailedEventAttributes: null | $Properties

HistoryEvent requestCancelExternalWorkflowExecutionFailedEventAttributes

requestCancelExternalWorkflowExecutionInitiatedEventAttributes​

• Optional requestCancelExternalWorkflowExecutionInitiatedEventAttributes: null | $Properties

HistoryEvent requestCancelExternalWorkflowExecutionInitiatedEventAttributes

signalExternalWorkflowExecutionFailedEventAttributes​

• Optional signalExternalWorkflowExecutionFailedEventAttributes: null | $Properties

HistoryEvent signalExternalWorkflowExecutionFailedEventAttributes

signalExternalWorkflowExecutionInitiatedEventAttributes​

• Optional signalExternalWorkflowExecutionInitiatedEventAttributes: null | $Properties

HistoryEvent signalExternalWorkflowExecutionInitiatedEventAttributes

startChildWorkflowExecutionFailedEventAttributes​

• Optional startChildWorkflowExecutionFailedEventAttributes: null | $Properties

HistoryEvent startChildWorkflowExecutionFailedEventAttributes

startChildWorkflowExecutionInitiatedEventAttributes​

• Optional startChildWorkflowExecutionInitiatedEventAttributes: null | $Properties

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

timerCanceledEventAttributes​

• Optional timerCanceledEventAttributes: null | $Properties

HistoryEvent timerCanceledEventAttributes

timerFiredEventAttributes​

• Optional timerFiredEventAttributes: null | $Properties

HistoryEvent timerFiredEventAttributes

timerStartedEventAttributes​

• Optional timerStartedEventAttributes: null | $Properties

HistoryEvent timerStartedEventAttributes

upsertWorkflowSearchAttributesEventAttributes​

• Optional upsertWorkflowSearchAttributesEventAttributes: null | $Properties

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

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.

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 | $Properties

HistoryEvent workflowExecutionCancelRequestedEventAttributes

workflowExecutionCanceledEventAttributes​

• Optional workflowExecutionCanceledEventAttributes: null | $Properties

HistoryEvent workflowExecutionCanceledEventAttributes

workflowExecutionCompletedEventAttributes​

• Optional workflowExecutionCompletedEventAttributes: null | $Properties

HistoryEvent workflowExecutionCompletedEventAttributes

workflowExecutionContinuedAsNewEventAttributes​

• Optional workflowExecutionContinuedAsNewEventAttributes: null | $Properties

HistoryEvent workflowExecutionContinuedAsNewEventAttributes

workflowExecutionFailedEventAttributes​

• Optional workflowExecutionFailedEventAttributes: null | $Properties

HistoryEvent workflowExecutionFailedEventAttributes

workflowExecutionOptionsUpdatedEventAttributes​

• Optional workflowExecutionOptionsUpdatedEventAttributes: null | $Properties

HistoryEvent workflowExecutionOptionsUpdatedEventAttributes

workflowExecutionPausedEventAttributes​

• Optional workflowExecutionPausedEventAttributes: null | $Properties

HistoryEvent workflowExecutionPausedEventAttributes

workflowExecutionSignaledEventAttributes​

• Optional workflowExecutionSignaledEventAttributes: null | $Properties

HistoryEvent workflowExecutionSignaledEventAttributes

workflowExecutionStartedEventAttributes​

• Optional workflowExecutionStartedEventAttributes: null | $Properties

HistoryEvent workflowExecutionStartedEventAttributes

workflowExecutionTerminatedEventAttributes​

• Optional workflowExecutionTerminatedEventAttributes: null | $Properties

HistoryEvent workflowExecutionTerminatedEventAttributes

workflowExecutionTimeSkippingTransitionedEventAttributes​

• Optional workflowExecutionTimeSkippingTransitionedEventAttributes: null | $Properties

HistoryEvent workflowExecutionTimeSkippingTransitionedEventAttributes

workflowExecutionTimedOutEventAttributes​

• Optional workflowExecutionTimedOutEventAttributes: null | $Properties

HistoryEvent workflowExecutionTimedOutEventAttributes

workflowExecutionUnpausedEventAttributes​

• Optional workflowExecutionUnpausedEventAttributes: null | $Properties

HistoryEvent workflowExecutionUnpausedEventAttributes

workflowExecutionUpdateAcceptedEventAttributes​

• Optional workflowExecutionUpdateAcceptedEventAttributes: null | $Properties

HistoryEvent workflowExecutionUpdateAcceptedEventAttributes

workflowExecutionUpdateAdmittedEventAttributes​

• Optional workflowExecutionUpdateAdmittedEventAttributes: null | $Properties

HistoryEvent workflowExecutionUpdateAdmittedEventAttributes

workflowExecutionUpdateCompletedEventAttributes​

• Optional workflowExecutionUpdateCompletedEventAttributes: null | $Properties

HistoryEvent workflowExecutionUpdateCompletedEventAttributes

workflowExecutionUpdateRejectedEventAttributes​

• Optional workflowExecutionUpdateRejectedEventAttributes: null | $Properties

HistoryEvent workflowExecutionUpdateRejectedEventAttributes

workflowPropertiesModifiedEventAttributes​

• Optional workflowPropertiesModifiedEventAttributes: null | $Properties

HistoryEvent workflowPropertiesModifiedEventAttributes

workflowPropertiesModifiedExternallyEventAttributes​

• Optional workflowPropertiesModifiedExternallyEventAttributes: null | $Properties

HistoryEvent workflowPropertiesModifiedExternallyEventAttributes

workflowTaskCompletedEventAttributes​

• Optional workflowTaskCompletedEventAttributes: null | $Properties

HistoryEvent workflowTaskCompletedEventAttributes

workflowTaskFailedEventAttributes​

• Optional workflowTaskFailedEventAttributes: null | $Properties

HistoryEvent workflowTaskFailedEventAttributes

workflowTaskScheduledEventAttributes​

• Optional workflowTaskScheduledEventAttributes: null | $Properties

HistoryEvent workflowTaskScheduledEventAttributes

workflowTaskStartedEventAttributes​

• Optional workflowTaskStartedEventAttributes: null | $Properties

HistoryEvent workflowTaskStartedEventAttributes

workflowTaskTimedOutEventAttributes​

• Optional workflowTaskTimedOutEventAttributes: null | $Properties

HistoryEvent workflowTaskTimedOutEventAttributes