A set of parameters for GPUdb::deleteFiles. More...

#include <gpudb/protocol/delete_files.h>

Public Member Functions
	DeleteFilesRequest ()
	Constructs a DeleteFilesRequest object with default parameters. More...

	DeleteFilesRequest (const std::vector< std::string > &fileNames_, const std::map< std::string, std::string > &options_)
	Constructs a DeleteFilesRequest object with the specified parameters. More...

Public Attributes
std::vector< std::string >	fileNames
	An array of names of files to be deleted. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::deleteFiles.

Deletes one or more files from KiFS.

Definition at line 19 of file delete_files.h.

Constructor & Destructor Documentation

◆ DeleteFilesRequest() [1/2]

gpudb::DeleteFilesRequest::DeleteFilesRequest ( )

inline

Constructs a DeleteFilesRequest object with default parameters.

Definition at line 24 of file delete_files.h.

◆ DeleteFilesRequest() [2/2]

gpudb::DeleteFilesRequest::DeleteFilesRequest	(	const std::vector< std::string > &	fileNames_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a DeleteFilesRequest object with the specified parameters.

Parameters

[in]	fileNames_	An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
[in]	options_	Optional parameters. delete_files_no_error_if_not_exists: If true, no error is returned if a specified file does not exist. Supported values: delete_files_true delete_files_false The default value is delete_files_false. The default value is an empty map.

Definition at line 62 of file delete_files.h.

Member Data Documentation

◆ fileNames

std::vector<std::string> gpudb::DeleteFilesRequest::fileNames

An array of names of files to be deleted.

File paths may contain wildcard characters after the KiFS directory delimeter.

Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

Definition at line 76 of file delete_files.h.

◆ options

std::map<std::string, std::string> gpudb::DeleteFilesRequest::options

Optional parameters.

delete_files_no_error_if_not_exists: If true, no error is returned if a specified file does not exist. Supported values:
- delete_files_true
- delete_files_false
The default value is delete_files_false.

The default value is an empty map.

Definition at line 95 of file delete_files.h.

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

gpudb/protocol/delete_files.h

Public Member Functions