Skip to main content

​
◆ downloadFiles() [1/2]

DownloadFilesResponse kinetica.Kinetica.downloadFiles (DownloadFilesRequestrequest_)
 inline

Downloads one or more files from KiFS.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 32489 of file KineticaFunctions.cs.

​
◆ downloadFiles() [2/2]

DownloadFilesResponse kinetica.Kinetica.downloadFiles (IList< string >file_names,
IList< long >read_offsets,
IList< long >read_lengths,
IDictionary< string, string >options = null )
 inline

Downloads one or more files from KiFS.

Parameters
file_namesAn array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimiter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
read_offsetsAn array of starting byte offsets from which to read each respective file in file_names . Must either be empty or the same length as file_names . If empty, files are downloaded in their entirety. If not empty, read_lengths must also not be empty.
read_lengthsArray of number of bytes to read from each respective file in file_names . Must either be empty or the same length as file_names . If empty, files are downloaded in their entirety. If not empty, read_offsets must also not be empty.
optionsOptional parameters.
  • 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:
    • BASE64: Apply base64 encoding to the output file data.
    • NONE: Do not apply any encoding to the output file data.
    The default value is NONE.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 32567 of file KineticaFunctions.cs.

​
◆ DownloadFilesAsync() [1/2]

async System.Threading.Tasks.Task< DownloadFilesResponse > kinetica.Kinetica.DownloadFilesAsync (DownloadFilesRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Downloads one or more files from KiFS.

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 32505 of file KineticaFunctions.cs.

​
◆ DownloadFilesAsync() [2/2]

async System.Threading.Tasks.Task< DownloadFilesResponse > kinetica.Kinetica.DownloadFilesAsync (IList< string >file_names,
IList< long >read_offsets,
IList< long >read_lengths,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Downloads one or more files from KiFS.

(async)

Parameters
file_namesAn array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimiter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
read_offsetsAn array of starting byte offsets from which to read each respective file in file_names . Must either be empty or the same length as file_names . If empty, files are downloaded in their entirety. If not empty, read_lengths must also not be empty.
read_lengthsArray of number of bytes to read from each respective file in file_names . Must either be empty or the same length as file_names . If empty, files are downloaded in their entirety. If not empty, read_offsets must also not be empty.
optionsOptional parameters.
  • 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:
    • BASE64: Apply base64 encoding to the output file data.
    • NONE: Do not apply any encoding to the output file data.
    The default value is NONE.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 32632 of file KineticaFunctions.cs.