Skip to main content

Class: LocalActivityMarkerData

coresdk.external_data.LocalActivityMarkerData

Represents a LocalActivityMarkerData.

Properties​

activityId​

• activityId: string

LocalActivityMarkerData activityId.


activityType​

• activityType: string

LocalActivityMarkerData activityType.


attempt​

• attempt: number

The number of attempts at execution before we recorded this result. Typically starts at 1, but it is possible to start at a higher number when backing off using a timer.


backoff​

• Optional backoff: null | $Properties

If set, this local activity conceptually is retrying after the specified backoff. Implementation wise, they are really two different LA machines, but with the same type & input. The retry starts with an attempt number > 1.


completeTime​

• Optional completeTime: null | $Properties

You can think of this as "perceived completion time". It is the time the local activity thought it was when it completed. Which could be different from wall-clock time because of workflow replay. It's the WFT start time + the LA's runtime


originalScheduleTime​

• Optional originalScheduleTime: null | $Properties

The time the LA was originally scheduled (wall clock time). This is used to track schedule-to-close timeouts when timer-based backoffs are used


seq​

• seq: number

LocalActivityMarkerData seq.

Methods​

toJSON​

▸ toJSON(): Object

Converts this LocalActivityMarkerData to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): LocalActivityMarkerData & $Properties

Creates a new LocalActivityMarkerData instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

LocalActivityMarkerData & $Properties

LocalActivityMarkerData instance

▸ create(properties?): LocalActivityMarkerData

Parameters​

NameType
properties?$Properties

Returns​

LocalActivityMarkerData


decode​

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

Decodes a LocalActivityMarkerData message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

LocalActivityMarkerData & $Properties

LocalActivityMarkerData

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): LocalActivityMarkerData & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

LocalActivityMarkerData & $Properties

LocalActivityMarkerData

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

Parameters​

NameTypeDescription
message$PropertiesLocalActivityMarkerData message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified LocalActivityMarkerData message, length delimited. Does not implicitly coresdk.external_data.LocalActivityMarkerData.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesLocalActivityMarkerData message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): LocalActivityMarkerData

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

LocalActivityMarkerData

LocalActivityMarkerData


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageLocalActivityMarkerDataLocalActivityMarkerData
options?IConversionOptionsConversion options

Returns​

Object

Plain object