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

Inheritance diagram for kinetica.ShowBackupRequest:

Collaboration diagram for kinetica.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...

	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 kinetica.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...

	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 object. More...

string	datasource_name `[get, set]`
	Datasource where backup is located. More...

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

Properties inherited from kinetica.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 kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

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 a backup Returns detailed information about one or more backup instances.

Definition at line 17 of file ShowBackup.cs.

Constructor & Destructor Documentation

◆ ShowBackupRequest() [1/4]

kinetica.ShowBackupRequest.ShowBackupRequest ( )

inline

Constructs a ShowBackupRequest object with default parameters.

Definition at line 150 of file ShowBackup.cs.

◆ ShowBackupRequest() [2/4]

kinetica.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 object. An empty string or '*' will return all existing backups. The default value is ''.
datasource_name	Datasource where backup is located.
options	Optional parameters. 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_CONTENTS: Shows the contents of the specified backup_id. Supported values: NONE: No backup contents OBJECT_NAMES: Object names only OBJECT_FILES: Object names and files The default value is NONE. NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided backup_name does not exist. If TRUE then it will return an empty result. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 217 of file ShowBackup.cs.

◆ ShowBackupRequest() [3/4]

kinetica.ShowBackupRequest.ShowBackupRequest ( )

inline

Constructs a ShowBackupRequest object with default parameters.

Definition at line 150 of file ShowBackup.cs.

◆ ShowBackupRequest() [4/4]

kinetica.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 object. An empty string or '*' will return all existing backups. The default value is ''.
datasource_name	Datasource where backup is located.
options	Optional parameters. 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_CONTENTS: Shows the contents of the specified backup_id. Supported values: NONE: No backup contents OBJECT_NAMES: Object names only OBJECT_FILES: Object names and files The default value is NONE. NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided backup_name does not exist. If TRUE then it will return an empty result. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 217 of file ShowBackup.cs.

Property Documentation

◆ backup_name

string kinetica.ShowBackupRequest.backup_name = ""

getset

Name of the backup object.

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

Definition at line 85 of file ShowBackup.cs.

◆ datasource_name

string kinetica.ShowBackupRequest.datasource_name

getset

Datasource where backup is located.

Definition at line 88 of file ShowBackup.cs.

◆ options

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

getset

Optional parameters.

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_CONTENTS: Shows the contents of the specified backup_id. Supported values:
- NONE: No backup contents
- OBJECT_NAMES: Object names only
- OBJECT_FILES: Object names and files
The default value is NONE.
NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided backup_name does not exist. If TRUE then it will return an empty result. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 146 of file ShowBackup.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowBackup.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShowBackupRequest() [1/4]

◆ ShowBackupRequest() [2/4]

◆ ShowBackupRequest() [3/4]

◆ ShowBackupRequest() [4/4]

Property Documentation

◆ backup_name

◆ datasource_name

◆ options