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

#include <gpudb/protocol/download_files.h>

Public Member Functions
	DownloadFilesRequest ()
	Constructs a DownloadFilesRequest object with default parameters. 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
	An array of the file names to download from KiFS. More...

std::vector< int64_t >	readOffsets
	An array of starting byte offsets from which to read each respective file in fileNames. More...

std::vector< int64_t >	readLengths
	Array of number of bytes to read from each respective file in fileNames. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::downloadFiles.

Downloads one or more files from KiFS.

Definition at line 19 of file download_files.h.

Constructor & Destructor Documentation

◆ DownloadFilesRequest() [1/2]

gpudb::DownloadFilesRequest::DownloadFilesRequest ( )

inline

Constructs a DownloadFilesRequest object with default parameters.

Definition at line 24 of file download_files.h.

◆ DownloadFilesRequest() [2/2]

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. download_files_file_encoding: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values: download_files_base64: Apply base64 encoding to the output file data. download_files_none: Do not apply any encoding to the output file data. The default value is download_files_none. The default value is an empty map.

Definition at line 84 of file download_files.h.

Member Data Documentation

◆ fileNames

std::vector<std::string> gpudb::DownloadFilesRequest::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.

Definition at line 100 of file download_files.h.

◆ options

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

Optional parameters.

download_files_file_encoding: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
- download_files_base64: Apply base64 encoding to the output file data.
- download_files_none: Do not apply any encoding to the output file data.
The default value is download_files_none.

The default value is an empty map.

Definition at line 140 of file download_files.h.

◆ readLengths

std::vector<int64_t> gpudb::DownloadFilesRequest::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.

Definition at line 116 of file download_files.h.

◆ readOffsets

std::vector<int64_t> gpudb::DownloadFilesRequest::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.

Definition at line 108 of file download_files.h.

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

gpudb/protocol/download_files.h

Public Member Functions

Public Attributes