Class: Start

coresdk.activity_task.Start

Begin executing an activity

Implements

• IStart

Constructors

constructor

• new Start(properties?): Start

Constructs a new Start.

Parameters

Name	Type	Description
properties?	IStart	Properties to set

Returns

Start

Properties

activityId

• activityId: string

The activity's ID

Implementation of

IStart.activityId

---

activityType

• activityType: string

The activity's type name or function identifier

Implementation of

IStart.activityType

---

attempt

• attempt: number

Start attempt.

Implementation of

IStart.attempt

---

currentAttemptScheduledTime

• Optional currentAttemptScheduledTime: null | ITimestamp

When this current attempt at the task was scheduled

Implementation of

IStart.currentAttemptScheduledTime

---

headerFields

• headerFields: Object

Start headerFields.

Index signature

▪ [k: string]: IPayload

Implementation of

IStart.headerFields

---

heartbeatDetails

• heartbeatDetails: IPayload[]

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

Implementation of

IStart.heartbeatDetails

---

heartbeatTimeout

• Optional heartbeatTimeout: null | IDuration

If set a heartbeat must be reported within this interval

Implementation of

IStart.heartbeatTimeout

---

input

• input: IPayload[]

Arguments to the activity

Implementation of

IStart.input

---

isLocal

• isLocal: boolean

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

Implementation of

IStart.isLocal

---

priority

• Optional priority: null | IPriority

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

Implementation of

IStart.priority

---

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.

Implementation of

IStart.retryPolicy

---

scheduleToCloseTimeout

• Optional scheduleToCloseTimeout: null | IDuration

Timeout from the first schedule time to completion

Implementation of

IStart.scheduleToCloseTimeout

---

scheduledTime

• Optional scheduledTime: null | ITimestamp

When the task was first scheduled

Implementation of

IStart.scheduledTime

---

startToCloseTimeout

• Optional startToCloseTimeout: null | IDuration

Timeout from starting an attempt to reporting its result

Implementation of

IStart.startToCloseTimeout

---

startedTime

• Optional startedTime: null | ITimestamp

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

Implementation of

IStart.startedTime

---

workflowExecution

• Optional workflowExecution: null | IWorkflowExecution

The workflow execution which requested this activity

Implementation of

IStart.workflowExecution

---

workflowNamespace

• workflowNamespace: string

The namespace the workflow lives in

Implementation of

IStart.workflowNamespace

---

workflowType

• workflowType: string

The workflow's type name or function identifier

Implementation of

IStart.workflowType

Methods

toJSON

▸ toJSON(): Object

Converts this Start to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Start

Creates a new Start instance using the specified properties.

Parameters

Name	Type	Description
properties?	IStart	Properties to set

Returns

Start

Start instance

---

decode

▸ decode(reader, length?): Start

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

Start

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Start

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

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	IStart	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	IStart	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

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Start

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

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