dropBackup - Kinetica Docs

◆ dropBackup() [1/2]

DropBackupResponse kinetica.Kinetica.dropBackup ( DropBackupRequest request_ )

inline

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasink_name.

Parameters

request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

Definition at line 32654 of file KineticaFunctions.cs.

DropBackupResponse kinetica.Kinetica.dropBackup	(	string	backup_name,
		string	datasink_name,
		IDictionary< string, string >	options = null )

inline

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasink_name .

Parameters

backup_name	Name of the backup to be deleted. An empty string or '' will delete all existing backups. Any text followed by a '' will delete backups whose name starts with that text. When deleting multiple backups, DELETE_ALL_BACKUPS must be set to TRUE.
datasink_name	Data sink through which the backup is accessible.
options	Optional parameters. DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values: TRUE FALSE The default value is FALSE. DELETE_ALL_BACKUPS: Allow multiple backups to be deleted if TRUE and multiple backup names are found matching backup_name . Supported values: TRUE FALSE The default value is FALSE. NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Returns

Response object containing the result of the operation.

Definition at line 32771 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< DropBackupResponse > kinetica.Kinetica.DropBackupAsync	(	DropBackupRequest	request_,
		System.Threading.CancellationToken	cancellationToken = default )

inline

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasink_name.

(async)

Parameters

request_	Request object containing the parameters for the operation.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 32675 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< DropBackupResponse > kinetica.Kinetica.DropBackupAsync	(	string	backup_name,
		string	datasink_name,
		IDictionary< string, string >	options = null,
		System.Threading.CancellationToken	cancellationToken = default )

inline

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasink_name .

(async)

Parameters

backup_name	Name of the backup to be deleted. An empty string or '' will delete all existing backups. Any text followed by a '' will delete backups whose name starts with that text. When deleting multiple backups, DELETE_ALL_BACKUPS must be set to TRUE.
datasink_name	Data sink through which the backup is accessible.
options	Optional parameters. DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values: TRUE FALSE The default value is FALSE. DELETE_ALL_BACKUPS: Allow multiple backups to be deleted if TRUE and multiple backup names are found matching backup_name . Supported values: TRUE FALSE The default value is FALSE. NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 32868 of file KineticaFunctions.cs.