Skip to main content
Version: 1.21.x

Replication Settings Module

Classes​

ReplicationSettings​

Defined in: messages/ReplicationSettings.ts:31

Replication settings

Constructors​

Constructor​

> new ReplicationSettings(): ReplicationSettings

Returns​

ReplicationSettings

Properties​

compression?​

> readonly optional compression: ReplicationCompression

Defined in: messages/ReplicationSettings.ts:75

Wire compression for replication batch payload transfer.


dstBucket​

> readonly dstBucket: string = ""

Defined in: messages/ReplicationSettings.ts:40

Destination bucket. Must exist.


dstHost​

> readonly dstHost: string = ""

Defined in: messages/ReplicationSettings.ts:45

Destination host. Must exist.


dstPrefix?​

> readonly optional dstPrefix: string

Defined in: messages/ReplicationSettings.ts:60

Prefix to add to destination entry names.


dstToken?​

> readonly optional dstToken: string

Defined in: messages/ReplicationSettings.ts:50

Destination token. Must have write access to the destination bucket.


entries​

> readonly entries: string[] = []

Defined in: messages/ReplicationSettings.ts:55

List of entries to replicate. If empty, all entries are replicated. Wildcards are supported.


mode?​

> readonly optional mode: ReplicationMode

Defined in: messages/ReplicationSettings.ts:70

Replication mode


srcBucket​

> readonly srcBucket: string = ""

Defined in: messages/ReplicationSettings.ts:35

Source bucket. Must exist.


when?​

> readonly optional when: any

Defined in: messages/ReplicationSettings.ts:65

Conditional query

Methods​

parse()​

> static parse(data): ReplicationSettings

Defined in: messages/ReplicationSettings.ts:77

Parameters​
data​

OriginalReplicationSettings

Returns​

ReplicationSettings


serialize()​

> static serialize(data): OriginalReplicationSettings

Defined in: messages/ReplicationSettings.ts:91

Parameters​
data​

ReplicationSettings

Returns​

OriginalReplicationSettings