Class: TimeSkippingFastForwardInfo

common.v1.TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo describes the current time-skipping fast-forward on an execution.

Implements

• ITimeSkippingFastForwardInfo

Constructors

constructor

• new TimeSkippingFastForwardInfo(properties?): TimeSkippingFastForwardInfo

Constructs a new TimeSkippingFastForwardInfo.

Parameters

Name	Type	Description
properties?	ITimeSkippingFastForwardInfo	Properties to set

Returns

TimeSkippingFastForwardInfo

Properties

fastForwardDuration

• Optional fastForwardDuration: null | IDuration

The client-supplied fast_forward duration.

Implementation of

ITimeSkippingFastForwardInfo.fastForwardDuration

---

fastForwardId

• fastForwardId: string

The client-supplied ID set alongside fast_forward duration.

Implementation of

ITimeSkippingFastForwardInfo.fastForwardId

---

hasCompleted

• hasCompleted: boolean

True once target_time has been reached.

Implementation of

ITimeSkippingFastForwardInfo.hasCompleted

---

targetTime

• Optional targetTime: null | ITimestamp

The target virtual time at which the fast-forward completes.

Implementation of

ITimeSkippingFastForwardInfo.targetTime

Methods

toJSON

▸ toJSON(): Object

Converts this TimeSkippingFastForwardInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): TimeSkippingFastForwardInfo

Creates a new TimeSkippingFastForwardInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	ITimeSkippingFastForwardInfo	Properties to set

Returns

TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo instance

---

decode

▸ decode(reader, length?): TimeSkippingFastForwardInfo

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

TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): TimeSkippingFastForwardInfo

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

Parameters

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

Returns

TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo

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

Parameters

Name	Type	Description
message	ITimeSkippingFastForwardInfo	TimeSkippingFastForwardInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ITimeSkippingFastForwardInfo	TimeSkippingFastForwardInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): TimeSkippingFastForwardInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

TimeSkippingFastForwardInfo

TimeSkippingFastForwardInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TimeSkippingFastForwardInfo

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

Parameters

Name	Type	Description
message	TimeSkippingFastForwardInfo	TimeSkippingFastForwardInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object