Skip to main content

Interface: IStart

coresdk.activity_task.IStart

Properties of a Start.

Hierarchy​

Properties​

activityId​

• Optional activityId: null | string

The activity's ID

Inherited from​

$Properties.activityId

activityType​

• Optional activityType: null | string

The activity's type name or function identifier

Inherited from​

$Properties.activityType

attempt​

• Optional attempt: null | number

Start attempt

Inherited from​

$Properties.attempt

currentAttemptScheduledTime​

• Optional currentAttemptScheduledTime: null | $Properties

When this current attempt at the task was scheduled

Inherited from​

$Properties.currentAttemptScheduledTime

headerFields​

• Optional headerFields: null | { [k: string]: $Properties; }

Start headerFields

Inherited from​

$Properties.headerFields

heartbeatDetails​

• Optional heartbeatDetails: null | $Properties[]

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

Inherited from​

$Properties.heartbeatDetails

heartbeatTimeout​

• Optional heartbeatTimeout: null | $Properties

If set a heartbeat must be reported within this interval

Inherited from​

$Properties.heartbeatTimeout

input​

• Optional input: null | $Properties[]

Arguments to the activity

Inherited from​

$Properties.input

isLocal​

• Optional isLocal: null | boolean

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

Inherited from​

$Properties.isLocal

priority​

• Optional priority: null | $Properties

Priority of this activity. Local activities will always have this field set to the default.

Inherited from​

$Properties.priority

retryPolicy​

• Optional retryPolicy: null | $Properties

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.

Inherited from​

$Properties.retryPolicy

runId​

• Optional runId: null | string

Run ID of this activity execution. Only set for standalone activities.

Inherited from​

$Properties.runId

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | $Properties

Timeout from the first schedule time to completion

Inherited from​

$Properties.scheduleToCloseTimeout

scheduledTime​

• Optional scheduledTime: null | $Properties

When the task was first scheduled

Inherited from​

$Properties.scheduledTime

startToCloseTimeout​

• Optional startToCloseTimeout: null | $Properties

Timeout from starting an attempt to reporting its result

Inherited from​

$Properties.startToCloseTimeout

startedTime​

• Optional startedTime: null | $Properties

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

Inherited from​

$Properties.startedTime

workflowExecution​

• Optional workflowExecution: null | $Properties

The workflow execution which requested this activity

Inherited from​

$Properties.workflowExecution

workflowNamespace​

• Optional workflowNamespace: null | string

The namespace the workflow lives in

Inherited from​

$Properties.workflowNamespace

workflowType​

• Optional workflowType: null | string

The workflow's type name or function identifier

Inherited from​

$Properties.workflowType