Kinetica C# API  Version 7.1.10.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 
33  {
34 
52  public struct Encoding
53  {
54  public const string BINARY = "binary";
55  public const string JSON = "json";
56  } // end struct Encoding
57 
58 
90  public struct Options
91  {
92 
108  public const string RETURN_RECORD_IDS = "return_record_ids";
109  public const string TRUE = "true";
110  public const string FALSE = "false";
111 
114  public const string EXPRESSION = "expression";
115  } // end struct Options
116 
117 
123  public string table_name { get; set; }
124 
129  public long offset { get; set; } = 0;
130 
144  public long limit { get; set; } = -9999;
145 
162  public string encoding { get; set; } = Encoding.BINARY;
163 
193  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
194 
195 
199 
257  long? offset = null,
258  long? limit = null,
259  IDictionary<string, string> options = null)
260  {
261  this.table_name = table_name ?? "";
262  this.offset = offset ?? 0;
263  this.limit = limit ?? -9999;
264  this.encoding = Encoding.BINARY;
265  this.options = options ?? new Dictionary<string, string>();
266  } // end constructor
267 
268 
342  long? offset = null,
343  long? limit = null,
344  string encoding = null,
345  IDictionary<string, string> options = null)
346  {
347  this.table_name = table_name ?? "";
348  this.offset = offset ?? 0;
349  this.limit = limit ?? -9999;
350  this.encoding = encoding ?? Encoding.BINARY;
351  this.options = options ?? new Dictionary<string, string>();
352  } // end full constructor
353 
354  } // end class GetRecordsFromCollectionRequest
355 
356 
357 
362  {
363 
391  public struct Info
392  {
393 
395  public const string TOTAL_NUMBER_OF_RECORDS = "total_number_of_records";
396 
409  public const string HAS_MORE_RECORDS = "has_more_records";
410  public const string TRUE = "true";
411  public const string FALSE = "false";
412  } // end struct Info
413 
414 
417  public string table_name { get; set; }
418 
425  public IList<string> type_names { get; set; } = new List<string>();
426 
430  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
431 
435  public IList<string> records_json { get; set; } = new List<string>();
436 
440  public IList<string> record_ids { get; set; } = new List<string>();
441 
467  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
468 
469  } // end class RawGetRecordsFromCollectionResponse
470 
471 
472 
479  public class GetRecordsFromCollectionResponse<T> : KineticaData
480  {
481 
509  public struct Info
510  {
511 
513  public const string TOTAL_NUMBER_OF_RECORDS = "total_number_of_records";
514 
527  public const string HAS_MORE_RECORDS = "has_more_records";
528  public const string TRUE = "true";
529  public const string FALSE = "false";
530  } // end struct Info
531 
532 
535  public string table_name { get; set; }
536 
543  public IList<string> type_names { get; set; } = new List<string>();
544 
548  public IList<T> data { get; set; } = new List<T>();
549 
553  public IList<string> record_ids { get; set; } = new List<string>();
554 
580  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
581 
582  } // end class GetRecordsFromCollectionResponse
583 
584 
585 
586 
587 } // end namespace kinetica
const string RETURN_RECORD_IDS
If true 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 binary or json.
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 true 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 binary or json.
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, in [schema_name.
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...
const string EXPRESSION
Optional filter expression to apply to the table.
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 true 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 ...