GPUdb C++ API  Version 7.2.2.4
gpudb::ShowFilesRequest Struct Reference

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

#include <gpudb/protocol/show_files.h>

Public Member Functions

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

Public Attributes

std::vector< std::string > paths
 File paths to show. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showFiles.

Shows information about files in KiFS. Can be used for individual files, or to show all files in a given directory.

Definition at line 19 of file show_files.h.

Constructor & Destructor Documentation

◆ ShowFilesRequest() [1/2]

gpudb::ShowFilesRequest::ShowFilesRequest ( )
inline

Constructs a ShowFilesRequest object with default parameters.

Definition at line 24 of file show_files.h.

◆ ShowFilesRequest() [2/2]

gpudb::ShowFilesRequest::ShowFilesRequest ( const std::vector< std::string > &  paths_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowFilesRequest object with the specified parameters.

Parameters
[in]paths_File paths to show. Each path can be a KiFS directory name, or a full path to a KiFS file. 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. The default value is an empty map.

Definition at line 43 of file show_files.h.

Member Data Documentation

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 63 of file show_files.h.

◆ paths

std::vector<std::string> gpudb::ShowFilesRequest::paths

File paths to show.

Each path can be a KiFS directory name, or a full path to a KiFS file. 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 58 of file show_files.h.


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