Skip to main content

Class: HistoryEvent

history.v1.HistoryEvent

Represents a HistoryEvent.

Implements#

Constructors#

constructor#

new HistoryEvent(properties?)

Constructs a new HistoryEvent.

Parameters#

NameType
properties?IHistoryEvent

Properties#

activityTaskCancelRequestedEventAttributes#

Optional activityTaskCancelRequestedEventAttributes: null | IActivityTaskCancelRequestedEventAttributes

HistoryEvent activityTaskCancelRequestedEventAttributes.

Implementation of#

IHistoryEvent.activityTaskCancelRequestedEventAttributes


activityTaskCanceledEventAttributes#

Optional activityTaskCanceledEventAttributes: null | IActivityTaskCanceledEventAttributes

HistoryEvent activityTaskCanceledEventAttributes.

Implementation of#

IHistoryEvent.activityTaskCanceledEventAttributes


activityTaskCompletedEventAttributes#

Optional activityTaskCompletedEventAttributes: null | IActivityTaskCompletedEventAttributes

HistoryEvent activityTaskCompletedEventAttributes.

Implementation of#

IHistoryEvent.activityTaskCompletedEventAttributes


activityTaskFailedEventAttributes#

Optional activityTaskFailedEventAttributes: null | IActivityTaskFailedEventAttributes

HistoryEvent activityTaskFailedEventAttributes.

Implementation of#

IHistoryEvent.activityTaskFailedEventAttributes


activityTaskScheduledEventAttributes#

Optional activityTaskScheduledEventAttributes: null | IActivityTaskScheduledEventAttributes

HistoryEvent activityTaskScheduledEventAttributes.

Implementation of#

IHistoryEvent.activityTaskScheduledEventAttributes


activityTaskStartedEventAttributes#

Optional activityTaskStartedEventAttributes: null | IActivityTaskStartedEventAttributes

HistoryEvent activityTaskStartedEventAttributes.

Implementation of#

IHistoryEvent.activityTaskStartedEventAttributes


activityTaskTimedOutEventAttributes#

Optional activityTaskTimedOutEventAttributes: null | IActivityTaskTimedOutEventAttributes

HistoryEvent activityTaskTimedOutEventAttributes.

Implementation of#

IHistoryEvent.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"

HistoryEvent attributes.


childWorkflowExecutionCanceledEventAttributes#

Optional childWorkflowExecutionCanceledEventAttributes: null | IChildWorkflowExecutionCanceledEventAttributes

HistoryEvent childWorkflowExecutionCanceledEventAttributes.

Implementation of#

IHistoryEvent.childWorkflowExecutionCanceledEventAttributes


childWorkflowExecutionCompletedEventAttributes#

Optional childWorkflowExecutionCompletedEventAttributes: null | IChildWorkflowExecutionCompletedEventAttributes

HistoryEvent childWorkflowExecutionCompletedEventAttributes.

Implementation of#

IHistoryEvent.childWorkflowExecutionCompletedEventAttributes


childWorkflowExecutionFailedEventAttributes#

Optional childWorkflowExecutionFailedEventAttributes: null | IChildWorkflowExecutionFailedEventAttributes

HistoryEvent childWorkflowExecutionFailedEventAttributes.

Implementation of#

IHistoryEvent.childWorkflowExecutionFailedEventAttributes


childWorkflowExecutionStartedEventAttributes#

Optional childWorkflowExecutionStartedEventAttributes: null | IChildWorkflowExecutionStartedEventAttributes

HistoryEvent childWorkflowExecutionStartedEventAttributes.

Implementation of#

IHistoryEvent.childWorkflowExecutionStartedEventAttributes


childWorkflowExecutionTerminatedEventAttributes#

Optional childWorkflowExecutionTerminatedEventAttributes: null | IChildWorkflowExecutionTerminatedEventAttributes

HistoryEvent childWorkflowExecutionTerminatedEventAttributes.

Implementation of#

IHistoryEvent.childWorkflowExecutionTerminatedEventAttributes


childWorkflowExecutionTimedOutEventAttributes#

Optional childWorkflowExecutionTimedOutEventAttributes: null | IChildWorkflowExecutionTimedOutEventAttributes

HistoryEvent childWorkflowExecutionTimedOutEventAttributes.

Implementation of#

IHistoryEvent.childWorkflowExecutionTimedOutEventAttributes


eventId#

eventId: Long

HistoryEvent eventId.

Implementation of#

IHistoryEvent.eventId


eventTime#

Optional eventTime: null | ITimestamp

HistoryEvent eventTime.

Implementation of#

IHistoryEvent.eventTime


eventType#

eventType: EventType

HistoryEvent eventType.

Implementation of#

IHistoryEvent.eventType


externalWorkflowExecutionCancelRequestedEventAttributes#

