Class HistoryEvent
History events are the method by which Temporal SDKs advance (or recreate) workflow state.
See the EventType
enum for more info about what each event is for.
Implements
Google.Protobuf.IBufferMessage
Assembly: Temporalio.dll
Syntax
public sealed class HistoryEvent : Google.Protobuf.IMessage<HistoryEvent>, Google.Protobuf.IBufferMessage
Constructors
HistoryEvent()
Declaration
HistoryEvent(HistoryEvent)
Declaration
public HistoryEvent(HistoryEvent other)
Parameters
Fields
ActivityPropertiesModifiedExternallyEventAttributesFieldNumber
Field number for the "activity_properties_modified_externally_event_attributes" field.
Declaration
public const int ActivityPropertiesModifiedExternallyEventAttributesFieldNumber = null
Field Value
ActivityTaskCanceledEventAttributesFieldNumber
Field number for the "activity_task_canceled_event_attributes" field.
Declaration
public const int ActivityTaskCanceledEventAttributesFieldNumber = null
Field Value
ActivityTaskCancelRequestedEventAttributesFieldNumber
Field number for the "activity_task_cancel_requested_event_attributes" field.
Declaration
public const int ActivityTaskCancelRequestedEventAttributesFieldNumber = null
Field Value
ActivityTaskCompletedEventAttributesFieldNumber
Field number for the "activity_task_completed_event_attributes" field.
Declaration
public const int ActivityTaskCompletedEventAttributesFieldNumber = null
Field Value
ActivityTaskFailedEventAttributesFieldNumber
Field number for the "activity_task_failed_event_attributes" field.
Declaration
public const int ActivityTaskFailedEventAttributesFieldNumber = null
Field Value
ActivityTaskScheduledEventAttributesFieldNumber
Field number for the "activity_task_scheduled_event_attributes" field.
Declaration
public const int ActivityTaskScheduledEventAttributesFieldNumber = null
Field Value
ActivityTaskStartedEventAttributesFieldNumber
Field number for the "activity_task_started_event_attributes" field.
Declaration
public const int ActivityTaskStartedEventAttributesFieldNumber = null
Field Value
ActivityTaskTimedOutEventAttributesFieldNumber
Field number for the "activity_task_timed_out_event_attributes" field.
Declaration
public const int ActivityTaskTimedOutEventAttributesFieldNumber = null
Field Value
ChildWorkflowExecutionCanceledEventAttributesFieldNumber
Field number for the "child_workflow_execution_canceled_event_attributes" field.
Declaration
public const int ChildWorkflowExecutionCanceledEventAttributesFieldNumber = null
Field Value
ChildWorkflowExecutionCompletedEventAttributesFieldNumber
Field number for the "child_workflow_execution_completed_event_attributes" field.
Declaration
public const int ChildWorkflowExecutionCompletedEventAttributesFieldNumber = null
Field Value
ChildWorkflowExecutionFailedEventAttributesFieldNumber
Field number for the "child_workflow_execution_failed_event_attributes" field.
Declaration
public const int ChildWorkflowExecutionFailedEventAttributesFieldNumber = null
Field Value
ChildWorkflowExecutionStartedEventAttributesFieldNumber
Field number for the "child_workflow_execution_started_event_attributes" field.
Declaration
public const int ChildWorkflowExecutionStartedEventAttributesFieldNumber = null
Field Value
ChildWorkflowExecutionTerminatedEventAttributesFieldNumber
Field number for the "child_workflow_execution_terminated_event_attributes" field.
Declaration
public const int ChildWorkflowExecutionTerminatedEventAttributesFieldNumber = null
Field Value
ChildWorkflowExecutionTimedOutEventAttributesFieldNumber
Field number for the "child_workflow_execution_timed_out_event_attributes" field.
Declaration
public const int ChildWorkflowExecutionTimedOutEventAttributesFieldNumber = null
Field Value
EventIdFieldNumber
Field number for the "event_id" field.
Declaration
public const int EventIdFieldNumber = null
Field Value
EventTimeFieldNumber
Field number for the "event_time" field.
Declaration
public const int EventTimeFieldNumber = null
Field Value
EventTypeFieldNumber
Field number for the "event_type" field.
Declaration
public const int EventTypeFieldNumber = null
Field Value
ExternalWorkflowExecutionCancelRequestedEventAttributesFieldNumber
Field number for the "external_workflow_execution_cancel_requested_event_attributes" field.
Declaration
public const int ExternalWorkflowExecutionCancelRequestedEventAttributesFieldNumber = null
Field Value
ExternalWorkflowExecutionSignaledEventAttributesFieldNumber
Field number for the "external_workflow_execution_signaled_event_attributes" field.
Declaration
public const int ExternalWorkflowExecutionSignaledEventAttributesFieldNumber = null
Field Value
MarkerRecordedEventAttributesFieldNumber
Field number for the "marker_recorded_event_attributes" field.
Declaration
public const int MarkerRecordedEventAttributesFieldNumber = null
Field Value
RequestCancelExternalWorkflowExecutionFailedEventAttributesFieldNumber
Field number for the "request_cancel_external_workflow_execution_failed_event_attributes" field.
Declaration
public const int RequestCancelExternalWorkflowExecutionFailedEventAttributesFieldNumber = null
Field Value
RequestCancelExternalWorkflowExecutionInitiatedEventAttributesFieldNumber
Field number for the "request_cancel_external_workflow_execution_initiated_event_attributes" field.
Declaration
public const int RequestCancelExternalWorkflowExecutionInitiatedEventAttributesFieldNumber = null
Field Value
SignalExternalWorkflowExecutionFailedEventAttributesFieldNumber
Field number for the "signal_external_workflow_execution_failed_event_attributes" field.
Declaration
public const int SignalExternalWorkflowExecutionFailedEventAttributesFieldNumber = null
Field Value
SignalExternalWorkflowExecutionInitiatedEventAttributesFieldNumber
Field number for the "signal_external_workflow_execution_initiated_event_attributes" field.
Declaration
public const int SignalExternalWorkflowExecutionInitiatedEventAttributesFieldNumber = null
Field Value
StartChildWorkflowExecutionFailedEventAttributesFieldNumber
Field number for the "start_child_workflow_execution_failed_event_attributes" field.
Declaration
public const int StartChildWorkflowExecutionFailedEventAttributesFieldNumber = null
Field Value
StartChildWorkflowExecutionInitiatedEventAttributesFieldNumber
Field number for the "start_child_workflow_execution_initiated_event_attributes" field.
Declaration
public const int StartChildWorkflowExecutionInitiatedEventAttributesFieldNumber = null
Field Value
TaskIdFieldNumber
Field number for the "task_id" field.
Declaration
public const int TaskIdFieldNumber = null
Field Value
TimerCanceledEventAttributesFieldNumber
Field number for the "timer_canceled_event_attributes" field.
Declaration
public const int TimerCanceledEventAttributesFieldNumber = null
Field Value
TimerFiredEventAttributesFieldNumber
Field number for the "timer_fired_event_attributes" field.
Declaration
public const int TimerFiredEventAttributesFieldNumber = null
Field Value
TimerStartedEventAttributesFieldNumber
Field number for the "timer_started_event_attributes" field.
Declaration
public const int TimerStartedEventAttributesFieldNumber = null
Field Value
UpsertWorkflowSearchAttributesEventAttributesFieldNumber
Field number for the "upsert_workflow_search_attributes_event_attributes" field.
Declaration
public const int UpsertWorkflowSearchAttributesEventAttributesFieldNumber = null
Field Value
VersionFieldNumber
Field number for the "version" field.
Declaration
public const int VersionFieldNumber = null
Field Value
WorkerMayIgnoreFieldNumber
Field number for the "worker_may_ignore" field.
Declaration
public const int WorkerMayIgnoreFieldNumber = null
Field Value
WorkflowExecutionCanceledEventAttributesFieldNumber
Field number for the "workflow_execution_canceled_event_attributes" field.
Declaration
public const int WorkflowExecutionCanceledEventAttributesFieldNumber = null
Field Value
WorkflowExecutionCancelRequestedEventAttributesFieldNumber
Field number for the "workflow_execution_cancel_requested_event_attributes" field.
Declaration
public const int WorkflowExecutionCancelRequestedEventAttributesFieldNumber = null
Field Value
WorkflowExecutionCompletedEventAttributesFieldNumber
Field number for the "workflow_execution_completed_event_attributes" field.
Declaration
public const int WorkflowExecutionCompletedEventAttributesFieldNumber = null
Field Value
WorkflowExecutionContinuedAsNewEventAttributesFieldNumber
Field number for the "workflow_execution_continued_as_new_event_attributes" field.
Declaration
public const int WorkflowExecutionContinuedAsNewEventAttributesFieldNumber = null
Field Value
WorkflowExecutionFailedEventAttributesFieldNumber
Field number for the "workflow_execution_failed_event_attributes" field.
Declaration
public const int WorkflowExecutionFailedEventAttributesFieldNumber = null
Field Value
WorkflowExecutionSignaledEventAttributesFieldNumber
Field number for the "workflow_execution_signaled_event_attributes" field.
Declaration
public const int WorkflowExecutionSignaledEventAttributesFieldNumber = null
Field Value
WorkflowExecutionStartedEventAttributesFieldNumber
Field number for the "workflow_execution_started_event_attributes" field.
Declaration
public const int WorkflowExecutionStartedEventAttributesFieldNumber = null
Field Value
WorkflowExecutionTerminatedEventAttributesFieldNumber
Field number for the "workflow_execution_terminated_event_attributes" field.
Declaration
public const int WorkflowExecutionTerminatedEventAttributesFieldNumber = null
Field Value
WorkflowExecutionTimedOutEventAttributesFieldNumber
Field number for the "workflow_execution_timed_out_event_attributes" field.
Declaration
public const int WorkflowExecutionTimedOutEventAttributesFieldNumber = null
Field Value
WorkflowPropertiesModifiedEventAttributesFieldNumber
Field number for the "workflow_properties_modified_event_attributes" field.
Declaration
public const int WorkflowPropertiesModifiedEventAttributesFieldNumber = null
Field Value
WorkflowPropertiesModifiedExternallyEventAttributesFieldNumber
Field number for the "workflow_properties_modified_externally_event_attributes" field.
Declaration
public const int WorkflowPropertiesModifiedExternallyEventAttributesFieldNumber = null
Field Value
WorkflowTaskCompletedEventAttributesFieldNumber
Field number for the "workflow_task_completed_event_attributes" field.
Declaration
public const int WorkflowTaskCompletedEventAttributesFieldNumber = null
Field Value
WorkflowTaskFailedEventAttributesFieldNumber
Field number for the "workflow_task_failed_event_attributes" field.
Declaration
public const int WorkflowTaskFailedEventAttributesFieldNumber = null
Field Value
WorkflowTaskScheduledEventAttributesFieldNumber
Field number for the "workflow_task_scheduled_event_attributes" field.
Declaration
public const int WorkflowTaskScheduledEventAttributesFieldNumber = null
Field Value
WorkflowTaskStartedEventAttributesFieldNumber
Field number for the "workflow_task_started_event_attributes" field.
Declaration
public const int WorkflowTaskStartedEventAttributesFieldNumber = null
Field Value
WorkflowTaskTimedOutEventAttributesFieldNumber
Field number for the "workflow_task_timed_out_event_attributes" field.
Declaration
public const int WorkflowTaskTimedOutEventAttributesFieldNumber = null
Field Value
WorkflowUpdateAcceptedEventAttributesFieldNumber
Field number for the "workflow_update_accepted_event_attributes" field.
Declaration
public const int WorkflowUpdateAcceptedEventAttributesFieldNumber = null
Field Value
WorkflowUpdateCompletedEventAttributesFieldNumber
Field number for the "workflow_update_completed_event_attributes" field.
Declaration
public const int WorkflowUpdateCompletedEventAttributesFieldNumber = null
Field Value
WorkflowUpdateRejectedEventAttributesFieldNumber
Field number for the "workflow_update_rejected_event_attributes" field.
Declaration
public const int WorkflowUpdateRejectedEventAttributesFieldNumber = null
Field Value
Properties
ActivityPropertiesModifiedExternallyEventAttributes
Declaration
public ActivityPropertiesModifiedExternallyEventAttributes ActivityPropertiesModifiedExternallyEventAttributes { get; set; }
Property Value
ActivityTaskCanceledEventAttributes
Declaration
public ActivityTaskCanceledEventAttributes ActivityTaskCanceledEventAttributes { get; set; }
Property Value
ActivityTaskCancelRequestedEventAttributes
Declaration
public ActivityTaskCancelRequestedEventAttributes ActivityTaskCancelRequestedEventAttributes { get; set; }
Property Value
ActivityTaskCompletedEventAttributes
Declaration
public ActivityTaskCompletedEventAttributes ActivityTaskCompletedEventAttributes { get; set; }
Property Value
ActivityTaskFailedEventAttributes
Declaration
public ActivityTaskFailedEventAttributes ActivityTaskFailedEventAttributes { get; set; }
Property Value
ActivityTaskScheduledEventAttributes
Declaration
public ActivityTaskScheduledEventAttributes ActivityTaskScheduledEventAttributes { get; set; }
Property Value
ActivityTaskStartedEventAttributes
Declaration
public ActivityTaskStartedEventAttributes ActivityTaskStartedEventAttributes { get; set; }
Property Value
ActivityTaskTimedOutEventAttributes
Declaration
public ActivityTaskTimedOutEventAttributes ActivityTaskTimedOutEventAttributes { get; set; }
Property Value
AttributesCase
Declaration
public HistoryEvent.AttributesOneofCase AttributesCase { get; }
Property Value
ChildWorkflowExecutionCanceledEventAttributes
Declaration
public ChildWorkflowExecutionCanceledEventAttributes ChildWorkflowExecutionCanceledEventAttributes { get; set; }
Property Value
ChildWorkflowExecutionCompletedEventAttributes
Declaration
public ChildWorkflowExecutionCompletedEventAttributes ChildWorkflowExecutionCompletedEventAttributes { get; set; }
Property Value
ChildWorkflowExecutionFailedEventAttributes
Declaration
public ChildWorkflowExecutionFailedEventAttributes ChildWorkflowExecutionFailedEventAttributes { get; set; }
Property Value
ChildWorkflowExecutionStartedEventAttributes
Declaration
public ChildWorkflowExecutionStartedEventAttributes ChildWorkflowExecutionStartedEventAttributes { get; set; }
Property Value
ChildWorkflowExecutionTerminatedEventAttributes
Declaration
public ChildWorkflowExecutionTerminatedEventAttributes ChildWorkflowExecutionTerminatedEventAttributes { get; set; }
Property Value
ChildWorkflowExecutionTimedOutEventAttributes
Declaration
public ChildWorkflowExecutionTimedOutEventAttributes ChildWorkflowExecutionTimedOutEventAttributes { get; set; }
Property Value
Descriptor
Declaration
public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
Type |
Description |
Google.Protobuf.Reflection.MessageDescriptor |
|
EventId
Monotonically increasing event number, starts at 1.
Declaration
public long EventId { get; set; }
Property Value
EventTime
Declaration
public Google.Protobuf.WellKnownTypes.Timestamp EventTime { get; set; }
Property Value
Type |
Description |
Google.Protobuf.WellKnownTypes.Timestamp |
|
EventType
Declaration
public EventType EventType { get; set; }
Property Value
ExternalWorkflowExecutionCancelRequestedEventAttributes
Declaration
public ExternalWorkflowExecutionCancelRequestedEventAttributes ExternalWorkflowExecutionCancelRequestedEventAttributes { get; set; }
Property Value
ExternalWorkflowExecutionSignaledEventAttributes
Declaration
public ExternalWorkflowExecutionSignaledEventAttributes ExternalWorkflowExecutionSignaledEventAttributes { get; set; }
Property Value
MarkerRecordedEventAttributes
Declaration
public MarkerRecordedEventAttributes MarkerRecordedEventAttributes { get; set; }
Property Value
Parser
Declaration
public static Google.Protobuf.MessageParser<HistoryEvent> Parser { get; }
Property Value
Type |
Description |
Google.Protobuf.MessageParser<HistoryEvent> |
|
RequestCancelExternalWorkflowExecutionFailedEventAttributes
Declaration
public RequestCancelExternalWorkflowExecutionFailedEventAttributes RequestCancelExternalWorkflowExecutionFailedEventAttributes { get; set; }
Property Value
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Declaration
public RequestCancelExternalWorkflowExecutionInitiatedEventAttributes RequestCancelExternalWorkflowExecutionInitiatedEventAttributes { get; set; }
Property Value
SignalExternalWorkflowExecutionFailedEventAttributes
Declaration
public SignalExternalWorkflowExecutionFailedEventAttributes SignalExternalWorkflowExecutionFailedEventAttributes { get; set; }
Property Value
SignalExternalWorkflowExecutionInitiatedEventAttributes
Declaration
public SignalExternalWorkflowExecutionInitiatedEventAttributes SignalExternalWorkflowExecutionInitiatedEventAttributes { get; set; }
Property Value
StartChildWorkflowExecutionFailedEventAttributes
Declaration
public StartChildWorkflowExecutionFailedEventAttributes StartChildWorkflowExecutionFailedEventAttributes { get; set; }
Property Value
StartChildWorkflowExecutionInitiatedEventAttributes
Declaration
public StartChildWorkflowExecutionInitiatedEventAttributes StartChildWorkflowExecutionInitiatedEventAttributes { get; set; }
Property Value
TaskId
TODO: What is this? Appears unused by SDKs
Declaration
public long TaskId { get; set; }
Property Value
TimerCanceledEventAttributes
Declaration
public TimerCanceledEventAttributes TimerCanceledEventAttributes { get; set; }
Property Value
TimerFiredEventAttributes
Declaration
public TimerFiredEventAttributes TimerFiredEventAttributes { get; set; }
Property Value
TimerStartedEventAttributes
Declaration
public TimerStartedEventAttributes TimerStartedEventAttributes { get; set; }
Property Value
UpsertWorkflowSearchAttributesEventAttributes
Declaration
public UpsertWorkflowSearchAttributesEventAttributes UpsertWorkflowSearchAttributesEventAttributes { get; set; }
Property Value
Version
TODO: What is this? Appears unused by SDKs
Declaration
public long Version { get; set; }
Property Value
WorkerMayIgnore
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.
Declaration
public bool WorkerMayIgnore { get; set; }
Property Value
WorkflowExecutionCanceledEventAttributes
Declaration
public WorkflowExecutionCanceledEventAttributes WorkflowExecutionCanceledEventAttributes { get; set; }
Property Value
WorkflowExecutionCancelRequestedEventAttributes
Declaration
public WorkflowExecutionCancelRequestedEventAttributes WorkflowExecutionCancelRequestedEventAttributes { get; set; }
Property Value
WorkflowExecutionCompletedEventAttributes
Declaration
public WorkflowExecutionCompletedEventAttributes WorkflowExecutionCompletedEventAttributes { get; set; }
Property Value
WorkflowExecutionContinuedAsNewEventAttributes
Declaration
public WorkflowExecutionContinuedAsNewEventAttributes WorkflowExecutionContinuedAsNewEventAttributes { get; set; }
Property Value
WorkflowExecutionFailedEventAttributes
Declaration
public WorkflowExecutionFailedEventAttributes WorkflowExecutionFailedEventAttributes { get; set; }
Property Value
WorkflowExecutionSignaledEventAttributes
Declaration
public WorkflowExecutionSignaledEventAttributes WorkflowExecutionSignaledEventAttributes { get; set; }
Property Value
WorkflowExecutionStartedEventAttributes
Declaration
public WorkflowExecutionStartedEventAttributes WorkflowExecutionStartedEventAttributes { get; set; }
Property Value
WorkflowExecutionTerminatedEventAttributes
Declaration
public WorkflowExecutionTerminatedEventAttributes WorkflowExecutionTerminatedEventAttributes { get; set; }
Property Value
WorkflowExecutionTimedOutEventAttributes
Declaration
public WorkflowExecutionTimedOutEventAttributes WorkflowExecutionTimedOutEventAttributes { get; set; }
Property Value
WorkflowPropertiesModifiedEventAttributes
Declaration
public WorkflowPropertiesModifiedEventAttributes WorkflowPropertiesModifiedEventAttributes { get; set; }
Property Value
WorkflowPropertiesModifiedExternallyEventAttributes
Declaration
public WorkflowPropertiesModifiedExternallyEventAttributes WorkflowPropertiesModifiedExternallyEventAttributes { get; set; }
Property Value
WorkflowTaskCompletedEventAttributes
Declaration
public WorkflowTaskCompletedEventAttributes WorkflowTaskCompletedEventAttributes { get; set; }
Property Value
WorkflowTaskFailedEventAttributes
Declaration
public WorkflowTaskFailedEventAttributes WorkflowTaskFailedEventAttributes { get; set; }
Property Value
WorkflowTaskScheduledEventAttributes
Declaration
public WorkflowTaskScheduledEventAttributes WorkflowTaskScheduledEventAttributes { get; set; }
Property Value
WorkflowTaskStartedEventAttributes
Declaration
public WorkflowTaskStartedEventAttributes WorkflowTaskStartedEventAttributes { get; set; }
Property Value
WorkflowTaskTimedOutEventAttributes
Declaration
public WorkflowTaskTimedOutEventAttributes WorkflowTaskTimedOutEventAttributes { get; set; }
Property Value
WorkflowUpdateAcceptedEventAttributes
Declaration
public WorkflowUpdateAcceptedEventAttributes WorkflowUpdateAcceptedEventAttributes { get; set; }
Property Value
WorkflowUpdateCompletedEventAttributes
Declaration
public WorkflowUpdateCompletedEventAttributes WorkflowUpdateCompletedEventAttributes { get; set; }
Property Value
WorkflowUpdateRejectedEventAttributes
Declaration
public WorkflowUpdateRejectedEventAttributes WorkflowUpdateRejectedEventAttributes { get; set; }
Property Value
Methods
CalculateSize()
Declaration
public int CalculateSize()
Returns
ClearAttributes()
Declaration
public void ClearAttributes()
Clone()
Declaration
public HistoryEvent Clone()
Returns
Equals(Object)
Declaration
public override bool Equals(object other)
Parameters
Type |
Name |
Description |
Object |
other |
|
Returns
Equals(HistoryEvent)
Declaration
public bool Equals(HistoryEvent other)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
MergeFrom(Google.Protobuf.CodedInputStream)
Declaration
public void MergeFrom(Google.Protobuf.CodedInputStream input)
Parameters
Type |
Name |
Description |
Google.Protobuf.CodedInputStream |
input |
|
MergeFrom(HistoryEvent)
Declaration
public void MergeFrom(HistoryEvent other)
Parameters
ToString()
Declaration
public override string ToString()
Returns
WriteTo(Google.Protobuf.CodedOutputStream)
Declaration
public void WriteTo(Google.Protobuf.CodedOutputStream output)
Parameters
Type |
Name |
Description |
Google.Protobuf.CodedOutputStream |
output |
|
Implements
Google.Protobuf.IBufferMessage