> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.AlterBackupRequest > kinetica.AlterBackupRequest — Kinetica C# API

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

Inheritance diagram for kinetica.AlterBackupRequest:
Collaboration diagram for kinetica.AlterBackupRequest:

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

Public Member Functions
  AlterBackupRequest ()
  Constructs an AlterBackupRequest object with default parameters.
 
  AlterBackupRequest (string backup\_name, string action, string \_value, string datasink\_name, IDictionary\< string, string > options=null)
  Constructs an AlterBackupRequest object with the specified parameters.
 
  AlterBackupRequest ()
  Constructs an AlterBackupRequest object with default parameters.
 
  AlterBackupRequest (string backup\_name, string action, string \_value, string datasink\_name, IDictionary\< string, string > options=null)
  Constructs an AlterBackupRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  backup\_name \[get, set]
  Name of the backup to be altered.
 
string  action \[get, set]
  Operation to be applied.
 
string  \_value \[get, set]
  Value of the modification, depending on AlterBackupRequest.action.
 
string  datasink\_name \[get, set]
  Data sink through which the backup is accessible.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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

Detailed Description

A set of parameters for Kinetica.alterBackup.

Alters an existing database backup, accessible via the data sink specified by AlterBackupRequest.datasink\_name.

Definition at line 19 of file AlterBackup.cs.

Constructor & Destructor Documentation

◆ AlterBackupRequest() \[1/4]

kinetica.AlterBackupRequest.AlterBackupRequest ( )
inline

Constructs an AlterBackupRequest object with default parameters.

Definition at line 174 of file AlterBackup.cs.

◆ AlterBackupRequest() \[2/4]

kinetica.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: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 255 of file AlterBackup.cs.

◆ AlterBackupRequest() \[3/4]

kinetica.AlterBackupRequest.AlterBackupRequest ( )
inline

Constructs an AlterBackupRequest object with default parameters.

Definition at line 174 of file AlterBackup.cs.

◆ AlterBackupRequest() \[4/4]

kinetica.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: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 255 of file AlterBackup.cs.

Property Documentation

◆ \_value

string kinetica.AlterBackupRequest.\_value
getset

Value of the modification, depending on AlterBackupRequest.action.

Definition at line 134 of file AlterBackup.cs.

◆ action

string kinetica.AlterBackupRequest.action
getset

Operation to be applied.

Supported values:

Definition at line 130 of file AlterBackup.cs.

◆ backup\_name

string kinetica.AlterBackupRequest.backup\_name
getset

Name of the backup to be altered.

Definition at line 86 of file AlterBackup.cs.

◆ datasink\_name

string kinetica.AlterBackupRequest.datasink\_name
getset

Data sink through which the backup is accessible.

Definition at line 137 of file AlterBackup.cs.

◆ options

IDictionary\< string, string > kinetica.AlterBackupRequest.options = new Dictionary\()
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: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 170 of file AlterBackup.cs.

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