Optional externalWorkflowExecutionCancelRequestedEventAttributes: null | IExternalWorkflowExecutionCancelRequestedEventAttributes

HistoryEvent externalWorkflowExecutionCancelRequestedEventAttributes.

Implementation of#

IHistoryEvent.externalWorkflowExecutionCancelRequestedEventAttributes


externalWorkflowExecutionSignaledEventAttributes#

Optional externalWorkflowExecutionSignaledEventAttributes: null | IExternalWorkflowExecutionSignaledEventAttributes

HistoryEvent externalWorkflowExecutionSignaledEventAttributes.

Implementation of#

IHistoryEvent.externalWorkflowExecutionSignaledEventAttributes


markerRecordedEventAttributes#

Optional markerRecordedEventAttributes: null | IMarkerRecordedEventAttributes

HistoryEvent markerRecordedEventAttributes.

Implementation of#

IHistoryEvent.markerRecordedEventAttributes


requestCancelExternalWorkflowExecutionFailedEventAttributes#

Optional requestCancelExternalWorkflowExecutionFailedEventAttributes: null | IRequestCancelExternalWorkflowExecutionFailedEventAttributes

HistoryEvent requestCancelExternalWorkflowExecutionFailedEventAttributes.

Implementation of#

IHistoryEvent.requestCancelExternalWorkflowExecutionFailedEventAttributes


requestCancelExternalWorkflowExecutionInitiatedEventAttributes#

Optional requestCancelExternalWorkflowExecutionInitiatedEventAttributes: null | IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes

HistoryEvent requestCancelExternalWorkflowExecutionInitiatedEventAttributes.

Implementation of#

IHistoryEvent.requestCancelExternalWorkflowExecutionInitiatedEventAttributes


signalExternalWorkflowExecutionFailedEventAttributes#

Optional signalExternalWorkflowExecutionFailedEventAttributes: null | ISignalExternalWorkflowExecutionFailedEventAttributes

HistoryEvent signalExternalWorkflowExecutionFailedEventAttributes.

Implementation of#

IHistoryEvent.signalExternalWorkflowExecutionFailedEventAttributes


signalExternalWorkflowExecutionInitiatedEventAttributes#

Optional signalExternalWorkflowExecutionInitiatedEventAttributes: null | ISignalExternalWorkflowExecutionInitiatedEventAttributes

HistoryEvent signalExternalWorkflowExecutionInitiatedEventAttributes.

Implementation of#

IHistoryEvent.signalExternalWorkflowExecutionInitiatedEventAttributes


startChildWorkflowExecutionFailedEventAttributes#

Optional startChildWorkflowExecutionFailedEventAttributes: null | IStartChildWorkflowExecutionFailedEventAttributes

HistoryEvent startChildWorkflowExecutionFailedEventAttributes.

Implementation of#

IHistoryEvent.startChildWorkflowExecutionFailedEventAttributes


startChildWorkflowExecutionInitiatedEventAttributes#

Optional startChildWorkflowExecutionInitiatedEventAttributes: null | IStartChildWorkflowExecutionInitiatedEventAttributes

HistoryEvent startChildWorkflowExecutionInitiatedEventAttributes.

Implementation of#

IHistoryEvent.startChildWorkflowExecutionInitiatedEventAttributes


taskId#

taskId: Long

HistoryEvent taskId.

Implementation of#

IHistoryEvent.taskId


timerCanceledEventAttributes#

Optional timerCanceledEventAttributes: null | ITimerCanceledEventAttributes

HistoryEvent timerCanceledEventAttributes.

Implementation of#

IHistoryEvent.timerCanceledEventAttributes


timerFiredEventAttributes#

Optional timerFiredEventAttributes: null | ITimerFiredEventAttributes

HistoryEvent timerFiredEventAttributes.

Implementation of#

IHistoryEvent.timerFiredEventAttributes


timerStartedEventAttributes#

Optional timerStartedEventAttributes: null | ITimerStartedEventAttributes

HistoryEvent timerStartedEventAttributes.

Implementation of#

IHistoryEvent.timerStartedEventAttributes


upsertWorkflowSearchAttributesEventAttributes#

Optional upsertWorkflowSearchAttributesEventAttributes: null | IUpsertWorkflowSearchAttributesEventAttributes

HistoryEvent upsertWorkflowSearchAttributesEventAttributes.

Implementation of#

IHistoryEvent.upsertWorkflowSearchAttributesEventAttributes


version#

version: Long

HistoryEvent version.

Implementation of#

IHistoryEvent.version


workflowExecutionCancelRequestedEventAttributes#

Optional workflowExecutionCancelRequestedEventAttributes: null | IWorkflowExecutionCancelRequestedEventAttributes

HistoryEvent workflowExecutionCancelRequestedEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionCancelRequestedEventAttributes


