Skip to main content

Class: Start

coresdk.activity_task.Start

Begin executing an activity

Implements#

Constructors#

constructor#

new Start(properties?)

Constructs a new Start.

Parameters#

NameType
properties?IStart

Properties#

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

Start currentAttemptScheduledTime.

Implementation of#

IStart.currentAttemptScheduledTime


headerFields#

headerFields: Object

Start headerFields.

Index signature#

▪ [k: string]: IPayload

Implementation of#

IStart.headerFields


heartbeatDetails#

heartbeatDetails: IPayload[]

Start heartbeatDetails.

Implementation of#

IStart.heartbeatDetails


heartbeatTimeout#

Optional heartbeatTimeout: null | IDuration

Start heartbeatTimeout.

Implementation of#

IStart.heartbeatTimeout


input#

input: IPayload[]

Arguments to the activity

Implementation of#

IStart.input


retryPolicy#

Optional retryPolicy: null | IRetryPolicy

values are not specified or exceed configured system limits.

Implementation of#

IStart.retryPolicy


scheduleToCloseTimeout#

Optional scheduleToCloseTimeout: null | IDuration

Start scheduleToCloseTimeout.

Implementation of#

IStart.scheduleToCloseTimeout


scheduledTime#

Optional scheduledTime: null | ITimestamp

Start scheduledTime.

Implementation of#

IStart.scheduledTime


startToCloseTimeout#

Optional startToCloseTimeout: null | IDuration

Start startToCloseTimeout.

Implementation of#

IStart.startToCloseTimeout


startedTime#

Optional startedTime: null | ITimestamp

Start startedTime.

Implementation of#

IStart.startedTime


workflowExecution#

Optional workflowExecution: null | IWorkflowExecution

Start workflowExecution.

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


decode#

Static decode(reader, length?): Start

Decodes a Start message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

Start

Start


decodeDelimited#

Static decodeDelimited(reader): Start

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

Start

Start


encode#

Static encode(message, writer?): Writer

Encodes the specified Start message. Does not implicitly {@link coresdk.activity_task.Start.verify|verify} messages.

Parameters#

NameTypeDescription
messageIStartStart message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIStartStart message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): Start

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

Start

Start


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageStartStart
options?IConversionOptions-

Returns#

Object

Plain object