Class: WorkflowExecutionOptions
workflow.v1.WorkflowExecutionOptions
Represents a WorkflowExecutionOptions.
Properties
priority
• Optional priority: null | $Properties
If set, overrides the workflow's priority sent by the SDK.
timeSkippingConfig
• Optional timeSkippingConfig: null | $Properties
The time-skipping configuration for this workflow execution.
When fast_forward is set, time will be fast-forwarded to a future point relative
to the current workflow timestamp. Each call takes effect, even if
fast_forward is set to the same duration, since the target time is recalculated
from the current timestamp on every call.
This field must be updated as a whole; updating individual sub-fields is not supported.
When setting the update mask in UpdateWorkflowExecutionOptionsRequest,
BatchOperationUpdateWorkflowExecutionOptions, etc., use a mask that covers the entire field.
versioningOverride
• Optional versioningOverride: null | $Properties
If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionOptions & $Shape
Creates a new WorkflowExecutionOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkflowExecutionOptions & $Shape
WorkflowExecutionOptions instance
▸ create(properties?): WorkflowExecutionOptions
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowExecutionOptions & $Shape
Decodes a WorkflowExecutionOptions 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
WorkflowExecutionOptions & $Shape
WorkflowExecutionOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionOptions & $Shape
Decodes a WorkflowExecutionOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionOptions & $Shape
WorkflowExecutionOptions
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 WorkflowExecutionOptions message. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionOptions message, length delimited. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionOptions
Creates a WorkflowExecutionOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionOptions
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowExecutionOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionOptions | WorkflowExecutionOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object