Kinetica   C#   API  Version 7.2.3.1
Public Attributes | List of all members
ShowBackupRequest.Options Struct Reference

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

Public Attributes

const string BACKUP_ID = "backup_id"
 ID of the snapshot to show. More...
 
const string BACKUP_TYPE = "backup_type"
 Show backups by type. More...
 
const string ALL = "all"
 Show all backup types. More...
 
const string FULL = "full"
 Show full backups only. More...
 
const string INCREMENTAL = "incremental"
 Show incremental backups only. More...
 
const string DIFFERENTIAL = "differential"
 Show differential backups only. More...
 
const string SHOW_CONTENTS = "show_contents"
 Show the contents of the backed-up snapshots. More...
 
const string NONE = "none"
 Don't show snapshot contents. More...
 
const string OBJECT_NAMES = "object_names"
 Show backed-up object names, and for tables, sizing detail. More...
 
const string OBJECT_FILES = "object_files"
 Show backed-up object names, and for tables, sizing detail and associated files. More...
 
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. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 24 of file ShowBackup.cs.

Member Data Documentation

◆ ALL

const string ShowBackupRequest.Options.ALL = "all"

Show all backup types.

Definition at line 58 of file ShowBackup.cs.

◆ BACKUP_ID

const string ShowBackupRequest.Options.BACKUP_ID = "backup_id"

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 29 of file ShowBackup.cs.

◆ BACKUP_TYPE

const string ShowBackupRequest.Options.BACKUP_TYPE = "backup_type"

Show backups by type.

Supported values:

The default value is ALL.

Definition at line 55 of file ShowBackup.cs.

◆ DIFFERENTIAL

const string ShowBackupRequest.Options.DIFFERENTIAL = "differential"

Show differential backups only.

Definition at line 67 of file ShowBackup.cs.

◆ FALSE

const string ShowBackupRequest.Options.FALSE = "false"

Definition at line 120 of file ShowBackup.cs.

◆ FULL

const string ShowBackupRequest.Options.FULL = "full"

Show full backups only.

Definition at line 61 of file ShowBackup.cs.

◆ INCREMENTAL

const string ShowBackupRequest.Options.INCREMENTAL = "incremental"

Show incremental backups only.

Definition at line 64 of file ShowBackup.cs.

◆ NO_ERROR_IF_NOT_EXISTS

const string ShowBackupRequest.Options.NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists"

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

Supported values:

The default value is FALSE.

Definition at line 117 of file ShowBackup.cs.

◆ NONE

const string ShowBackupRequest.Options.NONE = "none"

Don't show snapshot contents.

Definition at line 94 of file ShowBackup.cs.

◆ OBJECT_FILES

const string ShowBackupRequest.Options.OBJECT_FILES = "object_files"

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

Definition at line 102 of file ShowBackup.cs.

◆ OBJECT_NAMES

const string ShowBackupRequest.Options.OBJECT_NAMES = "object_names"

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

Definition at line 98 of file ShowBackup.cs.

◆ SHOW_CONTENTS

const string ShowBackupRequest.Options.SHOW_CONTENTS = "show_contents"

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 91 of file ShowBackup.cs.

◆ TRUE

const string ShowBackupRequest.Options.TRUE = "true"

Definition at line 119 of file ShowBackup.cs.

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