Class: NewWorkflowExecutionInfo
workflow.v1.NewWorkflowExecutionInfo
NewWorkflowExecutionInfo is a shared message that encapsulates all the required arguments to starting a workflow in different contexts.
Properties
cronSchedule
• cronSchedule: string
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
header
• Optional header: null | $Properties
NewWorkflowExecutionInfo header.
input
• Optional input: null | $Properties
Serialized arguments to the workflow.
memo
• Optional memo: null | $Properties
NewWorkflowExecutionInfo memo.
priority
• Optional priority: null | $Properties
Priority metadata
retryPolicy
• Optional retryPolicy: null | $Properties
The retry policy for the workflow. Will never exceed workflow_execution_timeout.
searchAttributes
• Optional searchAttributes: null | $Properties
NewWorkflowExecutionInfo searchAttributes.
taskQueue
• Optional taskQueue: null | $Properties
NewWorkflowExecutionInfo taskQueue.
userMetadata
• Optional userMetadata: null | $Properties
Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionConfig for use by user interfaces to display the fixed as-of-start summary and details of the workflow.
versioningOverride
• Optional versioningOverride: null | $Properties
If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion. To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
workflowExecutionTimeout
• Optional workflowExecutionTimeout: null | $Properties
Total workflow execution timeout including retries and continue as new.
workflowId
• workflowId: string
NewWorkflowExecutionInfo workflowId.
workflowIdReusePolicy
• workflowIdReusePolicy: WorkflowIdReusePolicy
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
workflowRunTimeout
• Optional workflowRunTimeout: null | $Properties
Timeout of a single workflow run.
workflowTaskTimeout
• Optional workflowTaskTimeout: null | $Properties
Timeout of a single workflow task.
workflowType
• Optional workflowType: null | $Properties
NewWorkflowExecutionInfo workflowType.
Methods
toJSON
▸ toJSON(): Object
Converts this NewWorkflowExecutionInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NewWorkflowExecutionInfo & $Shape
Creates a new NewWorkflowExecutionInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
NewWorkflowExecutionInfo & $Shape
NewWorkflowExecutionInfo instance
▸ create(properties?): NewWorkflowExecutionInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): NewWorkflowExecutionInfo & $Shape
Decodes a NewWorkflowExecutionInfo 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
NewWorkflowExecutionInfo & $Shape
NewWorkflowExecutionInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NewWorkflowExecutionInfo & $Shape
Decodes a NewWorkflowExecutionInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NewWorkflowExecutionInfo & $Shape
NewWorkflowExecutionInfo
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 NewWorkflowExecutionInfo message. Does not implicitly temporal.api.workflow.v1.NewWorkflowExecutionInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NewWorkflowExecutionInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NewWorkflowExecutionInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.NewWorkflowExecutionInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NewWorkflowExecutionInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NewWorkflowExecutionInfo
Creates a NewWorkflowExecutionInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NewWorkflowExecutionInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a NewWorkflowExecutionInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NewWorkflowExecutionInfo | NewWorkflowExecutionInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object