Skip to main content

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

Static Public Attributes

const string BACKUP_ID = “backup_id”
 ID of the snapshot to show.
 
const string BACKUP_TYPE = “backup_type”
 Show backups by type.
 
const string ALL = “all”
 Show all backup types.
 
const string FULL = “full”
 Show full backups only.
 
const string INCREMENTAL = “incremental”
 Show incremental backups only.
 
const string DIFFERENTIAL = “differential”
 Show differential backups only.
 
const string SHOW_CONTENTS = “show_contents”
 Show the contents of the backed-up snapshots.
 
const string NONE = “none”
 Don’t show snapshot contents.
 
const string OBJECT_NAMES = “object_names”
 Show backed-up object names, and for tables, sizing detail.
 
const string OBJECT_FILES = “object_files”
 Show backed-up object names, and for tables, sizing detail and associated files.
 
const string NO_ERROR_IF_NOT_EXISTS = “no_error_if_not_exists”
 Whether or not to suppress the error if the specified backup does not exist.
 
const string TRUE = “true”
 A boolean constant for the ShowBackupRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the ShowBackupRequest.Options options.
 

Detailed Description

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

Optional parameters.

Definition at line 25 of file ShowBackup.cs.

Member Data Documentation

◆ ALL

const string kinetica.ShowBackupRequest.Options.ALL = “all”
static

Show all backup types.

Definition at line 66 of file ShowBackup.cs.

◆ BACKUP_ID

const string kinetica.ShowBackupRequest.Options.BACKUP_ID = “backup_id”
static

ID of the snapshot to show.

Leave empty to show information from the most recent snapshot in the backup. The default value is ”.

Definition at line 30 of file ShowBackup.cs.

◆ BACKUP_TYPE

const string kinetica.ShowBackupRequest.Options.BACKUP_TYPE = “backup_type”
static

Show backups by type.

This option is ignored if BACKUP_ID is non-empty. Supported values:

The default value is ALL.

Definition at line 63 of file ShowBackup.cs.

◆ DIFFERENTIAL

const string kinetica.ShowBackupRequest.Options.DIFFERENTIAL = “differential”
static

Show differential backups only.

Definition at line 75 of file ShowBackup.cs.

◆ FALSE

const string kinetica.ShowBackupRequest.Options.FALSE = “false”
static

A boolean constant for the ShowBackupRequest.Options options.

Definition at line 139 of file ShowBackup.cs.

◆ FULL

const string kinetica.ShowBackupRequest.Options.FULL = “full”
static

Show full backups only.

Definition at line 69 of file ShowBackup.cs.

◆ INCREMENTAL

const string kinetica.ShowBackupRequest.Options.INCREMENTAL = “incremental”
static

Show incremental backups only.

Definition at line 72 of file ShowBackup.cs.

◆ NO_ERROR_IF_NOT_EXISTS

const string kinetica.ShowBackupRequest.Options.NO_ERROR_IF_NOT_EXISTS = “no_error_if_not_exists”
static

Whether or not to suppress the error if the specified backup does not exist.

Supported values:

The default value is FALSE.

Definition at line 131 of file ShowBackup.cs.

◆ NONE

const string kinetica.ShowBackupRequest.Options.NONE = “none”
static

Don’t show snapshot contents.

Definition at line 105 of file ShowBackup.cs.

◆ OBJECT_FILES

const string kinetica.ShowBackupRequest.Options.OBJECT_FILES = “object_files”
static

Show backed-up object names, and for tables, sizing detail and associated files.

Definition at line 113 of file ShowBackup.cs.

◆ OBJECT_NAMES

const string kinetica.ShowBackupRequest.Options.OBJECT_NAMES = “object_names”
static

Show backed-up object names, and for tables, sizing detail.

Definition at line 109 of file ShowBackup.cs.

◆ SHOW_CONTENTS

const string kinetica.ShowBackupRequest.Options.SHOW_CONTENTS = “show_contents”
static

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.

Definition at line 102 of file ShowBackup.cs.

◆ TRUE

const string kinetica.ShowBackupRequest.Options.TRUE = “true”
static

A boolean constant for the ShowBackupRequest.Options options.

Definition at line 135 of file ShowBackup.cs.


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