kinetica.ShowBackupRequest.Options Struct Reference

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

Public Attributes
const string	BACKUP_ID = "backup_id"
	Backup instance ID to show. More...
const string	SHOW_CONTENTS = "show_contents"
	Shows the contents of the specified backup_id. More...
const string	NONE = "none"
	No backup contents More...
const string	OBJECT_NAMES = "object_names"
	Object names only More...
const string	OBJECT_FILES = "object_files"
	Object names and files More...
const string	NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists"
	If FALSE will return an error if the provided backup_name 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 22 of file ShowBackup.cs.

Member Data Documentation

BACKUP_ID

const string kinetica.ShowBackupRequest.Options.BACKUP_ID = "backup_id"

Backup instance ID to show.

ID of the snapshot to show.

Leave empty to show information from the most recent backup instance in the container. The default value is ''.

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

Definition at line 28 of file ShowBackup.cs.

FALSE

const string kinetica.ShowBackupRequest.Options.FALSE = "false"

Definition at line 79 of file ShowBackup.cs.

NO_ERROR_IF_NOT_EXISTS

const string kinetica.ShowBackupRequest.Options.NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists"

If FALSE will return an error if the provided backup_name does not exist.

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

Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 76 of file ShowBackup.cs.

NONE

const string kinetica.ShowBackupRequest.Options.NONE = "none"

No backup contents

Don't show snapshot contents.

Definition at line 54 of file ShowBackup.cs.

OBJECT_FILES

const string kinetica.ShowBackupRequest.Options.OBJECT_FILES = "object_files"

Object names and files

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

Definition at line 60 of file ShowBackup.cs.

OBJECT_NAMES

const string kinetica.ShowBackupRequest.Options.OBJECT_NAMES = "object_names"

Object names only

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

Definition at line 57 of file ShowBackup.cs.

SHOW_CONTENTS

const string kinetica.ShowBackupRequest.Options.SHOW_CONTENTS = "show_contents"

Shows the contents of the specified backup_id.

Show the contents of the backed-up snapshots.

Supported values:

• NONE: No backup contents
• OBJECT_NAMES: Object names only
• OBJECT_FILES: Object names and files

The default value is NONE.

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

TRUE

const string kinetica.ShowBackupRequest.Options.TRUE = "true"

Definition at line 78 of file ShowBackup.cs.

---

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

• _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowBackup.cs