Class: TimeSkippingStatePropagation
common.v1.TimeSkippingStatePropagation
The time-skipping state that needs to be propagated from one execution to another, or through a chain of runs within the same execution.
Properties
fastForwardTargetTime
• Optional fastForwardTargetTime: null | $Properties
The fast-forward target time. It only propagates across a chain of runs within the same execution.
initialSkipCount
• initialSkipCount: number
The initial skip count. It only propagates across a chain of runs within the same execution.
initialSkippedDuration
• Optional initialSkippedDuration: null | $Properties
The time skipped by the previous run. It is propagated both to executions started by the current execution and through a chain of runs (CaN, cron, retry).
Methods
toJSON
▸ toJSON(): Object
Converts this TimeSkippingStatePropagation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TimeSkippingStatePropagation & $Properties
Creates a new TimeSkippingStatePropagation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
TimeSkippingStatePropagation & $Properties
TimeSkippingStatePropagation instance
▸ create(properties?): TimeSkippingStatePropagation
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): TimeSkippingStatePropagation & $Properties
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 & $Properties
TimeSkippingStatePropagation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TimeSkippingStatePropagation & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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