Skip to main content

Interface: $Properties

Properties of a HistoryEvent.

Extended by​

Properties​

activityPropertiesModifiedExternallyEventAttributes?​

optional activityPropertiesModifiedExternallyEventAttributes?: $Properties | null

HistoryEvent activityPropertiesModifiedExternallyEventAttributes

activityTaskCanceledEventAttributes?​

optional activityTaskCanceledEventAttributes?: $Properties | null

HistoryEvent activityTaskCanceledEventAttributes

activityTaskCancelRequestedEventAttributes?​

optional activityTaskCancelRequestedEventAttributes?: $Properties | null

HistoryEvent activityTaskCancelRequestedEventAttributes

activityTaskCompletedEventAttributes?​

optional activityTaskCompletedEventAttributes?: $Properties | null

HistoryEvent activityTaskCompletedEventAttributes

activityTaskFailedEventAttributes?​

optional activityTaskFailedEventAttributes?: $Properties | null

HistoryEvent activityTaskFailedEventAttributes

activityTaskScheduledEventAttributes?​

optional activityTaskScheduledEventAttributes?: $Properties | null

HistoryEvent activityTaskScheduledEventAttributes

activityTaskStartedEventAttributes?​

optional activityTaskStartedEventAttributes?: $Properties | null

HistoryEvent activityTaskStartedEventAttributes

activityTaskTimedOutEventAttributes?​

optional activityTaskTimedOutEventAttributes?: $Properties | null

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?: $Properties | null

HistoryEvent childWorkflowExecutionCanceledEventAttributes

childWorkflowExecutionCompletedEventAttributes?​

optional childWorkflowExecutionCompletedEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionCompletedEventAttributes

childWorkflowExecutionFailedEventAttributes?​

optional childWorkflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionFailedEventAttributes

childWorkflowExecutionStartedEventAttributes?​

optional childWorkflowExecutionStartedEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionStartedEventAttributes

childWorkflowExecutionTerminatedEventAttributes?​

optional childWorkflowExecutionTerminatedEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionTerminatedEventAttributes

childWorkflowExecutionTimedOutEventAttributes?​

optional childWorkflowExecutionTimedOutEventAttributes?: $Properties | null

HistoryEvent childWorkflowExecutionTimedOutEventAttributes

eventGroupMarkers?​

optional eventGroupMarkers?: $Properties[] | null

Event group markers attached to this event.

eventId?​

optional eventId?: Long | null

Monotonically increasing event number, starts at 1.

eventTime?​

optional eventTime?: $Properties | null

HistoryEvent eventTime

eventType?​

optional eventType?: EventType | null

HistoryEvent eventType

externalWorkflowExecutionCancelRequestedEventAttributes?​

optional externalWorkflowExecutionCancelRequestedEventAttributes?: $Properties | null

HistoryEvent externalWorkflowExecutionCancelRequestedEventAttributes

externalWorkflowExecutionSignaledEventAttributes?​

optional externalWorkflowExecutionSignaledEventAttributes?: $Properties | null

HistoryEvent externalWorkflowExecutionSignaledEventAttributes

optional links?: $Properties[] | null

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

markerRecordedEventAttributes?​

optional markerRecordedEventAttributes?: $Properties | null

HistoryEvent markerRecordedEventAttributes

nexusOperationCanceledEventAttributes?​

optional nexusOperationCanceledEventAttributes?: $Properties | null

HistoryEvent nexusOperationCanceledEventAttributes

nexusOperationCancelRequestCompletedEventAttributes?​

optional nexusOperationCancelRequestCompletedEventAttributes?: $Properties | null

HistoryEvent nexusOperationCancelRequestCompletedEventAttributes

nexusOperationCancelRequestedEventAttributes?​

optional nexusOperationCancelRequestedEventAttributes?: $Properties | null

HistoryEvent nexusOperationCancelRequestedEventAttributes

nexusOperationCancelRequestFailedEventAttributes?​

optional nexusOperationCancelRequestFailedEventAttributes?: $Properties | null

HistoryEvent nexusOperationCancelRequestFailedEventAttributes

nexusOperationCompletedEventAttributes?​

optional nexusOperationCompletedEventAttributes?: $Properties | null

HistoryEvent nexusOperationCompletedEventAttributes

nexusOperationFailedEventAttributes?​

optional nexusOperationFailedEventAttributes?: $Properties | null

HistoryEvent nexusOperationFailedEventAttributes

nexusOperationScheduledEventAttributes?​

optional nexusOperationScheduledEventAttributes?: $Properties | null

HistoryEvent nexusOperationScheduledEventAttributes

nexusOperationStartedEventAttributes?​

optional nexusOperationStartedEventAttributes?: $Properties | null

HistoryEvent nexusOperationStartedEventAttributes

nexusOperationTimedOutEventAttributes?​

optional nexusOperationTimedOutEventAttributes?: $Properties | null

HistoryEvent nexusOperationTimedOutEventAttributes

principal?​

optional principal?: $Properties | null

Server-computed authenticated caller identity associated with this event.

requestCancelExternalWorkflowExecutionFailedEventAttributes?​

optional requestCancelExternalWorkflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent requestCancelExternalWorkflowExecutionFailedEventAttributes

requestCancelExternalWorkflowExecutionInitiatedEventAttributes?​

