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