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

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

#include <gpudb/protocol/alter_directory.h>

Public Member Functions

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

Public Attributes

std::string directoryName
 Name of the directory in KiFS to be altered. More...
 
std::map< std::string, std::string > directoryUpdatesMap
 Map containing the properties of the directory to be altered. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::alterDirectory.

Alters an existing directory in KiFS.

Definition at line 19 of file alter_directory.h.

Constructor & Destructor Documentation

◆ AlterDirectoryRequest() [1/2]

gpudb::AlterDirectoryRequest::AlterDirectoryRequest ( )
inline

Constructs an AlterDirectoryRequest object with default parameters.

Definition at line 24 of file alter_directory.h.

◆ AlterDirectoryRequest() [2/2]

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

Constructs an AlterDirectoryRequest object with the specified parameters.

Parameters
[in]directoryName_Name of the directory in KiFS to be altered.
[in]directoryUpdatesMap_Map containing the properties of the directory to be altered. Error if empty.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 52 of file alter_directory.h.

Member Data Documentation

◆ directoryName

std::string gpudb::AlterDirectoryRequest::directoryName

Name of the directory in KiFS to be altered.

Definition at line 62 of file alter_directory.h.

◆ directoryUpdatesMap

std::map<std::string, std::string> gpudb::AlterDirectoryRequest::directoryUpdatesMap

Map containing the properties of the directory to be altered.

Error if empty.

Definition at line 74 of file alter_directory.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 79 of file alter_directory.h.


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