Kinetica   C#   API  Version 7.2.3.1
DownloadFiles.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica;
10 
17 {
21  public struct Options
22  {
39  public const string FILE_ENCODING = "file_encoding";
40 
42  public const string BASE64 = "base64";
43 
46  public const string NONE = "none";
47  } // end struct Options
48 
55  public IList<string> file_names { get; set; } = new List<string>();
56 
63  public IList<long> read_offsets { get; set; } = new List<long>();
64 
71  public IList<long> read_lengths { get; set; } = new List<long>();
72 
99  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
100 
103  public DownloadFilesRequest() { }
104 
150  public DownloadFilesRequest( IList<string> file_names,
151  IList<long> read_offsets,
152  IList<long> read_lengths,
153  IDictionary<string, string> options = null)
154  {
155  this.file_names = file_names ?? new List<string>();
156  this.read_offsets = read_offsets ?? new List<long>();
157  this.read_lengths = read_lengths ?? new List<long>();
158  this.options = options ?? new Dictionary<string, string>();
159  } // end constructor
160 } // end class DownloadFilesRequest
161 
166 {
168  public IList<string> file_names { get; set; } = new List<string>();
169 
172  public IList<byte[]> file_data { get; set; } = new List<byte[]>();
173 
175  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
176 } // end class DownloadFilesResponse
A set of results returned by Kinetica.downloadFiles.
IList< string > file_names
Names of the files downloaded from KiFS.
DownloadFilesRequest()
Constructs a DownloadFilesRequest object with default parameters.
const string BASE64
Apply base64 encoding to the output file data.
IList< string > file_names
An array of the file names to download from KiFS.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IDictionary< string, string > info
Additional information.
IList< long > read_lengths
Array of number of bytes to read from each respective file in file_names.
const string FILE_ENCODING
Encoding to be applied to the output file data.
A set of string constants for the parameter options.
IDictionary< string, string > options
Optional parameters.
IList< byte[]> file_data
Data for the respective downloaded files listed in file_names.
const string NONE
Do not apply any encoding to the output file data.
IList< long > read_offsets
An array of starting byte offsets from which to read each respective file in file_names.
DownloadFilesRequest(IList< string > file_names, IList< long > read_offsets, IList< long > read_lengths, IDictionary< string, string > options=null)
Constructs a DownloadFilesRequest object with the specified parameters.
A set of parameters for Kinetica.downloadFiles.