GPUdb C++ API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::DownloadFilesRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/download_files.h>

Public Member Functions

 DownloadFilesRequest ()
 Constructs a DownloadFilesRequest object with default parameter values. More...
 
 DownloadFilesRequest (const std::vector< std::string > &fileNames_, const std::vector< int64_t > &readOffsets_, const std::vector< int64_t > &readLengths_, const std::map< std::string, std::string > &options_)
 Constructs a DownloadFilesRequest object with the specified parameters. More...
 

Public Attributes

std::vector< std::string > fileNames
 
std::vector< int64_t > readOffsets
 
std::vector< int64_t > readLengths
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Downloads one or more files from KiFS.

Definition at line 19 of file download_files.h.

Constructor & Destructor Documentation

gpudb::DownloadFilesRequest::DownloadFilesRequest ( )
inline

Constructs a DownloadFilesRequest object with default parameter values.

Definition at line 26 of file download_files.h.

gpudb::DownloadFilesRequest::DownloadFilesRequest ( const std::vector< std::string > &  fileNames_,
const std::vector< int64_t > &  readOffsets_,
const std::vector< int64_t > &  readLengths_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a DownloadFilesRequest object with the specified parameters.

Parameters
[in]fileNames_An array of the file names to download from KiFS. 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]readOffsets_An array of starting byte offsets from which to read each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readLengths must also not be empty.
[in]readLengths_Array of number of bytes to read from each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readOffsets must also not be empty.
[in]options_Optional parameters.

Definition at line 80 of file download_files.h.

Member Data Documentation

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

Definition at line 88 of file download_files.h.

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

Definition at line 91 of file download_files.h.

std::vector<int64_t> gpudb::DownloadFilesRequest::readLengths

Definition at line 90 of file download_files.h.

std::vector<int64_t> gpudb::DownloadFilesRequest::readOffsets

Definition at line 89 of file download_files.h.


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