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 disabled automatically due to a bound being reached. The worker_may_ignore field in HistoryEvent should always be set true for this event.

Implements

Constructors

constructor

new WorkflowExecutionTimeSkippingTransitionedEventAttributes(properties?): WorkflowExecutionTimeSkippingTransitionedEventAttributes

Constructs a new WorkflowExecutionTimeSkippingTransitionedEventAttributes.

Parameters

NameTypeDescription
properties?IWorkflowExecutionTimeSkippingTransitionedEventAttributesProperties to set

Returns

WorkflowExecutionTimeSkippingTransitionedEventAttributes

Properties

disabledAfterBound

disabledAfterBound: boolean

when true, time skipping was disabled automatically due to a bound being reached. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "after" is used to indicate temporal ordering. --)

Implementation of

IWorkflowExecutionTimeSkippingTransitionedEventAttributes.disabledAfterBound


targetTime

Optional targetTime: null | ITimestamp

The virtual time after time skipping was applied.

Implementation of

IWorkflowExecutionTimeSkippingTransitionedEventAttributes.targetTime


wallClockTime

Optional wallClockTime: null | ITimestamp

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

Implementation of

IWorkflowExecutionTimeSkippingTransitionedEventAttributes.wallClockTime

Methods

toJSON

toJSON(): Object

Converts this WorkflowExecutionTimeSkippingTransitionedEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): WorkflowExecutionTimeSkippingTransitionedEventAttributes

Creates a new WorkflowExecutionTimeSkippingTransitionedEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowExecutionTimeSkippingTransitionedEventAttributesProperties to set

Returns

WorkflowExecutionTimeSkippingTransitionedEventAttributes

WorkflowExecutionTimeSkippingTransitionedEventAttributes instance


decode

decode(reader, length?): WorkflowExecutionTimeSkippingTransitionedEventAttributes

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

WorkflowExecutionTimeSkippingTransitionedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): WorkflowExecutionTimeSkippingTransitionedEventAttributes

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkflowExecutionTimeSkippingTransitionedEventAttributes

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
messageIWorkflowExecutionTimeSkippingTransitionedEventAttributesWorkflowExecutionTimeSkippingTransitionedEventAttributes 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
messageIWorkflowExecutionTimeSkippingTransitionedEventAttributesWorkflowExecutionTimeSkippingTransitionedEventAttributes 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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecutionTimeSkippingTransitionedEventAttributes

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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