Class: InitializeWorkflow
coresdk.workflow_activation.InitializeWorkflow
Initialize a new workflow
Properties
arguments
• arguments: $Properties[]
Inputs to the workflow code
attempt
• attempt: number
Starting at 1, the number of times we have tried to execute this workflow
continuedFailure
• Optional continuedFailure: null | $Properties
If this workflow was a continuation and that continuation failed, the details of that.
continuedFromExecutionRunId
• continuedFromExecutionRunId: string
Run id of the previous workflow which continued-as-new or retired or cron executed into this workflow, if any.
continuedInitiator
• continuedInitiator: ContinueAsNewInitiator
If this workflow was a continuation, indicates the type of continuation.
cronSchedule
• cronSchedule: string
If this workflow runs on a cron schedule, it will appear here
cronScheduleToScheduleInterval
• Optional cronScheduleToScheduleInterval: null | $Properties
For a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.
firstExecutionRunId
• firstExecutionRunId: string
This is the very first run id the workflow ever had, following continuation chains.
headers
• headers: Object
Used to add metadata e.g. for tracing and auth, meant to be read and written to by interceptors.
Index signature
▪ [k: string]: $Properties
identity
• identity: string
Identity of the client who requested this execution
lastCompletionResult
• Optional lastCompletionResult: null | $Properties
If this workflow was a continuation and that continuation completed, the details of that.
memo
• Optional memo: null | $Properties
User-defined memo
originalExecutionRunId
• originalExecutionRunId: string
The run id recorded on the WORKFLOW_EXECUTION_STARTED event. Unlike the execution's current
run id, this value is preserved across workflow resets. Mirrors the original_execution_run_id
field from WorkflowExecutionStartedEventAttributes.
parentWorkflowInfo
• Optional parentWorkflowInfo: null | $Properties
If this workflow is a child, information about the parent
priority
• Optional priority: null | $Properties
Priority of this workflow execution
randomnessSeed
• randomnessSeed: Long
The seed must be used to initialize the random generator used by SDK. RandomSeedUpdatedAttributes are used to deliver seed updates.
retryPolicy
• Optional retryPolicy: null | $Properties
This workflow's retry policy
rootWorkflow
• Optional rootWorkflow: null | $Properties
Contains information about the root workflow execution. It is possible for the namespace to be different than this workflow if using OSS and cross-namespace children, but this information is not retained. Users should take care to track it by other means in such situations.
The root workflow execution is defined as follows:
- A workflow without parent workflow is its own root workflow.
- A workflow that has a parent workflow has the same root workflow as its parent workflow.
See field in WorkflowExecutionStarted for more detail.
searchAttributes
• Optional searchAttributes: null | $Properties
Search attributes created/updated when this workflow was started
startTime
• Optional startTime: null | $Properties
When the workflow execution started event was first written
workflowExecutionExpirationTime
• Optional workflowExecutionExpirationTime: null | $Properties
The absolute time at which the workflow will be timed out. This is passed without change to the next run/retry of a workflow.
workflowExecutionTimeout
• Optional workflowExecutionTimeout: null | $Properties
Total workflow execution timeout including retries and continue as new.
workflowId
• workflowId: string
The workflow id used on the temporal server
workflowRunTimeout
• Optional workflowRunTimeout: null | $Properties
Timeout of a single workflow run.
workflowTaskTimeout
• Optional workflowTaskTimeout: null | $Properties
Timeout of a single workflow task.
workflowType
• workflowType: string
The identifier the lang-specific sdk uses to execute workflow code
Methods
toJSON
▸ toJSON(): Object
Converts this InitializeWorkflow to JSON.
Returns
Object
JSON object
create
▸ create(properties?): InitializeWorkflow & $Shape
Creates a new InitializeWorkflow instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
InitializeWorkflow instance
▸ create(properties?): InitializeWorkflow
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): InitializeWorkflow & $Shape
Decodes an InitializeWorkflow 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
InitializeWorkflow
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): InitializeWorkflow & $Shape
Decodes an InitializeWorkflow message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
InitializeWorkflow
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 InitializeWorkflow message. Does not implicitly coresdk.workflow_activation.InitializeWorkflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | InitializeWorkflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified InitializeWorkflow message, length delimited. Does not implicitly coresdk.workflow_activation.InitializeWorkflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | InitializeWorkflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): InitializeWorkflow
Creates an InitializeWorkflow message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
InitializeWorkflow
toObject
▸ toObject(message, options?): Object
Creates a plain object from an InitializeWorkflow message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | InitializeWorkflow | InitializeWorkflow |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object