Skip to main content

Class: TimeSkippingInfo

Describes the current time-skipping state of a workflow execution.

Properties​

currentSessionSkipCount​

currentSessionSkipCount: number

The number of skips accumulated in the current session, bounded by max_session_skip_count. A new session begins — and this resets to 0 — each time max_session_skip_count is updated.

currentTime?​

optional currentTime?: $Properties | null

Current virtual time of the execution. If the execution hasn't skipped any time yet, it will be the same as wall clock time.

effectiveConfig?​

optional effectiveConfig?: $Properties | null

The current effective time-skipping config, which can differ from the config the user last set: internally-defaulted fields are populated, and enabled reflects whether the execution is still skipping time — e.g. it is set to false once max_session_skip_count is reached, the fast-forward completes, or a client call disables time skipping.

fastForwardInfo?​

optional fastForwardInfo?: $Properties | null

The execution's current fast-forward, if any. Unset if time skipping is enabled without a fast-forward.

Methods​

toJSON()​

toJSON(): object

Converts this TimeSkippingInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TimeSkippingInfo & $Properties

Creates a new TimeSkippingInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimeSkippingInfo & $Properties

TimeSkippingInfo instance

Call Signature​

static create(properties?): TimeSkippingInfo

Creates a new TimeSkippingInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TimeSkippingInfo

TimeSkippingInfo instance

decode()​

static decode(reader, length?): TimeSkippingInfo & $Properties

Decodes a TimeSkippingInfo message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

TimeSkippingInfo & $Properties

TimeSkippingInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TimeSkippingInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TimeSkippingInfo & $Properties

TimeSkippingInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified TimeSkippingInfo message. Does not implicitly temporal.api.common.v1.TimeSkippingInfo.verify|verify messages.

Parameters​

message​

$Properties

TimeSkippingInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TimeSkippingInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TimeSkippingInfo

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

TimeSkippingInfo

TimeSkippingInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TimeSkippingInfo

TimeSkippingInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object