Class: FastForwardConfig

common.v1.FastForwardConfig

Represents a FastForwardConfig.

Implements

• IFastForwardConfig

Constructors

constructor

• new FastForwardConfig(properties?): FastForwardConfig

Constructs a new FastForwardConfig.

Parameters

Name	Type	Description
properties?	IFastForwardConfig	Properties to set

Returns

FastForwardConfig

Properties

duration

• Optional duration: null | IDuration

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.

Implementation of

IFastForwardConfig.duration

---

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.

Implementation of

IFastForwardConfig.id

Methods

toJSON

▸ toJSON(): Object

Converts this FastForwardConfig to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): FastForwardConfig

Creates a new FastForwardConfig instance using the specified properties.

Parameters

Name	Type	Description
properties?	IFastForwardConfig	Properties to set

Returns

FastForwardConfig

FastForwardConfig instance

---

decode

▸ decode(reader, length?): FastForwardConfig

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

FastForwardConfig

FastForwardConfig

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): FastForwardConfig

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

Parameters

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

Returns

FastForwardConfig

FastForwardConfig

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

Parameters

Name	Type	Description
message	IFastForwardConfig	FastForwardConfig message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IFastForwardConfig	FastForwardConfig message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): FastForwardConfig

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

FastForwardConfig

FastForwardConfig

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for FastForwardConfig

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

Parameters

Name	Type	Description
message	FastForwardConfig	FastForwardConfig
options?	IConversionOptions	Conversion options

Returns

Object

Plain object