Class: PollWorkflowExecutionTimeSkippingRequest
workflowservice.v1.PollWorkflowExecutionTimeSkippingRequest
A long-poll request that blocks according to a time-skipping waiting policy on the workflow
execution. Currently the only supported policy is waiting for completion of the fast-forward
identified by fast_forward_id; the poll also returns once anything else settles that outcome
(e.g. the execution ends or time skipping is disabled).
Properties
fastForwardId
• fastForwardId: string
Required. Identifies the fast-forward whose completion the caller wants to wait for.
Must match the fast_forward_id set in the execution's TimeSkippingConfig.
namespace
• namespace: string
PollWorkflowExecutionTimeSkippingRequest namespace.
workflowExecution
• Optional workflowExecution: null | $Properties
PollWorkflowExecutionTimeSkippingRequest workflowExecution.
Methods
toJSON
▸ toJSON(): Object
Converts this PollWorkflowExecutionTimeSkippingRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollWorkflowExecutionTimeSkippingRequest & $Properties
Creates a new PollWorkflowExecutionTimeSkippingRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
PollWorkflowExecutionTimeSkippingRequest & $Properties
PollWorkflowExecutionTimeSkippingRequest instance
▸ create(properties?): PollWorkflowExecutionTimeSkippingRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
PollWorkflowExecutionTimeSkippingRequest
decode
▸ decode(reader, length?): PollWorkflowExecutionTimeSkippingRequest & $Properties
Decodes a PollWorkflowExecutionTimeSkippingRequest 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
PollWorkflowExecutionTimeSkippingRequest & $Properties
PollWorkflowExecutionTimeSkippingRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollWorkflowExecutionTimeSkippingRequest & $Properties
Decodes a PollWorkflowExecutionTimeSkippingRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PollWorkflowExecutionTimeSkippingRequest & $Properties
PollWorkflowExecutionTimeSkippingRequest
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 PollWorkflowExecutionTimeSkippingRequest message. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowExecutionTimeSkippingRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PollWorkflowExecutionTimeSkippingRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PollWorkflowExecutionTimeSkippingRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowExecutionTimeSkippingRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PollWorkflowExecutionTimeSkippingRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PollWorkflowExecutionTimeSkippingRequest
Creates a PollWorkflowExecutionTimeSkippingRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollWorkflowExecutionTimeSkippingRequest
PollWorkflowExecutionTimeSkippingRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PollWorkflowExecutionTimeSkippingRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollWorkflowExecutionTimeSkippingRequest | PollWorkflowExecutionTimeSkippingRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object