Skip to main content

Class: MarkerRecordedEventAttributes

Represents a MarkerRecordedEventAttributes.

Properties​

details​

details: object

Serialized information recorded in the marker

Index Signature​

[k: string]: $Properties

failure?​

optional failure?: $Properties | null

Some uses of markers, like a local activity, could "fail". If they did that is recorded here.

optional header?: $Properties | null

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()​

Call Signature​

static create(properties?): MarkerRecordedEventAttributes & $Shape

Creates a new MarkerRecordedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

MarkerRecordedEventAttributes & $Shape

MarkerRecordedEventAttributes instance

Call Signature​

static create(properties?): MarkerRecordedEventAttributes

Creates a new MarkerRecordedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

MarkerRecordedEventAttributes

MarkerRecordedEventAttributes instance

decode()​

static decode(reader, length?): MarkerRecordedEventAttributes & $Shape

Decodes a MarkerRecordedEventAttributes message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): MarkerRecordedEventAttributes & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified MarkerRecordedEventAttributes message. Does not implicitly temporal.api.history.v1.MarkerRecordedEventAttributes.verify|verify messages.

Parameters​

message​

$Properties

MarkerRecordedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified MarkerRecordedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.MarkerRecordedEventAttributes.verify|verify messages.

Parameters​

message​

$Properties

MarkerRecordedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): MarkerRecordedEventAttributes

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

Parameters​

object​

Plain object

Returns​

MarkerRecordedEventAttributes

MarkerRecordedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

MarkerRecordedEventAttributes

MarkerRecordedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object