A set of parameters for Kinetica.showBackup. More...

Inheritance diagram for ShowBackupRequest:

Collaboration diagram for ShowBackupRequest:

Classes
struct	Options
	A set of string constants for the parameter options. More...

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

	ShowBackupRequest (string backup_name, string datasource_name, IDictionary< string, string > options=null)
	Constructs a ShowBackupRequest object with the specified parameters. More...

Public Member Functions inherited from KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	backup_name = "" `[get, set]`
	Name of the backup. More...

string	datasource_name `[get, set]`
	Data source through which the backup is accessible. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

Additional Inherited Members
Static Public Member Functions inherited from KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.showBackup.

Shows information about one or more backups accessible via the data source specified by datasource_name.

Definition at line 19 of file ShowBackup.cs.

Constructor & Destructor Documentation

◆ ShowBackupRequest() [1/2]

ShowBackupRequest.ShowBackupRequest ( )

inline

Constructs a ShowBackupRequest object with default parameters.

Definition at line 222 of file ShowBackup.cs.

◆ ShowBackupRequest() [2/2]

ShowBackupRequest.ShowBackupRequest	(	string	backup_name,
		string	datasource_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a ShowBackupRequest object with the specified parameters.

Parameters

backup_name	Name of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ''.
datasource_name	Data source through which the backup is accessible.
options	Optional parameters. BACKUP_ID: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ''. BACKUP_TYPE: Show backups by type. This option is ignored if BACKUP_ID is non-empty. Supported values: ALL: Show all backup types. FULL: Show full backups only. INCREMENTAL: Show incremental backups only. DIFFERENTIAL: Show differential backups only. The default value is ALL. SHOW_CONTENTS: Show the contents of the backed-up snapshots. Supported values: NONE: Don't show snapshot contents. OBJECT_NAMES: Show backed-up object names, and for tables, sizing detail. OBJECT_FILES: Show backed-up object names, and for tables, sizing detail and associated files. The default value is NONE. NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 319 of file ShowBackup.cs.

Property Documentation

◆ backup_name

string ShowBackupRequest.backup_name = ""

getset

Name of the backup.

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

Definition at line 127 of file ShowBackup.cs.

◆ datasource_name

string ShowBackupRequest.datasource_name

getset

Data source through which the backup is accessible.

Definition at line 130 of file ShowBackup.cs.

◆ options

IDictionary<string, string> ShowBackupRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

BACKUP_ID: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ''.
BACKUP_TYPE: Show backups by type. This option is ignored if BACKUP_ID is non-empty. Supported values:
- ALL: Show all backup types.
- FULL: Show full backups only.
- INCREMENTAL: Show incremental backups only.
- DIFFERENTIAL: Show differential backups only.
The default value is ALL.
SHOW_CONTENTS: Show the contents of the backed-up snapshots. Supported values:
- NONE: Don't show snapshot contents.
- OBJECT_NAMES: Show backed-up object names, and for tables, sizing detail.
- OBJECT_FILES: Show backed-up object names, and for tables, sizing detail and associated files.
The default value is NONE.
NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 218 of file ShowBackup.cs.

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

Kinetica/Protocol/ShowBackup.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShowBackupRequest() [1/2]

◆ ShowBackupRequest() [2/2]

Property Documentation

◆ backup_name

◆ datasource_name

◆ options