Skip to main content
Version: 1.21.x

Replication Module

Message types for the Replication API

ReplicationMode​

class ReplicationMode(str, Enum)

Replication mode

ReplicationCompression​

class ReplicationCompression(str, Enum)

Replication batch payload compression

ReplicationInfo​

class ReplicationInfo(BaseModel)

Replication information

name​

name of the replication

is_provisioned​

replication is provisioned and can't be deleted or changed

is_active​

replication is active and the remote server is reachable

mode​

current replication mode

pending_records​

number of records to replicate

ReplicationList​

class ReplicationList(BaseModel)

List of replications

replications​

list of replications

ReplicationDiagnosticsError​

class ReplicationDiagnosticsError(BaseModel)

Error information for replication

count​

number of times this error occurred

last_message​

last error message for this error

ReplicationDiagnosticsDetail​

class ReplicationDiagnosticsDetail(BaseModel)

Diagnostics information for replication

ok​

number of successful replications

errored​

number of failed replications

errors​

list of errors grouped by status code

ReplicationDiagnostics​

class ReplicationDiagnostics(BaseModel)

Detailed diagnostics for replication

hourly​

hourly diagnostics

ReplicationSettings​

class ReplicationSettings(BaseModel)

Settings for creating a replication

src_bucket​

source bucket name

dst_bucket​

destination bucket name

dst_host​

url of the destination instance

dst_token​

access token for the destination instance

entries​

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

dst_prefix​

prefix to add to destination entry names

when​

replication schedule in cron format

mode​

replication mode

compression​

replication batch payload compression

ReplicationDetailInfo​

class ReplicationDetailInfo(BaseModel)

Complete information about a replication

diagnostics​

diagnostics information

info​

replication information

settings​

replication settings