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

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

#include <gpudb/protocol/upload_files_fromurl.h>

Public Member Functions

 UploadFilesFromurlRequest ()
 Constructs an UploadFilesFromurlRequest object with default parameters. More...
 
 UploadFilesFromurlRequest (const std::vector< std::string > &fileNames_, const std::vector< std::string > &urls_, const std::map< std::string, std::string > &options_)
 Constructs an UploadFilesFromurlRequest object with the specified parameters. More...
 

Public Attributes

std::vector< std::string > fileNames
 An array of full file name paths to be used for the files uploaded to KiFS. More...
 
std::vector< std::string > urls
 List of URLs to upload, for each respective file in fileNames. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::uploadFilesFromurl.

Uploads one or more files to KiFS.

Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in GPUdb::showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.

These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.

Definition at line 32 of file upload_files_fromurl.h.

Constructor & Destructor Documentation

◆ UploadFilesFromurlRequest() [1/2]

gpudb::UploadFilesFromurlRequest::UploadFilesFromurlRequest ( )
inline

Constructs an UploadFilesFromurlRequest object with default parameters.

Definition at line 38 of file upload_files_fromurl.h.

◆ UploadFilesFromurlRequest() [2/2]

gpudb::UploadFilesFromurlRequest::UploadFilesFromurlRequest ( const std::vector< std::string > &  fileNames_,
const std::vector< std::string > &  urls_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an UploadFilesFromurlRequest object with the specified parameters.

Parameters
[in]fileNames_An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.
[in]urls_List of URLs to upload, for each respective file in fileNames_.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 62 of file upload_files_fromurl.h.

Member Data Documentation

◆ fileNames

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

An array of full file name paths to be used for the files uploaded to KiFS.

File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.

Definition at line 76 of file upload_files_fromurl.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 86 of file upload_files_fromurl.h.

◆ urls

std::vector<std::string> gpudb::UploadFilesFromurlRequest::urls

List of URLs to upload, for each respective file in fileNames.

Definition at line 81 of file upload_files_fromurl.h.


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