Kinetica   C#   API  Version 7.2.3.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 namespace kinetica;
10 
24 {
30  public struct Encoding
31  {
32  public const string BINARY = "binary";
33  public const string JSON = "json";
34  } // end struct Encoding
35 
38  public struct Options
39  {
53  public const string RETURN_RECORD_IDS = "return_record_ids";
54 
55  public const string TRUE = "true";
56  public const string FALSE = "false";
57 
60  public const string EXPRESSION = "expression";
61  } // end struct Options
62 
69  public string table_name { get; set; }
70 
75  public long offset { get; set; } = 0;
76 
87  public long limit { get; set; } = -9999;
88 
103  public string encoding { get; set; } = Encoding.BINARY;
104 
131  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
132 
136 
185  long? offset = null,
186  long? limit = null,
187  IDictionary<string, string> options = null)
188  {
189  this.table_name = table_name ?? "";
190  this.offset = offset ?? 0;
191  this.limit = limit ?? -9999;
192  this.encoding = Encoding.BINARY;
193  this.options = options ?? new Dictionary<string, string>();
194  } // end constructor
195 
257  long? offset = null,
258  long? limit = null,
259  string encoding = null,
260  IDictionary<string, string> options = null)
261  {
262  this.table_name = table_name ?? "";
263  this.offset = offset ?? 0;
264  this.limit = limit ?? -9999;
265  this.encoding = encoding ?? Encoding.BINARY;
266  this.options = options ?? new Dictionary<string, string>();
267  } // end full constructor
268 } // end class GetRecordsFromCollectionRequest
269 
274 {
278  public struct Info
279  {
281  public const string TOTAL_NUMBER_OF_RECORDS = "total_number_of_records";
282 
293  public const string HAS_MORE_RECORDS = "has_more_records";
294 
295  public const string TRUE = "true";
296  public const string FALSE = "false";
297  } // end struct Info
298 
302  public string table_name { get; set; }
303 
310  public IList<string> type_names { get; set; } = new List<string>();
311 
316  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
317 
322  public IList<string> records_json { get; set; } = new List<string>();
323 
327  public IList<string> record_ids { get; set; } = new List<string>();
328 
353  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
354 } // end class RawGetRecordsFromCollectionResponse
355 
362 {
366  public struct Info
367  {
369  public const string TOTAL_NUMBER_OF_RECORDS = "total_number_of_records";
370 
381  public const string HAS_MORE_RECORDS = "has_more_records";
382 
383  public const string TRUE = "true";
384  public const string FALSE = "false";
385  } // end struct Info
386 
390  public string table_name { get; set; }
391 
398  public IList<string> type_names { get; set; } = new List<string>();
399 
404  public IList<T> data { get; set; } = new List<T>();
405 
409  public IList<string> record_ids { get; set; } = new List<string>();
410 
435  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
436 } // end class GetRecordsFromCollectionResponse
const string HAS_MORE_RECORDS
Too many records.
IList< string > record_ids
If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID ...
IList< string > type_names
The type IDs of the corresponding records in records_binary or records_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.
A set of string constants for the parameter encoding.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string table_name
Name of the collection or table from which records are to be retrieved, in [schema_name.
GetRecordsFromCollectionRequest()
Constructs a GetRecordsFromCollectionRequest object with default parameters.
IList< string > record_ids
If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID ...
const string TOTAL_NUMBER_OF_RECORDS
Total number of records.
IList< byte[]> records_binary
If the encoding parameter of the request was 'binary' then this list contains the binary encoded reco...
const string EXPRESSION
Filter expression to apply to the table.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
A set of string constants for the parameter options.
A set of results returned by Kinetica.getRecordsFromCollection.
IDictionary< string, string > info
Additional information.
const string RETURN_RECORD_IDS
If TRUE then return the internal record ID along with each returned record.
A set of string constants for the parameter info.
IList< T > data
If the encoding parameter of the request was 'binary' then this list contains the binary encoded reco...
IList< string > type_names
The type IDs of the corresponding records in data or records_json.
IDictionary< string, string > info
Additional information.
IDictionary< string, string > options
A set of parameters for Kinetica.getRecordsFromCollection.
A set of results returned by Kinetica.getRecordsFromCollection.
string encoding
Specifies the encoding for returned records; either BINARY or JSON.
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
const string TOTAL_NUMBER_OF_RECORDS
Total number of records.
IList< string > records_json
If the encoding parameter of the request was 'json', then this list contains the JSON encoded records...
A set of string constants for the parameter info.
GetRecordsFromCollectionRequest(string table_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.