Class: ContinueAsNewWorkflowExecution
coresdk.workflow_commands.ContinueAsNewWorkflowExecution
Continue the workflow as a new execution
Properties
arguments
• arguments: $Properties[]
Inputs to the workflow code. Should be specified. Will not re-use old arguments, as that typically wouldn't make any sense.
backoffStartInterval
• Optional backoffStartInterval: null | $Properties
Delay before the first workflow task of the continued run is scheduled.
headers
• headers: Object
If set, the new workflow will have these headers. Will not re-use current workflow's headers otherwise.
Index signature
▪ [k: string]: $Properties
initialVersioningBehavior
• initialVersioningBehavior: ContinueAsNewVersioningBehavior
Experimental. Optionally decide the versioning behavior that the first task of the new run should use. For example, choose to AutoUpgrade on continue-as-new instead of inheriting the pinned version of the previous run.
memo
• memo: Object
If set, the new workflow will have this memo. If unset, re-uses the current workflow's memo
Index signature
▪ [k: string]: $Properties
retryPolicy
• Optional retryPolicy: null | $Properties
If set, the new workflow will have this retry policy. If unset, re-uses the current workflow's retry policy.
searchAttributes
• Optional searchAttributes: null | $Properties
If set, the new workflow will have these search attributes. If unset, re-uses the current workflow's search attributes.
taskQueue
• taskQueue: string
Task queue for the new workflow execution
versioningIntent
• versioningIntent: VersioningIntent
Whether the continued workflow should run on a worker with a compatible build id or not.
workflowRunTimeout
• Optional workflowRunTimeout: null | $Properties
Timeout for a single run of the new workflow. Will not re-use current workflow's value.
workflowTaskTimeout
• Optional workflowTaskTimeout: null | $Properties
Timeout of a single workflow task. Will not re-use current workflow's value.
workflowType
• workflowType: string
The identifier the lang-specific sdk uses to execute workflow code
Methods
toJSON
▸ toJSON(): Object
Converts this ContinueAsNewWorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ContinueAsNewWorkflowExecution & $Properties
Creates a new ContinueAsNewWorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ContinueAsNewWorkflowExecution & $Properties
ContinueAsNewWorkflowExecution instance
▸ create(properties?): ContinueAsNewWorkflowExecution
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
ContinueAsNewWorkflowExecution
decode
▸ decode(reader, length?): ContinueAsNewWorkflowExecution & $Properties
Decodes a ContinueAsNewWorkflowExecution 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
ContinueAsNewWorkflowExecution & $Properties
ContinueAsNewWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ContinueAsNewWorkflowExecution & $Properties
Decodes a ContinueAsNewWorkflowExecution message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ContinueAsNewWorkflowExecution & $Properties
ContinueAsNewWorkflowExecution
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 ContinueAsNewWorkflowExecution message. Does not implicitly coresdk.workflow_commands.ContinueAsNewWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ContinueAsNewWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ContinueAsNewWorkflowExecution message, length delimited. Does not implicitly coresdk.workflow_commands.ContinueAsNewWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ContinueAsNewWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ContinueAsNewWorkflowExecution
Creates a ContinueAsNewWorkflowExecution message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ContinueAsNewWorkflowExecution
ContinueAsNewWorkflowExecution
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ContinueAsNewWorkflowExecution message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ContinueAsNewWorkflowExecution | ContinueAsNewWorkflowExecution |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object