Skip to main content
Version: 1.18.x

Bucket Settings Module

Classes​

BucketSettings​

Defined in: messages/BucketSettings.ts:10

Represents bucket settings

Constructors​

Constructor​

> new BucketSettings(): BucketSettings

Returns​

BucketSettings

Properties​

maxBlockRecords?​

> readonly optional maxBlockRecords: bigint

Defined in: messages/BucketSettings.ts:19

Maximum number of records in a block


maxBlockSize?​

> readonly optional maxBlockSize: bigint

Defined in: messages/BucketSettings.ts:14

Maximal block size in a block


quotaSize?​

> readonly optional quotaSize: bigint

Defined in: messages/BucketSettings.ts:31

Quota size in bytes


quotaType?​

> readonly optional quotaType: QuotaType

Defined in: messages/BucketSettings.ts:26

Quota type. The storage supports two types: NONE: A bucket will consume the whole free disk space. FIFO: A bucket removes the oldest block of some entry, when it reaches the quota limit.

Methods​

parse()​

> static parse(data): BucketSettings

Defined in: messages/BucketSettings.ts:33

Parameters​
data​

OriginalBucketSettings

Returns​

BucketSettings


serialize()​

> static serialize(settings): OriginalBucketSettings

Defined in: messages/BucketSettings.ts:46

Parameters​
settings​

BucketSettings

Returns​

OriginalBucketSettings

Enumerations​

QuotaType​

Defined in: messages/BucketSettings.ts:1

Enumeration Members​

FIFO​

> FIFO: 1

Defined in: messages/BucketSettings.ts:3


HARD​

> HARD: 2

Defined in: messages/BucketSettings.ts:4


NONE​

> NONE: 0

Defined in: messages/BucketSettings.ts:2