Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
GetRecordsFromCollection.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 
10 
11 namespace kinetica
12 {
13 
26  {
27 
33  public struct Encoding
34  {
35  public const string BINARY = "binary";
36  public const string JSON = "json";
37  } // end struct Encoding
38 
39 
53  public struct Options
54  {
55 
60  public const string RETURN_RECORD_IDS = "return_record_ids";
61  public const string TRUE = "true";
62  public const string FALSE = "false";
63  } // end struct Options
64 
65 
68  public string table_name { get; set; }
69 
74  public long offset { get; set; } = 0;
75 
79  public long limit { get; set; } = 10000;
80 
84  public string encoding { get; set; } = Encoding.BINARY;
85 
97  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
98 
99 
103 
130  long offset = 0,
131  long limit = 10000,
132  IDictionary<string, string> options = null)
133  {
134  this.table_name = table_name ?? "";
135  this.offset = offset;
136  this.limit = limit;
137  this.encoding = Encoding.BINARY;
138  this.options = options ?? new Dictionary<string, string>();
139  } // end constructor
140 
141 
171  long offset = 0,
172  long limit = 10000,
173  string encoding = null,
174  IDictionary<string, string> options = null)
175  {
176  this.table_name = table_name ?? "";
177  this.offset = offset;
178  this.limit = limit;
179  this.encoding = encoding ?? Encoding.BINARY;
180  this.options = options ?? new Dictionary<string, string>();
181  } // end full constructor
182 
183  } // end class GetRecordsFromCollectionRequest
184 
185 
186 
190  {
191 
194  public string table_name { get; set; }
195 
202  public IList<string> type_names { get; set; } = new List<string>();
203 
207  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
208 
212  public IList<string> records_json { get; set; } = new List<string>();
213 
217  public IList<string> record_ids { get; set; } = new List<string>();
218 
219  } // end class RawGetRecordsFromCollectionResponse
220 
221 
222 
228  public class GetRecordsFromCollectionResponse<T> : KineticaData
229  {
230 
233  public string table_name { get; set; }
234 
241  public IList<string> type_names { get; set; } = new List<string>();
242 
246  public IList<T> data { get; set; } = new List<T>();
247 
251  public IList<string> record_ids { get; set; } = new List<string>();
252 
253  } // end class GetRecordsFromCollectionResponse
254 
255 
256 
257 
258 } // end namespace kinetica
const string RETURN_RECORD_IDS
If &#39;true&#39; then return the internal record ID along with each returned record.
IList< string > record_ids
If the &#39;return_record_ids&#39; option of the request was &#39;true&#39;, then this list contains the internal ID ...
string encoding
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
IList< string > type_names
The type IDs of the corresponding records in &lt;member name=&quot;records_binary&quot;&gt; or &lt;member name=&quot;records_...
GetRecordsFromCollectionRequest(string table_name, long offset=0, long limit=10000, IDictionary< string, string > options=null)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
IDictionary< string, string > options
return_record_ids If &#39;true&#39; then return the internal record ID along with each returned record...
GetRecordsFromCollectionRequest()
Constructs a GetRecordsFromCollectionRequest object with default parameters.
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
IList< string > records_json
If the encoding parameter of the request was &#39;json&#39;, then this list contains the JSON encoded records...
GetRecordsFromCollectionRequest(string table_name, long offset=0, long limit=10000, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
string table_name
Name of the collection or table from which records are to be retrieved.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
IList< byte[]> records_binary
If the encoding parameter of the request was &#39;binary&#39; then this list contains the binary encoded reco...
A set of parameters for /get/records/fromcollection.
return_record_ids If &#39;true&#39; then return the internal record ID along with each returned record...
A set of results returned by /get/records/fromcollection.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...