Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
FilterByBox.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 
70  public struct Options
71  {
72 
91  public const string CREATE_TEMP_TABLE = "create_temp_table";
92  public const string TRUE = "true";
93  public const string FALSE = "false";
94 
101  public const string COLLECTION_NAME = "collection_name";
102  } // end struct Options
103 
104 
110  public string table_name { get; set; }
111 
119  public string view_name { get; set; } = "";
120 
123  public string x_column_name { get; set; }
124 
128  public double min_x { get; set; }
129 
134  public double max_x { get; set; }
135 
138  public string y_column_name { get; set; }
139 
143  public double min_y { get; set; }
144 
148  public double max_y { get; set; }
149 
187  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
188 
189 
192  public FilterByBoxRequest() { }
193 
266  string view_name,
267  string x_column_name,
268  double min_x,
269  double max_x,
270  string y_column_name,
271  double min_y,
272  double max_y,
273  IDictionary<string, string> options = null)
274  {
275  this.table_name = table_name ?? "";
276  this.view_name = view_name ?? "";
277  this.x_column_name = x_column_name ?? "";
278  this.min_x = min_x;
279  this.max_x = max_x;
280  this.y_column_name = y_column_name ?? "";
281  this.min_y = min_y;
282  this.max_y = max_y;
283  this.options = options ?? new Dictionary<string, string>();
284  } // end constructor
285 
286  } // end class FilterByBoxRequest
287 
288 
289 
294  {
295 
308  public struct Info
309  {
310 
313  public const string QUALIFIED_VIEW_NAME = "qualified_view_name";
314  } // end struct Info
315 
316 
318  public long count { get; set; }
319 
330  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
331 
332  } // end class FilterByBoxResponse
333 
334 
335 
336 
337 } // end namespace kinetica
string view_name
If provided, then this will be the name of the view containing the results, in [schema_name.
Definition: FilterByBox.cs:119
const string CREATE_TEMP_TABLE
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of ...
Definition: FilterByBox.cs:91
double min_x
Lower bound for the column chosen by .
Definition: FilterByBox.cs:128
FilterByBoxRequest(string table_name, string view_name, string x_column_name, double min_x, double max_x, string y_column_name, double min_y, double max_y, IDictionary< string, string > options=null)
Constructs a FilterByBoxRequest object with the specified parameters.
Definition: FilterByBox.cs:265
IDictionary< string, string > options
Optional parameters.
Definition: FilterByBox.cs:187
string table_name
Name of the table on which the bounding box operation will be performed, in [schema_name.
Definition: FilterByBox.cs:110
double max_y
Upper bound for .
Definition: FilterByBox.cs:148
double min_y
Lower bound for .
Definition: FilterByBox.cs:143
const string QUALIFIED_VIEW_NAME
The fully qualified name of the view (i.e.
Definition: FilterByBox.cs:313
string x_column_name
Name of the column on which to perform the bounding box query.
Definition: FilterByBox.cs:123
FilterByBoxRequest()
Constructs a FilterByBoxRequest object with default parameters.
Definition: FilterByBox.cs:192
long count
The number of records passing the box filter.
Definition: FilterByBox.cs:318
Additional information.
Definition: FilterByBox.cs:308
A set of results returned by Kinetica.filterByBox(string,string,string,double,double,string,double,double,IDictionary{string, string}).
Definition: FilterByBox.cs:293
double max_x
Upper bound for .
Definition: FilterByBox.cs:134
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica...
Definition: FilterByBox.cs:101
IDictionary< string, string > info
Additional information.
Definition: FilterByBox.cs:330
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string y_column_name
Name of a column on which to perform the bounding box query.
Definition: FilterByBox.cs:138
A set of parameters for Kinetica.filterByBox(string,string,string,double,double,string,double,double,IDictionary{string, string}).
Definition: FilterByBox.cs:28