Class: ExternalStorageReference

ExternalStorageReference identifies a payload stored in an external storage system. It is used as a claim-check token, allowing the actual payload data to be retrieved from the named driver using the provided claim data.

Properties

claimData

claimData: object

Driver-specific key-value pairs that identify and provide access to the stored payload.

Index Signature

[k: string]: string

---

driverName

driverName: string

The name of the storage driver responsible for retrieving the payload.

Methods

toJSON()

toJSON(): object

Converts this ExternalStorageReference to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): ExternalStorageReference & $Properties

Creates a new ExternalStorageReference instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ExternalStorageReference & $Properties

ExternalStorageReference instance

Call Signature

static create(properties?): ExternalStorageReference

Creates a new ExternalStorageReference instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ExternalStorageReference

ExternalStorageReference instance

---

decode()

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

Decodes an ExternalStorageReference 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

ExternalStorageReference & $Properties

ExternalStorageReference

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): ExternalStorageReference & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

ExternalStorageReference & $Properties

ExternalStorageReference

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 ExternalStorageReference message. Does not implicitly temporal.api.sdk.v1.ExternalStorageReference.verify|verify messages.

Parameters

message

$Properties

ExternalStorageReference message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified ExternalStorageReference message, length delimited. Does not implicitly temporal.api.sdk.v1.ExternalStorageReference.verify|verify messages.

Parameters

message

$Properties

ExternalStorageReference message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): ExternalStorageReference

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

Parameters

object

Plain object

Returns

ExternalStorageReference

ExternalStorageReference

---

toObject()

static toObject(message, options?): object

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

Parameters

message

ExternalStorageReference

ExternalStorageReference

options?

IConversionOptions

Conversion options

Returns

object

Plain object