Class: ContinueAsNewWorkflowExecution
coresdk.workflow_commands.ContinueAsNewWorkflowExecution
Continue the workflow as a new execution
Implements
Constructors
constructor
• new ContinueAsNewWorkflowExecution(properties?
): ContinueAsNewWorkflowExecution
Constructs a new ContinueAsNewWorkflowExecution.
Parameters
Name | Type | Description |
---|---|---|
properties? | IContinueAsNewWorkflowExecution | Properties to set |
Returns
ContinueAsNewWorkflowExecution
Properties
arguments
• arguments: IPayload
[]
Inputs to the workflow code. Should be specified. Will not re-use old arguments, as that typically wouldn't make any sense.
Implementation of
IContinueAsNewWorkflowExecution.arguments
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
]: IPayload
Implementation of
IContinueAsNewWorkflowExecution.headers
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
]: IPayload
Implementation of
IContinueAsNewWorkflowExecution.memo
retryPolicy
• Optional
retryPolicy: null
| IRetryPolicy
If set, the new workflow will have this retry policy. If unset, re-uses the current workflow's retry policy.
Implementation of
IContinueAsNewWorkflowExecution.retryPolicy
searchAttributes
• searchAttributes: Object
If set, the new workflow will have these search attributes. If unset, re-uses the current workflow's search attributes.
Index signature
▪ [k: string
]: IPayload
Implementation of
IContinueAsNewWorkflowExecution.searchAttributes
taskQueue
• taskQueue: string
Task queue for the new workflow execution
Implementation of
IContinueAsNewWorkflowExecution.taskQueue
versioningIntent
• versioningIntent: VersioningIntent
Whether the continued workflow should run on a worker with a compatible build id or not.
Implementation of
IContinueAsNewWorkflowExecution.versioningIntent
workflowRunTimeout
• Optional
workflowRunTimeout: null
| IDuration
Timeout for a single run of the new workflow. Will not re-use current workflow's value.
Implementation of
IContinueAsNewWorkflowExecution.workflowRunTimeout
workflowTaskTimeout
• Optional
workflowTaskTimeout: null
| IDuration
Timeout of a single workflow task. Will not re-use current workflow's value.
Implementation of
IContinueAsNewWorkflowExecution.workflowTaskTimeout
workflowType
• workflowType: string
The identifier the lang-specific sdk uses to execute workflow code
Implementation of
IContinueAsNewWorkflowExecution.workflowType
Methods
toJSON
▸ toJSON(): Object
Converts this ContinueAsNewWorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): ContinueAsNewWorkflowExecution
Creates a new ContinueAsNewWorkflowExecution instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IContinueAsNewWorkflowExecution | Properties to set |
Returns
ContinueAsNewWorkflowExecution
ContinueAsNewWorkflowExecution instance
decode
▸ decode(reader
, length?
): ContinueAsNewWorkflowExecution
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
ContinueAsNewWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): ContinueAsNewWorkflowExecution
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
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 | IContinueAsNewWorkflowExecution | 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 | IContinueAsNewWorkflowExecution | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for ContinueAsNewWorkflowExecution
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 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