Skip to main content

Class: ExternalPayloadDetails

Describes an externally stored object referenced by this payload.

Properties​

sizeBytes​

sizeBytes: Long

Size in bytes of the externally stored payload

Methods​

toJSON()​

toJSON(): object

Converts this ExternalPayloadDetails to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ExternalPayloadDetails & $Properties

Creates a new ExternalPayloadDetails instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExternalPayloadDetails & $Properties

ExternalPayloadDetails instance

Call Signature​

static create(properties?): ExternalPayloadDetails

Creates a new ExternalPayloadDetails instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExternalPayloadDetails

ExternalPayloadDetails instance

decode()​

static decode(reader, length?): ExternalPayloadDetails & $Properties

Decodes an ExternalPayloadDetails 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​

ExternalPayloadDetails & $Properties

ExternalPayloadDetails

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ExternalPayloadDetails & $Properties

Decodes an ExternalPayloadDetails message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ExternalPayloadDetails & $Properties

ExternalPayloadDetails

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ExternalPayloadDetails message. Does not implicitly temporal.api.common.v1.Payload.ExternalPayloadDetails.verify|verify messages.

Parameters​

message​

$Properties

ExternalPayloadDetails message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ExternalPayloadDetails message, length delimited. Does not implicitly temporal.api.common.v1.Payload.ExternalPayloadDetails.verify|verify messages.

Parameters​

message​

$Properties

ExternalPayloadDetails message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ExternalPayloadDetails

Creates an ExternalPayloadDetails message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

ExternalPayloadDetails

ExternalPayloadDetails

toObject()​

static toObject(message, options?): object

Creates a plain object from an ExternalPayloadDetails message. Also converts values to other types if specified.

Parameters​

message​

ExternalPayloadDetails

ExternalPayloadDetails

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object