Skip to main content

Interface: $Properties

Properties of a Start.

Extended by​

Properties​

activityId?​

optional activityId?: string | null

The activity's ID

activityType?​

optional activityType?: string | null

The activity's type name or function identifier

attempt?​

optional attempt?: number | null

Start attempt

currentAttemptScheduledTime?​

optional currentAttemptScheduledTime?: $Properties | null

When this current attempt at the task was scheduled

headerFields?​

optional headerFields?: {[k: string]: $Properties; } | null

Start headerFields

heartbeatDetails?​

optional heartbeatDetails?: $Properties[] | null

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

heartbeatTimeout?​

optional heartbeatTimeout?: $Properties | null

If set a heartbeat must be reported within this interval

input?​

optional input?: $Properties[] | null

Arguments to the activity

isLocal?​

optional isLocal?: boolean | null

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

priority?​

optional priority?: $Properties | null

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

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

Serialization context of the Nexus operation handler that started this activity, if any. Only set for standalone activities. Lang should use it to serialize the activity's result and failure, which are returned to the Nexus caller.

retryPolicy?​

optional retryPolicy?: $Properties | null

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.

runId?​

optional runId?: string | null

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

scheduledTime?​

optional scheduledTime?: $Properties | null

When the task was first scheduled

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: $Properties | null

Timeout from the first schedule time to completion

startedTime?​

optional startedTime?: $Properties | null

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

startToCloseTimeout?​

optional startToCloseTimeout?: $Properties | null

Timeout from starting an attempt to reporting its result

workflowExecution?​

optional workflowExecution?: $Properties | null

The workflow execution which requested this activity

workflowNamespace?​

optional workflowNamespace?: string | null

The namespace the workflow lives in

workflowType?​

optional workflowType?: string | null

The workflow's type name or function identifier