Class: TimeSkippingStatePropagation

common.v1.TimeSkippingStatePropagation

The time-skipping state that needs to be propagated from a parent workflow to a child workflow, or through a chain of runs.

Implements

• ITimeSkippingStatePropagation

Constructors

constructor

• new TimeSkippingStatePropagation(properties?): TimeSkippingStatePropagation

Constructs a new TimeSkippingStatePropagation.

Parameters

Name	Type	Description
properties?	ITimeSkippingStatePropagation	Properties to set

Returns

TimeSkippingStatePropagation

Properties

fastForwardTargetTime

• Optional fastForwardTargetTime: null | ITimestamp

If there is a fast-forward action set for the previous run in a chain of runs, the target time should be propagated to the next run as well.

Implementation of

ITimeSkippingStatePropagation.fastForwardTargetTime

---

initialSkippedDuration

• Optional initialSkippedDuration: null | IDuration

The time skipped by the previous execution that started this workflow. It can happen in child workflows and a chain of runs (CaN, cron, retry).

Implementation of

ITimeSkippingStatePropagation.initialSkippedDuration

Methods

toJSON

▸ toJSON(): Object

Converts this TimeSkippingStatePropagation to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): TimeSkippingStatePropagation

Creates a new TimeSkippingStatePropagation instance using the specified properties.

Parameters

Name	Type	Description
properties?	ITimeSkippingStatePropagation	Properties to set

Returns

TimeSkippingStatePropagation

TimeSkippingStatePropagation instance

---

decode

▸ decode(reader, length?): TimeSkippingStatePropagation

Decodes a TimeSkippingStatePropagation 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

TimeSkippingStatePropagation

TimeSkippingStatePropagation

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): TimeSkippingStatePropagation

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

Parameters

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

Returns

TimeSkippingStatePropagation

TimeSkippingStatePropagation

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

Parameters

Name	Type	Description
message	ITimeSkippingStatePropagation	TimeSkippingStatePropagation message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ITimeSkippingStatePropagation	TimeSkippingStatePropagation message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): TimeSkippingStatePropagation

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

TimeSkippingStatePropagation

TimeSkippingStatePropagation

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TimeSkippingStatePropagation

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 TimeSkippingStatePropagation message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	TimeSkippingStatePropagation	TimeSkippingStatePropagation
options?	IConversionOptions	Conversion options

Returns

Object

Plain object