Kinetica C# API  Version 6.2.0.1
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 
118  public long limit { get; set; } = 10000;
119 
136  public string encoding { get; set; } = Encoding.BINARY;
137 
161  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
162 
163 
167 
207  long? offset = null,
208  long? limit = null,
209  IDictionary<string, string> options = null)
210  {
211  this.table_name = table_name ?? "";
212  this.offset = offset ?? 0;
213  this.limit = limit ?? 10000;
214  this.encoding = Encoding.BINARY;
215  this.options = options ?? new Dictionary<string, string>();
216  } // end constructor
217 
218 
274  long? offset = null,
275  long? limit = null,
276  string encoding = null,
277  IDictionary<string, string> options = null)
278  {
279  this.table_name = table_name ?? "";
280  this.offset = offset ?? 0;
281  this.limit = limit ?? 10000;
282  this.encoding = encoding ?? Encoding.BINARY;
283  this.options = options ?? new Dictionary<string, string>();
284  } // end full constructor
285 
286  } // end class GetRecordsFromCollectionRequest
287 
288 
289 
294  {
295 
298  public string table_name { get; set; }
299 
306  public IList<string> type_names { get; set; } = new List<string>();
307 
311  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
312 
316  public IList<string> records_json { get; set; } = new List<string>();
317 
321  public IList<string> record_ids { get; set; } = new List<string>();
322 
323  } // end class RawGetRecordsFromCollectionResponse
324 
325 
326 
334  {
335 
338  public string table_name { get; set; }
339 
346  public IList<string> type_names { get; set; } = new List<string>();
347 
351  public IList<T> data { get; set; } = new List<T>();
352 
356  public IList<string> record_ids { get; set; } = new List<string>();
357 
358  } // end class GetRecordsFromCollectionResponse
359 
360 
361 
362 
363 } // end namespace kinetica
GetRecordsFromCollectionRequest(string table_name, long? offset=null, long? limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
string encoding
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
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;.
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...
GetRecordsFromCollectionRequest(string table_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
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 ...