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.
Implements
Constructors
constructor
• new Payload(properties?): Payload
Constructs a new Payload.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPayload | Properties to set |
Returns
Properties
data
• data: Uint8Array
Payload data.
Implementation of
metadata
• metadata: Object
Payload metadata.
Index signature
▪ [k: string]: Uint8Array
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Payload to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Payload
Creates a new Payload instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPayload | Properties to set |
Returns
Payload instance
decode
▸ decode(reader, length?): Payload
Decodes a Payload 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
Payload
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Payload
Decodes a Payload message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Payload
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 Payload message. Does not implicitly temporal.api.common.v1.Payload.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPayload | Payload message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Payload message, length delimited. Does not implicitly temporal.api.common.v1.Payload.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPayload | Payload message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Payload
Creates a Payload message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Payload
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Payload
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 a Payload message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Payload | Payload |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object