GPUdb C++ API  Version 7.2.3.0
gpudb::VerifyBackupRequest Struct Reference

A set of parameters for GPUdb::verifyBackup. More...

#include <gpudb/protocol/verify_backup.h>

Public Member Functions

 VerifyBackupRequest ()
 Constructs a VerifyBackupRequest object with default parameters. More...
 
 VerifyBackupRequest (const std::string &backupName_, const std::string &datasourceName_, const std::map< std::string, std::string > &options_)
 Constructs a VerifyBackupRequest object with the specified parameters. More...
 

Public Attributes

std::string backupName
 Name of the backup. More...
 
std::string datasourceName
 Data source through which the backup is accessible. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::verifyBackup.

Inspects the requested database backup(s) for conformity at the remote file store accessible via the data source specified by datasourceName. By default all snapshots are inspected unless the option backup_id is used to target a specific instance. Returns backup verification results.

Definition at line 26 of file verify_backup.h.

Constructor & Destructor Documentation

◆ VerifyBackupRequest() [1/2]

gpudb::VerifyBackupRequest::VerifyBackupRequest ( )
inline

Constructs a VerifyBackupRequest object with default parameters.

Definition at line 31 of file verify_backup.h.

◆ VerifyBackupRequest() [2/2]

gpudb::VerifyBackupRequest::VerifyBackupRequest ( const std::string &  backupName_,
const std::string &  datasourceName_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a VerifyBackupRequest object with the specified parameters.

Parameters
[in]backupName_Name of the backup. An empty string or '*' will check all existing backups. Any text followed by a '*' will inspect backups whose name starts with that text. The default value is ''.
[in]datasourceName_Data source through which the backup is accessible.
[in]options_Optional parameters.
  • verify_backup_backup_id: ID of the snapshot to verify. Set to '-1' to verify only the most recent snapshot in the backup. Leave empty to verify all snapshots. The default value is '-1'.
The default value is an empty map.

Definition at line 61 of file verify_backup.h.

Member Data Documentation

◆ backupName

std::string gpudb::VerifyBackupRequest::backupName

Name of the backup.

An empty string or '*' will check all existing backups. Any text followed by a '*' will inspect backups whose name starts with that text. The default value is ''.

Definition at line 73 of file verify_backup.h.

◆ datasourceName

std::string gpudb::VerifyBackupRequest::datasourceName

Data source through which the backup is accessible.

Definition at line 78 of file verify_backup.h.

◆ options

std::map<std::string, std::string> gpudb::VerifyBackupRequest::options

Optional parameters.

  • verify_backup_backup_id: ID of the snapshot to verify. Set to '-1' to verify only the most recent snapshot in the backup. Leave empty to verify all snapshots. The default value is '-1'.

The default value is an empty map.

Definition at line 91 of file verify_backup.h.


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