Class: LocalActivityMarkerData
coresdk.external_data.LocalActivityMarkerData
Represents a LocalActivityMarkerData.
Implements
Constructors
constructor
• new LocalActivityMarkerData(properties?): LocalActivityMarkerData
Constructs a new LocalActivityMarkerData.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ILocalActivityMarkerData | Properties to set |
Returns
Properties
activityId
• activityId: string
LocalActivityMarkerData activityId.
Implementation of
ILocalActivityMarkerData.activityId
activityType
• activityType: string
LocalActivityMarkerData activityType.
Implementation of
ILocalActivityMarkerData.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.
Implementation of
ILocalActivityMarkerData.attempt
backoff
• Optional backoff: null | IDuration
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.
Implementation of
ILocalActivityMarkerData.backoff
completeTime
• Optional completeTime: null | ITimestamp
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
Implementation of
ILocalActivityMarkerData.completeTime
originalScheduleTime
• Optional originalScheduleTime: null | ITimestamp
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
Implementation of
ILocalActivityMarkerData.originalScheduleTime
seq
• seq: number
LocalActivityMarkerData seq.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this LocalActivityMarkerData to JSON.
Returns
Object
JSON object
create
▸ create(properties?): LocalActivityMarkerData
Creates a new LocalActivityMarkerData instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ILocalActivityMarkerData | Properties to set |
Returns
LocalActivityMarkerData instance
decode
▸ decode(reader, length?): LocalActivityMarkerData
Decodes a LocalActivityMarkerData 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
LocalActivityMarkerData
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): LocalActivityMarkerData
Decodes a LocalActivityMarkerData message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | ILocalActivityMarkerData | LocalActivityMarkerData message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | ILocalActivityMarkerData | LocalActivityMarkerData message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
LocalActivityMarkerData
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for LocalActivityMarkerData
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 LocalActivityMarkerData message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | LocalActivityMarkerData | LocalActivityMarkerData |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object