Skip to main content

Interface: IStart

coresdk.activity_task.IStart

Properties of a Start.

Implemented by

Properties

activityId

Optional activityId: null | string

The activity's ID


activityType

Optional activityType: null | string

The activity's type name or function identifier


attempt

Optional attempt: null | number

Start attempt


currentAttemptScheduledTime

Optional currentAttemptScheduledTime: null | ITimestamp

When this current attempt at the task was scheduled


headerFields

Optional headerFields: null | { [k: string]: IPayload; }

Start headerFields


heartbeatDetails

Optional heartbeatDetails: null | IPayload[]

The last details that were recorded by a heartbeat when this task was generated


heartbeatTimeout

Optional heartbeatTimeout: null | IDuration

If set a heartbeat must be reported within this interval


input

Optional input: null | IPayload[]

Arguments to the activity


isLocal

Optional isLocal: null | boolean

Set to true if this is a local activity. Note that heartbeating does not apply to local activities.


retryPolicy

Optional retryPolicy: null | IRetryPolicy

This is an actual retry policy the service uses. It can be different from the one provided (or not) during activity scheduling as the service can override the provided one in case its values are not specified or exceed configured system limits.


scheduleToCloseTimeout

Optional scheduleToCloseTimeout: null | IDuration

Timeout from the first schedule time to completion


scheduledTime

Optional scheduledTime: null | ITimestamp

When the task was first scheduled


startToCloseTimeout

Optional startToCloseTimeout: null | IDuration

Timeout from starting an attempt to reporting its result


startedTime

Optional startedTime: null | ITimestamp

When this attempt was started, which is to say when core received it by polling.


workflowExecution

Optional workflowExecution: null | IWorkflowExecution

The workflow execution which requested this activity


workflowNamespace

Optional workflowNamespace: null | string

The namespace the workflow lives in


workflowType

Optional workflowType: null | string

The workflow's type name or function identifier