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

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

#include <gpudb/protocol/create_directory.h>

Public Member Functions

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

Public Attributes

std::string directoryName
 Name of the directory in KiFS to be created. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::createDirectory.

Creates a new directory in KiFS. The new directory serves as a location in which the user can upload files using GPUdb::uploadFiles.

Definition at line 22 of file create_directory.h.

Constructor & Destructor Documentation

◆ CreateDirectoryRequest() [1/2]

gpudb::CreateDirectoryRequest::CreateDirectoryRequest ( )
inline

Constructs a CreateDirectoryRequest object with default parameters.

Definition at line 27 of file create_directory.h.

◆ CreateDirectoryRequest() [2/2]

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

Constructs a CreateDirectoryRequest object with the specified parameters.

Parameters
[in]directoryName_Name of the directory in KiFS to be created.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 76 of file create_directory.h.

Member Data Documentation

◆ directoryName

std::string gpudb::CreateDirectoryRequest::directoryName

Name of the directory in KiFS to be created.

Definition at line 85 of file create_directory.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 116 of file create_directory.h.


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