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_STARTEDWORKFLOW_EXECUTION_SIGNALED
Implements
Constructors
constructor
• new InboundEvent(properties?): InboundEvent
Constructs a new InboundEvent.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IInboundEvent | Properties to set |
Returns
Properties
inboundEventId
• inboundEventId: Long
InboundEvent inboundEventId.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this InboundEvent to JSON.
Returns
Object
JSON object
create
▸ create(properties?): InboundEvent
Creates a new InboundEvent instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IInboundEvent | Properties to set |
Returns
InboundEvent instance
decode
▸ decode(reader, length?): InboundEvent
Decodes an InboundEvent 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
InboundEvent
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): InboundEvent
Decodes an InboundEvent message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IInboundEvent | InboundEvent message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IInboundEvent | InboundEvent message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
InboundEvent
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for InboundEvent
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 an InboundEvent message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | InboundEvent | InboundEvent |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object