workflowExecutionCanceledEventAttributes#

Optional workflowExecutionCanceledEventAttributes: null | IWorkflowExecutionCanceledEventAttributes

HistoryEvent workflowExecutionCanceledEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionCanceledEventAttributes


workflowExecutionCompletedEventAttributes#

Optional workflowExecutionCompletedEventAttributes: null | IWorkflowExecutionCompletedEventAttributes

HistoryEvent workflowExecutionCompletedEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionCompletedEventAttributes


workflowExecutionContinuedAsNewEventAttributes#

Optional workflowExecutionContinuedAsNewEventAttributes: null | IWorkflowExecutionContinuedAsNewEventAttributes

HistoryEvent workflowExecutionContinuedAsNewEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionContinuedAsNewEventAttributes


workflowExecutionFailedEventAttributes#

Optional workflowExecutionFailedEventAttributes: null | IWorkflowExecutionFailedEventAttributes

HistoryEvent workflowExecutionFailedEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionFailedEventAttributes


workflowExecutionSignaledEventAttributes#

Optional workflowExecutionSignaledEventAttributes: null | IWorkflowExecutionSignaledEventAttributes

HistoryEvent workflowExecutionSignaledEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionSignaledEventAttributes


workflowExecutionStartedEventAttributes#

Optional workflowExecutionStartedEventAttributes: null | IWorkflowExecutionStartedEventAttributes

HistoryEvent workflowExecutionStartedEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionStartedEventAttributes


workflowExecutionTerminatedEventAttributes#

Optional workflowExecutionTerminatedEventAttributes: null | IWorkflowExecutionTerminatedEventAttributes

HistoryEvent workflowExecutionTerminatedEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionTerminatedEventAttributes


workflowExecutionTimedOutEventAttributes#

Optional workflowExecutionTimedOutEventAttributes: null | IWorkflowExecutionTimedOutEventAttributes

HistoryEvent workflowExecutionTimedOutEventAttributes.

Implementation of#

IHistoryEvent.workflowExecutionTimedOutEventAttributes


workflowTaskCompletedEventAttributes#

Optional workflowTaskCompletedEventAttributes: null | IWorkflowTaskCompletedEventAttributes

HistoryEvent workflowTaskCompletedEventAttributes.

Implementation of#

IHistoryEvent.workflowTaskCompletedEventAttributes


workflowTaskFailedEventAttributes#

Optional workflowTaskFailedEventAttributes: null | IWorkflowTaskFailedEventAttributes

HistoryEvent workflowTaskFailedEventAttributes.

Implementation of#

IHistoryEvent.workflowTaskFailedEventAttributes


workflowTaskScheduledEventAttributes#

Optional workflowTaskScheduledEventAttributes: null | IWorkflowTaskScheduledEventAttributes

HistoryEvent workflowTaskScheduledEventAttributes.

Implementation of#

IHistoryEvent.workflowTaskScheduledEventAttributes


workflowTaskStartedEventAttributes#

Optional workflowTaskStartedEventAttributes: null | IWorkflowTaskStartedEventAttributes

HistoryEvent workflowTaskStartedEventAttributes.

Implementation of#

IHistoryEvent.workflowTaskStartedEventAttributes


workflowTaskTimedOutEventAttributes#

Optional workflowTaskTimedOutEventAttributes: null | IWorkflowTaskTimedOutEventAttributes

HistoryEvent workflowTaskTimedOutEventAttributes.

Implementation of#

IHistoryEvent.workflowTaskTimedOutEventAttributes

Methods#

toJSON#

toJSON(): Object

Converts this HistoryEvent to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): HistoryEvent

Decodes a HistoryEvent message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

HistoryEvent

HistoryEvent


decodeDelimited#

Static decodeDelimited(reader): HistoryEvent

Decodes a HistoryEvent message from the specified reader or buffer, length delimited.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

HistoryEvent

HistoryEvent


encode#

Static encode(message, writer?): Writer

Encodes the specified HistoryEvent message. Does not implicitly {@link temporal.api.history.v1.HistoryEvent.verify|verify} messages.

Parameters#

NameTypeDescription
messageIHistoryEventHistoryEvent message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified HistoryEvent message, length delimited. Does not implicitly {@link temporal.api.history.v1.HistoryEvent.verify|verify} messages.

Parameters#

NameTypeDescription
messageIHistoryEventHistoryEvent message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): HistoryEvent

Creates a HistoryEvent message from a plain object. Also converts values to their respective internal types.

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

HistoryEvent

HistoryEvent


toObject#

Static toObject(message, options?): Object

Creates a plain object from a HistoryEvent message. Also converts values to other types if specified.

Parameters#

NameTypeDescription
messageHistoryEventHistoryEvent
options?IConversionOptions-

Returns#

Object

Plain object