Kinetica C# API  Version 7.0.19.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 
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 
124  public long limit { get; set; } = -9999;
125 
142  public string encoding { get; set; } = Encoding.BINARY;
143 
167  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
168 
169 
173 
219  long? offset = null,
220  long? limit = null,
221  IDictionary<string, string> options = null)
222  {
223  this.table_name = table_name ?? "";
224  this.offset = offset ?? 0;
225  this.limit = limit ?? -9999;
226  this.encoding = Encoding.BINARY;
227  this.options = options ?? new Dictionary<string, string>();
228  } // end constructor
229 
230 
292  long? offset = null,
293  long? limit = null,
294  string encoding = null,
295  IDictionary<string, string> options = null)
296  {
297  this.table_name = table_name ?? "";
298  this.offset = offset ?? 0;
299  this.limit = limit ?? -9999;
300  this.encoding = encoding ?? Encoding.BINARY;
301  this.options = options ?? new Dictionary<string, string>();
302  } // end full constructor
303 
304  } // end class GetRecordsFromCollectionRequest
305 
306 
307 
312  {
313 
341  public struct Info
342  {
343 
345  public const string TOTAL_NUMBER_OF_RECORDS = "total_number_of_records";
346 
359  public const string HAS_MORE_RECORDS = "has_more_records";
360  public const string TRUE = "true";
361  public const string FALSE = "false";
362  } // end struct Info
363 
364 
367  public string table_name { get; set; }
368 
375  public IList<string> type_names { get; set; } = new List<string>();
376 
380  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
381 
385  public IList<string> records_json { get; set; } = new List<string>();
386 
390  public IList<string> record_ids { get; set; } = new List<string>();
391 
417  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
418 
419  } // end class RawGetRecordsFromCollectionResponse
420 
421 
422 
429  public class GetRecordsFromCollectionResponse<T> : KineticaData
430  {
431 
459  public struct Info
460  {
461 
463  public const string TOTAL_NUMBER_OF_RECORDS = "total_number_of_records";
464 
477  public const string HAS_MORE_RECORDS = "has_more_records";
478  public const string TRUE = "true";
479  public const string FALSE = "false";
480  } // end struct Info
481 
482 
485  public string table_name { get; set; }
486 
493  public IList<string> type_names { get; set; } = new List<string>();
494 
498  public IList<T> data { get; set; } = new List<T>();
499 
503  public IList<string> record_ids { get; set; } = new List<string>();
504 
530  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
531 
532  } // end class GetRecordsFromCollectionResponse
533 
534 
535 
536 
537 } // 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_...
const string TOTAL_NUMBER_OF_RECORDS
Total number of records.
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=null, long?limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
IList< string > records_json
If the encoding parameter of the request was &#39;json&#39;, then this list contains the JSON encoded records...
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 Kinetica.getRecordsFromCollection{T}(string,long,long,IDictionary{string, string}).
GetRecordsFromCollectionRequest(string table_name, long?offset=null, long?limit=null, IDictionary< string, string > options=null)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
RETURN_RECORD_IDS: If &#39;true&#39; then return the internal record ID along with each returned record...
IDictionary< string, string > info
Additional information.
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 ...