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

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

#include <gpudb/protocol/show_directories.h>

Public Member Functions

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

Public Attributes

std::string directoryName
 The KiFS directory name to show. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showDirectories.

Shows information about directories in KiFS. Can be used to show a single directory, or all directories.

Definition at line 20 of file show_directories.h.

Constructor & Destructor Documentation

◆ ShowDirectoriesRequest() [1/2]

gpudb::ShowDirectoriesRequest::ShowDirectoriesRequest ( )
inline

Constructs a ShowDirectoriesRequest object with default parameters.

Definition at line 25 of file show_directories.h.

◆ ShowDirectoriesRequest() [2/2]

gpudb::ShowDirectoriesRequest::ShowDirectoriesRequest ( const std::string &  directoryName_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowDirectoriesRequest object with the specified parameters.

Parameters
[in]directoryName_The KiFS directory name to show. If empty, shows all directories. The default value is ''.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 41 of file show_directories.h.

Member Data Documentation

◆ directoryName

std::string gpudb::ShowDirectoriesRequest::directoryName

The KiFS directory name to show.

If empty, shows all directories. The default value is ''.

Definition at line 51 of file show_directories.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 56 of file show_directories.h.


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