Class: ExternalStorageReference
sdk.v1.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
▸ create(properties?): ExternalStorageReference & $Properties
Creates a new ExternalStorageReference instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ExternalStorageReference & $Properties
ExternalStorageReference instance
▸ create(properties?): ExternalStorageReference
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ExternalStorageReference & $Properties
Decodes an ExternalStorageReference 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
ExternalStorageReference & $Properties
ExternalStorageReference
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ExternalStorageReference & $Properties
Decodes an ExternalStorageReference message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified ExternalStorageReference message. Does not implicitly temporal.api.sdk.v1.ExternalStorageReference.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ExternalStorageReference message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ExternalStorageReference message, length delimited. Does not implicitly temporal.api.sdk.v1.ExternalStorageReference.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ExternalStorageReference message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ExternalStorageReference
Creates an ExternalStorageReference message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ExternalStorageReference
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ExternalStorageReference message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ExternalStorageReference | ExternalStorageReference |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object