Kinetica   C#   API  Version 7.2.3.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 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 
61  public const string EXPRESSION = "expression";
62  } // end struct Options
63 
70  public string table_name { get; set; }
71 
77  public long offset { get; set; } = 0;
78 
90  public long limit { get; set; } = -9999;
91 
106  public string encoding { get; set; } = Encoding.BINARY;
107 
136  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
137 
141 
194  long? offset = null,
195  long? limit = null,
196  IDictionary<string, string> options = null)
197  {
198  this.table_name = table_name ?? "";
199  this.offset = offset ?? 0;
200  this.limit = limit ?? -9999;
201  this.encoding = Encoding.BINARY;
202  this.options = options ?? new Dictionary<string, string>();
203  } // end constructor
204 
271  long? offset = null,
272  long? limit = null,
273  string encoding = null,
274  IDictionary<string, string> options = null)
275  {
276  this.table_name = table_name ?? "";
277  this.offset = offset ?? 0;
278  this.limit = limit ?? -9999;
279  this.encoding = encoding ?? Encoding.BINARY;
280  this.options = options ?? new Dictionary<string, string>();
281  } // end full constructor
282  } // end class GetRecordsFromCollectionRequest
283 
288  {
292  public struct Info
293  {
295  public const string TOTAL_NUMBER_OF_RECORDS = "total_number_of_records";
296 
307  public const string HAS_MORE_RECORDS = "has_more_records";
308 
309  public const string TRUE = "true";
310  public const string FALSE = "false";
311  } // end struct Info
312 
316  public string table_name { get; set; }
317 
324  public IList<string> type_names { get; set; } = new List<string>();
325 
330  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
331 
336  public IList<string> records_json { get; set; } = new List<string>();
337 
342  public IList<string> record_ids { get; set; } = new List<string>();
343 
368  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
369  } // end class RawGetRecordsFromCollectionResponse
370 
377  {
381  public struct Info
382  {
384  public const string TOTAL_NUMBER_OF_RECORDS = "total_number_of_records";
385 
396  public const string HAS_MORE_RECORDS = "has_more_records";
397 
398  public const string TRUE = "true";
399  public const string FALSE = "false";
400  } // end struct Info
401 
405  public string table_name { get; set; }
406 
413  public IList<string> type_names { get; set; } = new List<string>();
414 
419  public IList<T> data { get; set; } = new List<T>();
420 
425  public IList<string> record_ids { get; set; } = new List<string>();
426 
451  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
452  } // end class GetRecordsFromCollectionResponse
453 } // end namespace kinetica
const string TOTAL_NUMBER_OF_RECORDS
Total number of records.
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.
const string RETURN_RECORD_IDS
If TRUE then return the internal record ID along with each returned record.
IDictionary< string, string > info
Additional information.
IList< T > data
If the encoding parameter of the request was 'binary' then this list contains the binary encoded reco...
IList< string > record_ids
If the 'return_record_ids' option of the request was 'true', 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 records_binary or records_json.
const string TOTAL_NUMBER_OF_RECORDS
Total number of records.
GetRecordsFromCollectionRequest()
Constructs a GetRecordsFromCollectionRequest object with default parameters.
A set of string constants for the parameter encoding.
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.
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...
GetRecordsFromCollectionRequest(string table_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
IList< byte[]> records_binary
If the encoding parameter of the request was 'binary' 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.
A set of string constants for the parameter options.
A set of results returned by Kinetica.getRecordsFromCollection.
IDictionary< string, string > info
Additional information.
IList< string > record_ids
If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID ...
A set of results returned by Kinetica.getRecordsFromCollection.
IList< string > type_names
The type IDs of the corresponding records in data or records_json.
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 ...
A set of string constants for the parameter info.