A set of parameters for GPUdb::deleteDirectory. More…
#include <gpudb/protocol/delete_directory.h>
Public Member Functions | |
| DeleteDirectoryRequest () | |
| Constructs a DeleteDirectoryRequest object with default parameters. | |
| DeleteDirectoryRequest (const std::string &directoryName_, const std::map< std::string, std::string > &options_) | |
| Constructs a DeleteDirectoryRequest object with the specified parameters. | |
Public Attributes | |
| std::string | directoryName |
| Name of the directory in KiFS to be deleted. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::deleteDirectory.
Deletes a directory from KiFS.
Definition at line 19 of file delete_directory.h.
Constructor & Destructor Documentation
◆ DeleteDirectoryRequest() [1/2]
| inline |
Constructs a DeleteDirectoryRequest object with default parameters.
Definition at line 24 of file delete_directory.h.
◆ DeleteDirectoryRequest() [2/2]
| inline |
Constructs a DeleteDirectoryRequest object with the specified parameters.
Parameters
| [in] | directoryName_ | Name of the directory in KiFS to be deleted. The directory must contain no files, unless recursive is true. |
| [in] | options_ | Optional parameters.
|
Definition at line 81 of file delete_directory.h.
Member Data Documentation
◆ directoryName
| std::string gpudb::DeleteDirectoryRequest::directoryName |
Name of the directory in KiFS to be deleted.
The directory must contain no files, unless recursive is true.
Definition at line 92 of file delete_directory.h.
◆ options
| std::map<std::string, std::string> gpudb::DeleteDirectoryRequest::options |
Optional parameters.
- delete_directory_recursive: If true, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:The default value is delete_directory_false.
- delete_directory_no_error_if_not_exists: If true, no error is returned if specified directory does not exist. Supported values:The default value is delete_directory_false.
The default value is an empty map.
Definition at line 127 of file delete_directory.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/delete_directory.h