Kinetica C# API  Version 6.1.0.0
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 
29  {
30 
48  public struct Encoding
49  {
50  public const string BINARY = "binary";
51  public const string JSON = "json";
52  } // end struct Encoding
53 
54 
80  public struct Options
81  {
82 
98  public const string RETURN_RECORD_IDS = "return_record_ids";
99  public const string TRUE = "true";
100  public const string FALSE = "false";
101  } // end struct Options
102 
103 
106  public string table_name { get; set; }
107 
112  public long offset { get; set; } = 0;
113 
117  public long limit { get; set; } = 10000;
118 
135  public string encoding { get; set; } = Encoding.BINARY;
136 
160  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
161 
162 
166 
205  long offset = 0,
206  long limit = 10000,
207  IDictionary<string, string> options = null)
208  {
209  this.table_name = table_name ?? "";
210  this.offset = offset;
211  this.limit = limit;
212  this.encoding = Encoding.BINARY;
213  this.options = options ?? new Dictionary<string, string>();
214  } // end constructor
215 
216 
271  long offset = 0,
272  long limit = 10000,
273  string encoding = null,
274  IDictionary<string, string> options = null)
275  {
276  this.table_name = table_name ?? "";
277  this.offset = offset;
278  this.limit = limit;
279  this.encoding = encoding ?? Encoding.BINARY;
280  this.options = options ?? new Dictionary<string, string>();
281  } // end full constructor
282 
283  } // end class GetRecordsFromCollectionRequest
284 
285 
286 
291  {
292 
295  public string table_name { get; set; }
296 
303  public IList<string> type_names { get; set; } = new List<string>();
304 
308  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
309 
313  public IList<string> records_json { get; set; } = new List<string>();
314 
318  public IList<string> record_ids { get; set; } = new List<string>();
319 
320  } // end class RawGetRecordsFromCollectionResponse
321 
322 
323 
331  {
332 
335  public string table_name { get; set; }
336 
343  public IList<string> type_names { get; set; } = new List<string>();
344 
348  public IList<T> data { get; set; } = new List<T>();
349 
353  public IList<string> record_ids { get; set; } = new List<string>();
354 
355  } // end class GetRecordsFromCollectionResponse
356 
357 
358 
359 
360 } // end namespace kinetica
string encoding
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
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;.
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...
A set of parameters for Kinetica.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>).
RETURN_RECORD_IDS: If &#39;true&#39; then return the internal record ID along with each returned record...
A set of results returned by Kinetica.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>).
A set of results returned by Kinetica.getRecordsFromCollection<T>(string,long,long,IDictionary<string, string>).
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 ...