optional requestCancelExternalWorkflowExecutionInitiatedEventAttributes?: $Properties | null

HistoryEvent requestCancelExternalWorkflowExecutionInitiatedEventAttributes

signalExternalWorkflowExecutionFailedEventAttributes?​

optional signalExternalWorkflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent signalExternalWorkflowExecutionFailedEventAttributes

signalExternalWorkflowExecutionInitiatedEventAttributes?​

optional signalExternalWorkflowExecutionInitiatedEventAttributes?: $Properties | null

HistoryEvent signalExternalWorkflowExecutionInitiatedEventAttributes

startChildWorkflowExecutionFailedEventAttributes?​

optional startChildWorkflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent startChildWorkflowExecutionFailedEventAttributes

startChildWorkflowExecutionInitiatedEventAttributes?​

optional startChildWorkflowExecutionInitiatedEventAttributes?: $Properties | null

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

timerCanceledEventAttributes?​

optional timerCanceledEventAttributes?: $Properties | null

HistoryEvent timerCanceledEventAttributes

timerFiredEventAttributes?​

optional timerFiredEventAttributes?: $Properties | null

HistoryEvent timerFiredEventAttributes

timerStartedEventAttributes?​

optional timerStartedEventAttributes?: $Properties | null

HistoryEvent timerStartedEventAttributes

upsertWorkflowSearchAttributesEventAttributes?​

optional upsertWorkflowSearchAttributesEventAttributes?: $Properties | null

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

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.

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.

workflowExecutionCanceledEventAttributes?​

optional workflowExecutionCanceledEventAttributes?: $Properties | null

HistoryEvent workflowExecutionCanceledEventAttributes

workflowExecutionCancelRequestedEventAttributes?​

optional workflowExecutionCancelRequestedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionCancelRequestedEventAttributes

workflowExecutionCompletedEventAttributes?​

optional workflowExecutionCompletedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionCompletedEventAttributes

workflowExecutionContinuedAsNewEventAttributes?​

optional workflowExecutionContinuedAsNewEventAttributes?: $Properties | null

HistoryEvent workflowExecutionContinuedAsNewEventAttributes

workflowExecutionFailedEventAttributes?​

optional workflowExecutionFailedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionFailedEventAttributes

workflowExecutionOptionsUpdatedEventAttributes?​

optional workflowExecutionOptionsUpdatedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionOptionsUpdatedEventAttributes

workflowExecutionPausedEventAttributes?​

optional workflowExecutionPausedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionPausedEventAttributes

workflowExecutionSignaledEventAttributes?​

optional workflowExecutionSignaledEventAttributes?: $Properties | null

HistoryEvent workflowExecutionSignaledEventAttributes

workflowExecutionStartedEventAttributes?​

optional workflowExecutionStartedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionStartedEventAttributes

workflowExecutionTerminatedEventAttributes?​

optional workflowExecutionTerminatedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionTerminatedEventAttributes

workflowExecutionTimedOutEventAttributes?​

optional workflowExecutionTimedOutEventAttributes?: $Properties | null

HistoryEvent workflowExecutionTimedOutEventAttributes

workflowExecutionTimeSkippingTransitionedEventAttributes?​

optional workflowExecutionTimeSkippingTransitionedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionTimeSkippingTransitionedEventAttributes

workflowExecutionUnpausedEventAttributes?​

optional workflowExecutionUnpausedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUnpausedEventAttributes

workflowExecutionUpdateAcceptedEventAttributes?​

optional workflowExecutionUpdateAcceptedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUpdateAcceptedEventAttributes

workflowExecutionUpdateAdmittedEventAttributes?​

optional workflowExecutionUpdateAdmittedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUpdateAdmittedEventAttributes

workflowExecutionUpdateCompletedEventAttributes?​

optional workflowExecutionUpdateCompletedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUpdateCompletedEventAttributes

workflowExecutionUpdateRejectedEventAttributes?​

optional workflowExecutionUpdateRejectedEventAttributes?: $Properties | null

HistoryEvent workflowExecutionUpdateRejectedEventAttributes

workflowPropertiesModifiedEventAttributes?​

optional workflowPropertiesModifiedEventAttributes?: $Properties | null

HistoryEvent workflowPropertiesModifiedEventAttributes

workflowPropertiesModifiedExternallyEventAttributes?​

optional workflowPropertiesModifiedExternallyEventAttributes?: $Properties | null

HistoryEvent workflowPropertiesModifiedExternallyEventAttributes

workflowTaskCompletedEventAttributes?​

optional workflowTaskCompletedEventAttributes?: $Properties | null

HistoryEvent workflowTaskCompletedEventAttributes

workflowTaskFailedEventAttributes?​

optional workflowTaskFailedEventAttributes?: $Properties | null

HistoryEvent workflowTaskFailedEventAttributes

workflowTaskScheduledEventAttributes?​

optional workflowTaskScheduledEventAttributes?: $Properties | null

HistoryEvent workflowTaskScheduledEventAttributes

workflowTaskStartedEventAttributes?​

optional workflowTaskStartedEventAttributes?: $Properties | null

HistoryEvent workflowTaskStartedEventAttributes

workflowTaskTimedOutEventAttributes?​

optional workflowTaskTimedOutEventAttributes?: $Properties | null

HistoryEvent workflowTaskTimedOutEventAttributes