Package io.camunda.zeebe.backup.s3

Class S3BackupStore

java.lang.Object

io.camunda.zeebe.backup.s3.S3BackupStore

All Implemented Interfaces:

BackupStore

public final class S3BackupStore
extends Object
implements BackupStore

BackupStore for S3. Stores all backups in a given bucket.

All created object keys are prefixed by the BackupIdentifier, with the following scheme: basePath/partitionId/checkpointId/nodeId.

Each backup contains:

1. A 'manifest' object, containing Manifest serialized as JSON, for example

   partitionId/checkpointId/nodeId/manifest.json

2. Objects for snapshot files, additionally prefixed with 'snapshot', for example

   partitionId/checkpointId/nodeId/snapshots/snapshot-file-1

3. Objects for segment files, additionally prefixed with 'segments', for example

   partitionId/checkpointId/nodeId/segments/segment-file-1

Constructor Summary

Constructors

Constructor	Description
S3BackupStore(S3BackupConfig config)
S3BackupStore(S3BackupConfig config, software.amazon.awssdk.services.s3.S3AsyncClient client)

Method Summary

Modifier and Type	Method	Description
static software.amazon.awssdk.services.s3.S3AsyncClient	buildClient(S3BackupConfig config)
CompletableFuture<Void>	closeAsync()
CompletableFuture<Void>	delete(BackupIdentifier id)
CompletableFuture<BackupStatus>	getStatus(BackupIdentifier id)
CompletableFuture<Collection<BackupStatus>>	list(BackupIdentifierWildcard wildcard)
CompletableFuture<BackupStatusCode>	markFailed(BackupIdentifier id, String failureReason)
String	objectPrefix(BackupIdentifier id)
CompletableFuture<Backup>	restore(BackupIdentifier id, Path targetFolder)
CompletableFuture<Void>	save(Backup backup)
static void	validateConfig(S3BackupConfig config)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

S3BackupStore

public S3BackupStore(S3BackupConfig config)

S3BackupStore

public S3BackupStore(S3BackupConfig config,
 software.amazon.awssdk.services.s3.S3AsyncClient client)

Method Details

objectPrefix

public String objectPrefix(BackupIdentifier id)

validateConfig

public static void validateConfig(S3BackupConfig config)

save

public CompletableFuture<Void> save(Backup backup)

Specified by:

save in interface BackupStore

getStatus

public CompletableFuture<BackupStatus> getStatus(BackupIdentifier id)

Specified by:

getStatus in interface BackupStore

list

public CompletableFuture<Collection<BackupStatus>> list(BackupIdentifierWildcard wildcard)

Specified by:

list in interface BackupStore

delete

public CompletableFuture<Void> delete(BackupIdentifier id)

Specified by:

delete in interface BackupStore

restore

public CompletableFuture<Backup> restore(BackupIdentifier id,
 Path targetFolder)

Specified by:

restore in interface BackupStore

markFailed

public CompletableFuture<BackupStatusCode> markFailed(BackupIdentifier id,
 String failureReason)

Specified by:

markFailed in interface BackupStore

closeAsync

public CompletableFuture<Void> closeAsync()

Specified by:

closeAsync in interface BackupStore

buildClient

public static software.amazon.awssdk.services.s3.S3AsyncClient buildClient(S3BackupConfig config)