com.netflix.priam.backupv2

Class MetaFileWriterBuilder.MetaFileWriter

java.lang.Object

com.netflix.priam.backupv2.MetaFileWriterBuilder.MetaFileWriter

All Implemented Interfaces:

MetaFileWriterBuilder.DataStep, MetaFileWriterBuilder.StartStep, MetaFileWriterBuilder.UploadStep

Enclosing class:

MetaFileWriterBuilder

public static class MetaFileWriterBuilder.MetaFileWriter
extends java.lang.Object
implements MetaFileWriterBuilder.StartStep, MetaFileWriterBuilder.DataStep, MetaFileWriterBuilder.UploadStep

Method Summary

Modifier and Type	Method and Description
MetaFileWriterBuilder.DataStep	addColumnfamilyResult(ColumnfamilyResult columnfamilyResult) Add ColumnfamilyResult after it has been processed so it can be streamed to meta.json.
MetaFileWriterBuilder.UploadStep	endMetaFileGeneration() Finish the generation of meta.json file and save it on local media.
java.nio.file.Path	getMetaFilePath()
java.lang.String	getRemoteMetaFilePath()
MetaFileWriterBuilder.DataStep	startMetaFileGeneration(java.time.Instant snapshotInstant) Start the generation of meta file.
void	uploadMetaFile(boolean deleteOnSuccess) Upload the meta file generated to backup file system.

Methods inherited from class java.lang.Object

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

Method Detail

startMetaFileGeneration

public MetaFileWriterBuilder.DataStep startMetaFileGeneration(java.time.Instant snapshotInstant)
                                                       throws java.io.IOException

Start the generation of meta file.

Specified by:

startMetaFileGeneration in interface MetaFileWriterBuilder.StartStep

Throws:

java.io.IOException - if unable to write to meta file (permissions, disk full etc)

addColumnfamilyResult

public MetaFileWriterBuilder.DataStep addColumnfamilyResult(ColumnfamilyResult columnfamilyResult)
                                                     throws java.io.IOException

Add ColumnfamilyResult after it has been processed so it can be streamed to meta.json. Streaming write to meta.json is required so we don't get Priam OOM.

Specified by:

addColumnfamilyResult in interface MetaFileWriterBuilder.DataStep

Parameters:

columnfamilyResult - a POJO encapsulating the column family result

Throws:

java.io.IOException - if unable to write to the file or if JSON is not valid

endMetaFileGeneration

public MetaFileWriterBuilder.UploadStep endMetaFileGeneration()
                                                       throws java.io.IOException

Finish the generation of meta.json file and save it on local media.

Specified by:

endMetaFileGeneration in interface MetaFileWriterBuilder.DataStep

Returns:

Path to the local meta.json produced.

Throws:

java.io.IOException - if unable to write to file or if JSON is not valid

uploadMetaFile

public void uploadMetaFile(boolean deleteOnSuccess)
                    throws java.lang.Exception

Upload the meta file generated to backup file system.

Specified by:

uploadMetaFile in interface MetaFileWriterBuilder.UploadStep

Parameters:

deleteOnSuccess - delete the meta file from local file system if backup is successful. Useful for testing purposes

Throws:

java.lang.Exception - when unable to upload the meta file.

getMetaFilePath

public java.nio.file.Path getMetaFilePath()

Specified by:

getMetaFilePath in interface MetaFileWriterBuilder.UploadStep

getRemoteMetaFilePath

public java.lang.String getRemoteMetaFilePath()
                                       throws java.lang.Exception

Specified by:

getRemoteMetaFilePath in interface MetaFileWriterBuilder.UploadStep

Throws:

java.lang.Exception