Class: TimeSkippingInfo

common.v1.TimeSkippingInfo

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

Implements

• ITimeSkippingInfo

Constructors

constructor

• new TimeSkippingInfo(properties?): TimeSkippingInfo

Constructs a new TimeSkippingInfo.

Parameters

Name	Type	Description
properties?	ITimeSkippingInfo	Properties to set

Returns

TimeSkippingInfo

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.

Implementation of

ITimeSkippingInfo.currentSessionSkipCount

---

currentTime

• Optional currentTime: null | ITimestamp

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

Implementation of

ITimeSkippingInfo.currentTime

---

effectiveConfig

• Optional effectiveConfig: null | ITimeSkippingConfig

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.

Implementation of

ITimeSkippingInfo.effectiveConfig

---

fastForwardInfo

• Optional fastForwardInfo: null | ITimeSkippingFastForwardInfo

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

Implementation of

ITimeSkippingInfo.fastForwardInfo

Methods

toJSON

▸ toJSON(): Object

Converts this TimeSkippingInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): TimeSkippingInfo

Creates a new TimeSkippingInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	ITimeSkippingInfo	Properties to set

Returns

TimeSkippingInfo

TimeSkippingInfo instance

---

decode

▸ decode(reader, length?): TimeSkippingInfo

Decodes a TimeSkippingInfo message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

TimeSkippingInfo

TimeSkippingInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): TimeSkippingInfo

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

TimeSkippingInfo

TimeSkippingInfo

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 TimeSkippingInfo message. Does not implicitly temporal.api.common.v1.TimeSkippingInfo.verify|verify messages.

Parameters

Name	Type	Description
message	ITimeSkippingInfo	TimeSkippingInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ITimeSkippingInfo	TimeSkippingInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): TimeSkippingInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

TimeSkippingInfo

TimeSkippingInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TimeSkippingInfo

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	TimeSkippingInfo	TimeSkippingInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object