Class: InboundUpdate
v1.EventGroupMarker.InboundUpdate
The identifier of an inbound Update (request.meta.update_id) whose handler triggered implicit creation of this group Marker.
Used in place of inbound_event_id for Updates because the event ID of the
UpdateAccepted history event is not known until the Workflow Task is
completed and recorded by the server, which may be too late.
Properties
inboundUpdateId
• inboundUpdateId: string
InboundUpdate inboundUpdateId.
Methods
toJSON
▸ toJSON(): Object
Converts this InboundUpdate to JSON.
Returns
Object
JSON object
create
▸ create(properties?): InboundUpdate & $Properties
Creates a new InboundUpdate instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
InboundUpdate instance
▸ create(properties?): InboundUpdate
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): InboundUpdate & $Properties
Decodes an InboundUpdate 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
InboundUpdate
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): InboundUpdate & $Properties
Decodes an InboundUpdate message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
InboundUpdate
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 InboundUpdate message. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.InboundUpdate.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | InboundUpdate message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified InboundUpdate message, length delimited. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.InboundUpdate.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | InboundUpdate message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): InboundUpdate
Creates an InboundUpdate message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
InboundUpdate
toObject
▸ toObject(message, options?): Object
Creates a plain object from an InboundUpdate message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | InboundUpdate | InboundUpdate |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object