Skip to main content

Class: InboundEvent

v1.EventGroupMarker.InboundEvent

The event ID of an event in the present workflow that triggered implicit creation of this group Marker.

The target event's type must be one of the following:

  • WORKFLOW_EXECUTION_STARTED
  • WORKFLOW_EXECUTION_SIGNALED

Properties​

inboundEventId​

• inboundEventId: Long

InboundEvent inboundEventId.

Methods​

toJSON​

▸ toJSON(): Object

Converts this InboundEvent to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): InboundEvent & $Properties

Creates a new InboundEvent instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

InboundEvent & $Properties

InboundEvent instance

▸ create(properties?): InboundEvent

Parameters​

NameType
properties?$Properties

Returns​

InboundEvent


decode​

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

Decodes an InboundEvent message from the specified reader or buffer.

Parameters​

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

Returns​

InboundEvent & $Properties

InboundEvent

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): InboundEvent & $Properties

Decodes an InboundEvent message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

InboundEvent & $Properties

InboundEvent

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 InboundEvent message. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.InboundEvent.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified InboundEvent message, length delimited. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.InboundEvent.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): InboundEvent

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

InboundEvent

InboundEvent


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageInboundEventInboundEvent
options?IConversionOptionsConversion options

Returns​

Object

Plain object