CreateBackupRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes
const string	CHECKSUM = "checksum"
	Whether or not to calculate checksums for backup files. More...
const string	TRUE = "true"
const string	FALSE = "false"
const string	COMMENT = "comment"
	Comments to store with this backup. More...
const string	DDL_ONLY = "ddl_only"
	Whether or not, for tables, to only backup DDL and not table data. More...
const string	DELETE_INTERMEDIATE_BACKUPS = "delete_intermediate_backups"
	Whether or not to delete any intermediate snapshots when the backup_type is set to DIFFERENTIAL. More...
const string	DRY_RUN = "dry_run"
	Whether or not to perform a dry run of a backup operation. More...
const string	MAX_INCREMENTAL_BACKUPS_TO_KEEP = "max_incremental_backups_to_keep"
	Maximum number of incremental snapshots to keep. More...
const string	RECREATE = "recreate"
	Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 121 of file CreateBackup.cs.

Member Data Documentation

CHECKSUM

const string CreateBackupRequest.Options.CHECKSUM = "checksum"

Whether or not to calculate checksums for backup files.

Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 136 of file CreateBackup.cs.

COMMENT

const string CreateBackupRequest.Options.COMMENT = "comment"

Comments to store with this backup.

Definition at line 142 of file CreateBackup.cs.

DDL_ONLY

const string CreateBackupRequest.Options.DDL_ONLY = "ddl_only"

Whether or not, for tables, to only backup DDL and not table data.

Supported values:

• TRUE: For tables, only back up DDL, not data.
• FALSE: For tables, back up DDL and data.

The default value is FALSE.

Definition at line 161 of file CreateBackup.cs.

DELETE_INTERMEDIATE_BACKUPS

const string CreateBackupRequest.Options.DELETE_INTERMEDIATE_BACKUPS = "delete_intermediate_backups"

Whether or not to delete any intermediate snapshots when the backup_type is set to DIFFERENTIAL.

Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 177 of file CreateBackup.cs.

DRY_RUN

const string CreateBackupRequest.Options.DRY_RUN = "dry_run"

Whether or not to perform a dry run of a backup operation.

Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 192 of file CreateBackup.cs.

FALSE

const string CreateBackupRequest.Options.FALSE = "false"

Definition at line 139 of file CreateBackup.cs.

MAX_INCREMENTAL_BACKUPS_TO_KEEP

const string CreateBackupRequest.Options.MAX_INCREMENTAL_BACKUPS_TO_KEEP = "max_incremental_backups_to_keep"

Maximum number of incremental snapshots to keep.

The default value is '-1'.

Definition at line 196 of file CreateBackup.cs.

RECREATE

const string CreateBackupRequest.Options.RECREATE = "recreate"

Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists.

Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 211 of file CreateBackup.cs.

TRUE

const string CreateBackupRequest.Options.TRUE = "true"

Definition at line 138 of file CreateBackup.cs.

---

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

• Kinetica/Protocol/CreateBackup.cs