Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Filter.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 
28  public class FilterRequest : KineticaData
29  {
30 
58  public struct Options
59  {
60 
65  public const string COLLECTION_NAME = "collection_name";
66 
69  public const string VIEW_ID = "view_id";
70 
74  public const string TTL = "ttl";
75  } // end struct Options
76 
77 
84  public string table_name { get; set; }
85 
90  public string view_name { get; set; } = "";
91 
95  public string expression { get; set; }
96 
122  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
123 
124 
127  public FilterRequest() { }
128 
172  public FilterRequest( string table_name,
173  string view_name,
174  string expression,
175  IDictionary<string, string> options = null)
176  {
177  this.table_name = table_name ?? "";
178  this.view_name = view_name ?? "";
179  this.expression = expression ?? "";
180  this.options = options ?? new Dictionary<string, string>();
181  } // end constructor
182 
183  } // end class FilterRequest
184 
185 
186 
191  {
192 
195  public long count { get; set; }
196 
198  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
199 
200  } // end class FilterResponse
201 
202 
203 
204 
205 } // end namespace kinetica
const string COLLECTION_NAME
Name of a collection which is to contain the newly created view.
Definition: Filter.cs:65
FilterRequest()
Constructs a FilterRequest object with default parameters.
Definition: Filter.cs:127
Optional parameters.
Definition: Filter.cs:58
string view_name
If provided, then this will be the name of the view containing the results.
Definition: Filter.cs:90
const string VIEW_ID
view this filtered-view is part of.
Definition: Filter.cs:69
IDictionary< string, string > options
Optional parameters.
Definition: Filter.cs:122
FilterRequest(string table_name, string view_name, string expression, IDictionary< string, string > options=null)
Constructs a FilterRequest object with the specified parameters.
Definition: Filter.cs:172
const string TTL
Sets the TTL of the view specified in view_name.
Definition: Filter.cs:74
IDictionary< string, string > info
Additional information.
Definition: Filter.cs:198
A set of parameters for Kinetica.filter(string,string,string,IDictionary{string, string}).
Definition: Filter.cs:28
A set of results returned by Kinetica.filter(string,string,string,IDictionary{string, string}).
Definition: Filter.cs:190
long count
The number of records that matched the given select expression.
Definition: Filter.cs:195
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string expression
The select expression to filter the specified table.
Definition: Filter.cs:95
string table_name
Name of the table to filter.
Definition: Filter.cs:84