Class: NewWorkflowExecutionInfo
workflow.v1.NewWorkflowExecutionInfo
NewWorkflowExecutionInfo is a shared message that encapsulates all the required arguments to starting a workflow in different contexts.
Implements
Constructors
constructor
• new NewWorkflowExecutionInfo(properties?): NewWorkflowExecutionInfo
Constructs a new NewWorkflowExecutionInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INewWorkflowExecutionInfo | Properties to set |
Returns
Properties
cronSchedule
• cronSchedule: string
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
Implementation of
INewWorkflowExecutionInfo.cronSchedule
header
• Optional header: null | IHeader
NewWorkflowExecutionInfo header.
Implementation of
INewWorkflowExecutionInfo.header
input
• Optional input: null | IPayloads
Serialized arguments to the workflow.
Implementation of
INewWorkflowExecutionInfo.input
memo
• Optional memo: null | IMemo
NewWorkflowExecutionInfo memo.
Implementation of
INewWorkflowExecutionInfo.memo
retryPolicy
• Optional retryPolicy: null | IRetryPolicy
The retry policy for the workflow. Will never exceed workflow_execution_timeout.
Implementation of
INewWorkflowExecutionInfo.retryPolicy
searchAttributes
• Optional searchAttributes: null | ISearchAttributes
NewWorkflowExecutionInfo searchAttributes.
Implementation of
INewWorkflowExecutionInfo.searchAttributes
taskQueue
• Optional taskQueue: null | ITaskQueue
NewWorkflowExecutionInfo taskQueue.
Implementation of
INewWorkflowExecutionInfo.taskQueue
userMetadata
• Optional userMetadata: null | IUserMetadata
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.
Implementation of
INewWorkflowExecutionInfo.userMetadata
versioningOverride
• Optional versioningOverride: null | IVersioningOverride
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.
Implementation of
INewWorkflowExecutionInfo.versioningOverride
workflowExecutionTimeout
• Optional workflowExecutionTimeout: null | IDuration
Total workflow execution timeout including retries and continue as new.
Implementation of
INewWorkflowExecutionInfo.workflowExecutionTimeout
workflowId
• workflowId: string
NewWorkflowExecutionInfo workflowId.
Implementation of
INewWorkflowExecutionInfo.workflowId
workflowIdReusePolicy
• workflowIdReusePolicy: WorkflowIdReusePolicy
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
Implementation of
INewWorkflowExecutionInfo.workflowIdReusePolicy
workflowRunTimeout
• Optional workflowRunTimeout: null | IDuration
Timeout of a single workflow run.
Implementation of
INewWorkflowExecutionInfo.workflowRunTimeout
workflowTaskTimeout
• Optional workflowTaskTimeout: null | IDuration
Timeout of a single workflow task.
Implementation of
INewWorkflowExecutionInfo.workflowTaskTimeout
workflowType
• Optional workflowType: null | IWorkflowType
NewWorkflowExecutionInfo workflowType.
Implementation of
INewWorkflowExecutionInfo.workflowType
Methods
toJSON
▸ toJSON(): Object
Converts this NewWorkflowExecutionInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NewWorkflowExecutionInfo
Creates a new NewWorkflowExecutionInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INewWorkflowExecutionInfo | Properties to set |
Returns
NewWorkflowExecutionInfo instance
decode
▸ decode(reader, length?): NewWorkflowExecutionInfo
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NewWorkflowExecutionInfo
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
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 | INewWorkflowExecutionInfo | 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 | INewWorkflowExecutionInfo | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NewWorkflowExecutionInfo
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 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