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

Public Member Functions
	ShowBackupRequest ()
	Constructs a ShowBackupRequest object with default parameters. More...

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

Public Attributes
std::string	backupName
	Name of the backup object. More...

std::string	datasourceName
	Datasource where backup is located. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::showBackup.

Shows information about a backup Returns detailed information about one or more backup instances.

Definition at line 18 of file show_backup.h.

Constructor & Destructor Documentation

gpudb::ShowBackupRequest::ShowBackupRequest ( )

inline

Constructs a ShowBackupRequest object with default parameters.

Definition at line 23 of file show_backup.h.

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

inline

Constructs a ShowBackupRequest object with the specified parameters.

Parameters

[in]	backupName_	Name of the backup object. An empty string or '*' will return all existing backups. The default value is ''.
[in]	datasourceName_	Datasource where backup is located.
[in]	options_	Optional parameters. show_backup_backup_id: Backup instance ID to show. Leave empty to show information from the most recent backup instance in the container. The default value is ''. show_backup_show_contents: Shows the contents of the specified backup_id. Supported values: show_backup_none: No backup contents show_backup_object_names: Object names only show_backup_object_files: Object names and files The default value is show_backup_none. show_backup_no_error_if_not_exists: If false will return an error if the provided backupName_ does not exist. If true then it will return an empty result. Supported values: show_backup_true show_backup_false The default value is show_backup_false. The default value is an empty map.

Definition at line 86 of file show_backup.h.

std::string gpudb::ShowBackupRequest::backupName

Name of the backup object.

An empty string or '*' will return all existing backups. The default value is ''.

Definition at line 97 of file show_backup.h.

std::string gpudb::ShowBackupRequest::datasourceName

Datasource where backup is located.

Definition at line 102 of file show_backup.h.

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

Optional parameters.

show_backup_backup_id: Backup instance ID to show. Leave empty to show information from the most recent backup instance in the container. The default value is ''.
show_backup_show_contents: Shows the contents of the specified backup_id. Supported values:
- show_backup_none: No backup contents
- show_backup_object_names: Object names only
- show_backup_object_files: Object names and files
The default value is show_backup_none.
show_backup_no_error_if_not_exists: If false will return an error if the provided backupName does not exist. If true then it will return an empty result. Supported values:
- show_backup_true
- show_backup_false
The default value is show_backup_false.

The default value is an empty map.

Definition at line 141 of file show_backup.h.

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