/download/files

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/download/files

Downloads one or more files from KiFS.

Input Parameter Description

Name Type Description
file_names array of strings An array of the file names to download from KiFS. The full path must be provided.
read_offsets array of longs An array of starting byte offsets from which to read each respective file in input parameter file_names. Must either be empty or the same length as input parameter file_names. If empty, files are downloaded in their entirety. If not empty, input parameter read_lengths must also not be empty.
read_lengths array of longs Array of number of bytes to read from each respective file in input parameter file_names. Must either be empty or the same length as input parameter file_names. If empty, files are downloaded in their entirety. If not empty, input parameter read_offsets must also not be empty.
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
file_encoding

Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. The default value is none.

Supported Values Description
base64 Apply base64 encoding to the output file data.
none Do not apply any encoding to the output file data.

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'download_files_response' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /download/files endpoint:

Name Type Description
file_names array of strings Names of the files downloaded from KiFS
file_data array of bytes Data for the respective downloaded files listed in output parameter file_names
info map of string to strings Additional information.

Empty string in case of an error.