Kinetica   C#   API  Version 7.2.3.0
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  {
40  public const string FILE_ENCODING = "file_encoding";
41 
44  public const string BASE64 = "base64";
45 
48  public const string NONE = "none";
49  } // end struct Options
50 
58  public IList<string> file_names { get; set; } = new List<string>();
59 
66  public IList<long> read_offsets { get; set; } = new List<long>();
67 
74  public IList<long> read_lengths { get; set; } = new List<long>();
75 
103  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
104 
107  public DownloadFilesRequest() { }
108 
156  public DownloadFilesRequest( IList<string> file_names,
157  IList<long> read_offsets,
158  IList<long> read_lengths,
159  IDictionary<string, string> options = null)
160  {
161  this.file_names = file_names ?? new List<string>();
162  this.read_offsets = read_offsets ?? new List<long>();
163  this.read_lengths = read_lengths ?? new List<long>();
164  this.options = options ?? new Dictionary<string, string>();
165  } // end constructor
166  } // end class DownloadFilesRequest
167 
172  {
174  public IList<string> file_names { get; set; } = new List<string>();
175 
178  public IList<byte[]> file_data { get; set; } = new List<byte[]>();
179 
181  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
182  } // end class DownloadFilesResponse
183 } // end namespace kinetica
IList< byte[]> file_data
Data for the respective downloaded files listed in file_names
IList< long > read_lengths
Array of number of bytes to read from each respective file in file_names.
IDictionary< string, string > info
Additional information.
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.
const string FILE_ENCODING
Encoding to be applied to the output file data.
A set of results returned by Kinetica.downloadFiles.
A set of parameters for Kinetica.downloadFiles.
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()
Constructs a DownloadFilesRequest object with default parameters.
IDictionary< string, string > options
Optional parameters.
IList< string > file_names
An array of the file names to download from KiFS.
const string BASE64
Apply base64 encoding to the output file data.
A set of string constants for the parameter options.
IList< string > file_names
Names of the files downloaded from KiFS
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14