Class: MarkerRecordedEventAttributes
history.v1.MarkerRecordedEventAttributes
Represents a MarkerRecordedEventAttributes.
Properties
details
• details: Object
Serialized information recorded in the marker
Index signature
▪ [k: string]: $Properties
failure
• Optional failure: null | $Properties
Some uses of markers, like a local activity, could "fail". If they did that is recorded here.
header
• Optional header: null | $Properties
MarkerRecordedEventAttributes header.
markerName
• markerName: string
Workers use this to identify the "types" of various markers. Ex: Local activity, side effect.
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED event which this command was reported with
Methods
toJSON
▸ toJSON(): Object
Converts this MarkerRecordedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): MarkerRecordedEventAttributes & $Shape
Creates a new MarkerRecordedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
MarkerRecordedEventAttributes & $Shape
MarkerRecordedEventAttributes instance
▸ create(properties?): MarkerRecordedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): MarkerRecordedEventAttributes & $Shape
Decodes a MarkerRecordedEventAttributes 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
MarkerRecordedEventAttributes & $Shape
MarkerRecordedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): MarkerRecordedEventAttributes & $Shape
Decodes a MarkerRecordedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
MarkerRecordedEventAttributes & $Shape
MarkerRecordedEventAttributes
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 MarkerRecordedEventAttributes message. Does not implicitly temporal.api.history.v1.MarkerRecordedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | MarkerRecordedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified MarkerRecordedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.MarkerRecordedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | MarkerRecordedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): MarkerRecordedEventAttributes
Creates a MarkerRecordedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
MarkerRecordedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a MarkerRecordedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | MarkerRecordedEventAttributes | MarkerRecordedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object