fbcpp::BackupOptions Class Reference

Represents options used to run a backup operation through the service manager. More...

#include <BackupManager.h>

Classes
struct	BackupFileSpec

Public Member Functions
const std::string &	getDatabase () const
	Returns the database path to be backed up.
BackupOptions &	setDatabase (const std::string &value)
	Sets the database path to be backed up.
const std::vector< BackupFileSpec > &	getBackupFiles () const
	Returns the configured backup file specifications.
BackupOptions &	addBackupFile (const std::string &value)
	Appends a backup file path.
BackupOptions &	addBackupFile (const std::string &value, std::uint64_t length)
	Appends a backup file path with a split length.
BackupOptions &	setBackupFile (const std::string &value)
	Replaces the backup file paths with a single path.
BackupOptions &	setBackupFile (const std::string &value, std::uint64_t length)
	Replaces the backup file paths with a single path and split length.
const ServiceManager::VerboseOutput &	getVerboseOutput () const
	Returns the verbose output callback.
BackupOptions &	setVerboseOutput (ServiceManager::VerboseOutput value)
	Sets the verbose output callback.
const std::optional< std::uint32_t > &	getParallelWorkers () const
	Returns the requested number of parallel workers.
BackupOptions &	setParallelWorkers (std::uint32_t value)
	Sets the requested number of parallel workers.

Detailed Description

Represents options used to run a backup operation through the service manager.

Definition at line 44 of file BackupManager.h.

Member Function Documentation

addBackupFile() [1/2]

BackupOptions & fbcpp::BackupOptions::addBackupFile ( const std::string &  value )

inline

Appends a backup file path.

Definition at line 82 of file BackupManager.h.

addBackupFile() [2/2]

BackupOptions & fbcpp::BackupOptions::addBackupFile ( const std::string &  value, std::uint64_t  length  )

inline

Appends a backup file path with a split length.

Definition at line 91 of file BackupManager.h.

getBackupFiles()

const std::vector< BackupFileSpec > & fbcpp::BackupOptions::getBackupFiles ( ) const

inline

Returns the configured backup file specifications.

Definition at line 74 of file BackupManager.h.

getDatabase()

const std::string & fbcpp::BackupOptions::getDatabase ( ) const

inline

Returns the database path to be backed up.

Definition at line 57 of file BackupManager.h.

getParallelWorkers()

const std::optional< std::uint32_t > & fbcpp::BackupOptions::getParallelWorkers ( ) const

inline

Returns the requested number of parallel workers.

Definition at line 138 of file BackupManager.h.

getVerboseOutput()

const ServiceManager::VerboseOutput & fbcpp::BackupOptions::getVerboseOutput ( ) const

inline

Returns the verbose output callback.

Definition at line 121 of file BackupManager.h.

setBackupFile() [1/2]

BackupOptions & fbcpp::BackupOptions::setBackupFile ( const std::string &  value )

inline

Replaces the backup file paths with a single path.

Definition at line 103 of file BackupManager.h.

setBackupFile() [2/2]

BackupOptions & fbcpp::BackupOptions::setBackupFile ( const std::string &  value, std::uint64_t  length  )

inline

Replaces the backup file paths with a single path and split length.

Definition at line 112 of file BackupManager.h.

setDatabase()

BackupOptions & fbcpp::BackupOptions::setDatabase ( const std::string &  value )

inline

Sets the database path to be backed up.

Definition at line 65 of file BackupManager.h.

setParallelWorkers()

BackupOptions & fbcpp::BackupOptions::setParallelWorkers ( std::uint32_t  value )

inline

Sets the requested number of parallel workers.

Definition at line 146 of file BackupManager.h.

setVerboseOutput()

BackupOptions & fbcpp::BackupOptions::setVerboseOutput ( ServiceManager::VerboseOutput  value )

inline

Sets the verbose output callback.

Definition at line 129 of file BackupManager.h.

---

The documentation for this class was generated from the following file:

• src/fb-cpp/BackupManager.h