Delete Directory

Deletes a directory from KiFS.

Input Parameter Description

NameTypeDescription
directory_namestringName of the directory in KiFS to be deleted. The directory must contain no files, unless recursive is true
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
recursive

If true, will delete directory and all files residing in it. If false, directory must be empty for deletion. The default value is false. The supported values are:

  • true
  • false
no_error_if_not_exists

If true, no error is returned if specified directory does not exist The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

NameTypeDescription
directory_namestringValue of input parameter directory_name.
infomap of string to stringsAdditional information.