Class: Start

coresdk.activity_task.Start

Begin executing an activity

Properties

activityId

• activityId: string

The activity's ID

---

activityType

• activityType: string

The activity's type name or function identifier

---

attempt

• attempt: number

Start attempt.

---

currentAttemptScheduledTime

• Optional currentAttemptScheduledTime: null | $Properties

When this current attempt at the task was scheduled

---

headerFields

• headerFields: Object

Start headerFields.

Index signature

▪ [k: string]: $Properties

---

heartbeatDetails

• heartbeatDetails: $Properties[]

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

---

heartbeatTimeout

• Optional heartbeatTimeout: null | $Properties

If set a heartbeat must be reported within this interval

---

input

• input: $Properties[]

Arguments to the activity

---

isLocal

• isLocal: boolean

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

---

priority

• Optional priority: null | $Properties

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

---

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.

---

runId

• runId: string

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

---

scheduleToCloseTimeout

• Optional scheduleToCloseTimeout: null | $Properties

Timeout from the first schedule time to completion

---

scheduledTime

• Optional scheduledTime: null | $Properties

When the task was first scheduled

---

startToCloseTimeout

• Optional startToCloseTimeout: null | $Properties

Timeout from starting an attempt to reporting its result

---

startedTime

• Optional startedTime: null | $Properties

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

---

workflowExecution

• Optional workflowExecution: null | $Properties

The workflow execution which requested this activity

---

workflowNamespace

• workflowNamespace: string

The namespace the workflow lives in

---

workflowType

• workflowType: string

The workflow's type name or function identifier

Methods

toJSON

▸ toJSON(): Object

Converts this Start to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Start & $Properties

Creates a new Start instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Properties	Properties to set

Returns

Start & $Properties

Start instance

▸ create(properties?): Start

Parameters

Name	Type
properties?	$Properties

Returns

Start

---

decode

▸ decode(reader, length?): Start & $Properties

Decodes a Start 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

Start & $Properties

Start

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Start & $Properties

Decodes a Start message from the specified reader or buffer, length delimited.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

Start & $Properties

Start

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 Start message. Does not implicitly coresdk.activity_task.Start.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	Start message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified Start message, length delimited. Does not implicitly coresdk.activity_task.Start.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	Start message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): Start

Creates a Start message from a plain object. Also converts values to their respective internal types.

Parameters

Name	Type	Description
object	Object	Plain object

Returns

Start

Start

---

toObject

▸ toObject(message, options?): Object

Creates a plain object from a Start message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	Start	Start
options?	IConversionOptions	Conversion options

Returns

Object

Plain object