Skip to main content

Class: StorageDriverInfo

worker.v1.StorageDriverInfo

Represents a StorageDriverInfo.

Properties​

type​

• type: string

The type of the driver, required.

Methods​

toJSON​

▸ toJSON(): Object

Converts this StorageDriverInfo to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): StorageDriverInfo & $Properties

Creates a new StorageDriverInfo instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

StorageDriverInfo & $Properties

StorageDriverInfo instance

▸ create(properties?): StorageDriverInfo

Parameters​

NameType
properties?$Properties

Returns​

StorageDriverInfo


decode​

▸ decode(reader, length?): StorageDriverInfo & $Properties

Decodes a StorageDriverInfo message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

StorageDriverInfo & $Properties

StorageDriverInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): StorageDriverInfo & $Properties

Decodes a StorageDriverInfo message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

StorageDriverInfo & $Properties

StorageDriverInfo

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

Parameters​

NameTypeDescription
message$PropertiesStorageDriverInfo message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesStorageDriverInfo message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): StorageDriverInfo

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

StorageDriverInfo

StorageDriverInfo


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageStorageDriverInfoStorageDriverInfo
options?IConversionOptionsConversion options

Returns​

Object

Plain object