Class: FastForwardConfig

Represents a FastForwardConfig.

Properties

duration?

optional duration?: $Properties | null

Fast-forward the current execution by this duration ahead of the current execution time; required field. The duration yields a target time (current execution time + duration), surfaced as target_time in TimeSkippingFastForwardInfo. Once virtual time reaches that target, the fast-forward completes, time skipping is disabled, and no further time is skipped. Time skipping can be resumed either by updating the TimeSkippingConfig with a new FastForwardConfig, or by clearing the FastForwardConfig to skip through to the end of the execution.

If this duration exceeds the remaining execution timeout, time will not pass beyond the end of the execution, and the fast-forward won't have a chance to complete.

---

id

id: string

A client-supplied ID, required field, set alongside duration. It is used to poll for fast-forward completion via PollWorkflowExecutionTimeSkipping. The server performs no idempotency check on this ID; the client is responsible for managing it.

Methods

toJSON()

toJSON(): object

Converts this FastForwardConfig to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): FastForwardConfig & $Properties

Creates a new FastForwardConfig instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

FastForwardConfig & $Properties

FastForwardConfig instance

Call Signature

static create(properties?): FastForwardConfig

Creates a new FastForwardConfig instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

FastForwardConfig

FastForwardConfig instance

---

decode()

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

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

FastForwardConfig & $Properties

FastForwardConfig

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): FastForwardConfig & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

FastForwardConfig & $Properties

FastForwardConfig

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

Parameters

message

$Properties

FastForwardConfig message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

FastForwardConfig message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): FastForwardConfig

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

Parameters

object

{[k: string]: any; }

Plain object

Returns

FastForwardConfig

FastForwardConfig

---

toObject()

static toObject(message, options?): object

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

Parameters

message

FastForwardConfig

FastForwardConfig

options?

IConversionOptions

Conversion options

Returns

object

Plain object