Skip to main content

Class: WorkflowExecutionTimeSkippingTransitionedEventAttributes

history.v1.WorkflowExecutionTimeSkippingTransitionedEventAttributes

Attributes for an event indicating that time skipping state changed for a workflow execution: either time was advanced, or time skipping was stopped automatically due to the fast_forward completing. The worker_may_ignore field in HistoryEvent should always be set true for this event.

Properties​

disabledAfterFastForward​

• disabledAfterFastForward: boolean

When true, time skipping has been stopped automatically due to a call to fast_forward completing. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "after" is used to indicate temporal ordering. --)


targetTime​

• Optional targetTime: null | $Properties

The virtual time point that time skipping advanced to.


wallClockTime​

• Optional wallClockTime: null | $Properties

The wall-clock time when the time-skipping state changed event was generated.

Methods​

toJSON​

▸ toJSON(): Object

Converts this WorkflowExecutionTimeSkippingTransitionedEventAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): WorkflowExecutionTimeSkippingTransitionedEventAttributes & $Properties

Creates a new WorkflowExecutionTimeSkippingTransitionedEventAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

WorkflowExecutionTimeSkippingTransitionedEventAttributes & $Properties

WorkflowExecutionTimeSkippingTransitionedEventAttributes instance

▸ create(properties?): WorkflowExecutionTimeSkippingTransitionedEventAttributes

Parameters​

NameType
properties?$Properties

Returns​

WorkflowExecutionTimeSkippingTransitionedEventAttributes


decode​

▸ decode(reader, length?): WorkflowExecutionTimeSkippingTransitionedEventAttributes & $Properties

Decodes a WorkflowExecutionTimeSkippingTransitionedEventAttributes message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

WorkflowExecutionTimeSkippingTransitionedEventAttributes & $Properties

WorkflowExecutionTimeSkippingTransitionedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): WorkflowExecutionTimeSkippingTransitionedEventAttributes & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

WorkflowExecutionTimeSkippingTransitionedEventAttributes & $Properties

WorkflowExecutionTimeSkippingTransitionedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode​

▸ encode(message, writer?): Writer

Encodes the specified WorkflowExecutionTimeSkippingTransitionedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionTimeSkippingTransitionedEventAttributes.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesWorkflowExecutionTimeSkippingTransitionedEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified WorkflowExecutionTimeSkippingTransitionedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionTimeSkippingTransitionedEventAttributes.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesWorkflowExecutionTimeSkippingTransitionedEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): WorkflowExecutionTimeSkippingTransitionedEventAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

WorkflowExecutionTimeSkippingTransitionedEventAttributes

WorkflowExecutionTimeSkippingTransitionedEventAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageWorkflowExecutionTimeSkippingTransitionedEventAttributesWorkflowExecutionTimeSkippingTransitionedEventAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object