AlterBackupRequest Class Reference

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

Inheritance diagram for AlterBackupRequest:

Collaboration diagram for AlterBackupRequest:

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

Public Member Functions
	AlterBackupRequest ()
	Constructs an AlterBackupRequest object with default parameters. More...
	AlterBackupRequest (string backup_name, string action, string _value, string datasink_name, IDictionary< string, string > options=null)
	Constructs an AlterBackupRequest 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 to be altered. More...
string	action [get, set]
	Operation to be applied. More...
string	_value [get, set]
	Value of the modification, depending on action. More...
string	datasink_name [get, set]
	Data sink 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.alterBackup.

Alters an existing database backup, accessible via the data sink specified by datasink_name.

Definition at line 19 of file AlterBackup.cs.

Constructor & Destructor Documentation

AlterBackupRequest() [1/2]

AlterBackupRequest.AlterBackupRequest ( )

inline

Constructs an AlterBackupRequest object with default parameters.

Definition at line 150 of file AlterBackup.cs.

AlterBackupRequest() [2/2]

AlterBackupRequest.AlterBackupRequest ( string  backup_name, string  action, string  _value, string  datasink_name, IDictionary< string, string >  options = null  )

inline

Constructs an AlterBackupRequest object with the specified parameters.

Parameters

backup_name	Name of the backup to be altered.
action	Operation to be applied. Supported values: CHECKSUM: Calculate checksum for backed-up files. DDL_ONLY: Whether or not to only save DDL and not back up table data, when taking future snapshots; set _value to 'true' or 'false' for DDL only or DDL and table data, respectively. MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep, when taking future snapshots; set _value to the number of snapshots to keep. MERGE: Merges all snapshots within a backup and creates a single full snapshot. PURGE: Deletes a snapshot from a backup; set _value to the snapshot ID to purge.
_value	Value of the modification, depending on action .
datasink_name	Data sink through which the backup is accessible.
options	Optional parameters. COMMENT: Comments to store with the backup. DRY_RUN: Whether or not to perform a dry run of a backup alteration. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 218 of file AlterBackup.cs.

Property Documentation

_value

string AlterBackupRequest._value

getset

Value of the modification, depending on action.

Definition at line 117 of file AlterBackup.cs.

action

string AlterBackupRequest.action

getset

Operation to be applied.

Supported values:

• CHECKSUM: Calculate checksum for backed-up files.
• DDL_ONLY: Whether or not to only save DDL and not back up table data, when taking future snapshots; set _value to 'true' or 'false' for DDL only or DDL and table data, respectively.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep, when taking future snapshots; set _value to the number of snapshots to keep.
• MERGE: Merges all snapshots within a backup and creates a single full snapshot.
• PURGE: Deletes a snapshot from a backup; set _value to the snapshot ID to purge.

Definition at line 113 of file AlterBackup.cs.

backup_name

string AlterBackupRequest.backup_name

getset

Name of the backup to be altered.

Definition at line 77 of file AlterBackup.cs.

datasink_name

string AlterBackupRequest.datasink_name

getset

Data sink through which the backup is accessible.

Definition at line 120 of file AlterBackup.cs.

options

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

getset

Optional parameters.

• COMMENT: Comments to store with the backup.
• DRY_RUN: Whether or not to perform a dry run of a backup alteration. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 146 of file AlterBackup.cs.

---

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

• Kinetica/Protocol/AlterBackup.cs