Class: 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()
Call Signature
staticcreate(properties?):InboundUpdate&$Properties
Creates a new InboundUpdate instance using the specified properties.
Parameters
properties?
Properties to set
Returns
InboundUpdate & $Properties
InboundUpdate instance
Call Signature
staticcreate(properties?):InboundUpdate
Creates a new InboundUpdate instance using the specified properties.
Parameters
properties?
Properties to set
Returns
InboundUpdate
InboundUpdate instance
decode()
staticdecode(reader,length?):InboundUpdate&$Properties
Decodes an InboundUpdate 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
InboundUpdate & $Properties
InboundUpdate
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):InboundUpdate&$Properties
Decodes an InboundUpdate message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
InboundUpdate & $Properties
InboundUpdate
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified InboundUpdate message. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.InboundUpdate.verify|verify messages.
Parameters
message
InboundUpdate message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified InboundUpdate message, length delimited. Does not implicitly temporal.api.sdk.v1.EventGroupMarker.InboundUpdate.verify|verify messages.
Parameters
message
InboundUpdate message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):InboundUpdate
Creates an InboundUpdate message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
InboundUpdate
InboundUpdate
toObject()
statictoObject(message,options?):object
Creates a plain object from an InboundUpdate message. Also converts values to other types if specified.
Parameters
message
InboundUpdate
InboundUpdate
options?
IConversionOptions
Conversion options
Returns
object
Plain object