Class: Payload
Represents some binary (byte array) data (ex: activity input parameters or workflow result) with metadata which describes this binary data (format, encoding, encryption, etc). Serialization of the data may be user-defined.
Properties
data
data:
Uint8Array
Payload data.
externalPayloads
externalPayloads:
$Properties[]
Details about externally stored payloads associated with this payload.
metadata
metadata:
object
Payload metadata.
Index Signature
[k: string]: Uint8Array<ArrayBufferLike>
Methods
toJSON()
toJSON():
object
Converts this Payload to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):Payload&$Properties
Creates a new Payload instance using the specified properties.
Parameters
properties?
Properties to set
Returns
Payload & $Properties
Payload instance
Call Signature
staticcreate(properties?):Payload
Creates a new Payload instance using the specified properties.
Parameters
properties?
Properties to set
Returns
Payload
Payload instance
decode()
staticdecode(reader,length?):Payload&$Properties
Decodes a Payload 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
Payload & $Properties
Payload
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):Payload&$Properties
Decodes a Payload message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
Payload & $Properties
Payload
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 Payload message. Does not implicitly temporal.api.common.v1.Payload.verify|verify messages.
Parameters
message
Payload message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified Payload message, length delimited. Does not implicitly temporal.api.common.v1.Payload.verify|verify messages.
Parameters
message
Payload message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):Payload
Creates a Payload message from a plain object. Also converts values to their respective internal types.
Parameters
object
{[k: string]: any; }
Plain object
Returns
Payload
Payload
toObject()
statictoObject(message,options?):object
Creates a plain object from a Payload message. Also converts values to other types if specified.
Parameters
message
Payload
Payload
options?
IConversionOptions
Conversion options
Returns
object
Plain object