Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
FilterByArea.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 
30  {
31 
71  public struct Options
72  {
73 
92  public const string CREATE_TEMP_TABLE = "create_temp_table";
93  public const string TRUE = "true";
94  public const string FALSE = "false";
95 
102  public const string COLLECTION_NAME = "collection_name";
103  } // end struct Options
104 
105 
111  public string table_name { get; set; }
112 
120  public string view_name { get; set; } = "";
121 
124  public string x_column_name { get; set; }
125 
128  public IList<double> x_vector { get; set; } = new List<double>();
129 
132  public string y_column_name { get; set; }
133 
136  public IList<double> y_vector { get; set; } = new List<double>();
137 
175  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
176 
177 
180  public FilterByAreaRequest() { }
181 
245  string view_name,
246  string x_column_name,
247  IList<double> x_vector,
248  string y_column_name,
249  IList<double> y_vector,
250  IDictionary<string, string> options = null)
251  {
252  this.table_name = table_name ?? "";
253  this.view_name = view_name ?? "";
254  this.x_column_name = x_column_name ?? "";
255  this.x_vector = x_vector ?? new List<double>();
256  this.y_column_name = y_column_name ?? "";
257  this.y_vector = y_vector ?? new List<double>();
258  this.options = options ?? new Dictionary<string, string>();
259  } // end constructor
260 
261  } // end class FilterByAreaRequest
262 
263 
264 
269  {
270 
283  public struct Info
284  {
285 
288  public const string QUALIFIED_VIEW_NAME = "qualified_view_name";
289  } // end struct Info
290 
291 
293  public long count { get; set; }
294 
305  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
306 
307  } // end class FilterByAreaResponse
308 
309 
310 
311 
312 } // end namespace kinetica
const string QUALIFIED_VIEW_NAME
The fully qualified name of the view (i.e.
IList< double > y_vector
List of y coordinates of the vertices of the polygon representing the area to be filtered.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica...
IDictionary< string, string > info
Additional information.
IList< double > x_vector
List of x coordinates of the vertices of the polygon representing the area to be filtered.
string y_column_name
Name of the column containing the y values to be filtered.
A set of parameters for Kinetica.filterByArea(string,string,string,IList{double},string,IList{double},IDictionary{string, string}).
Definition: FilterByArea.cs:29
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: FilterByArea.cs:92
A set of results returned by Kinetica.filterByArea(string,string,string,IList{double},string,IList{double},IDictionary{string, string}).
string x_column_name
Name of the column containing the x values to be filtered.
string view_name
If provided, then this will be the name of the view containing the results, in [schema_name.
long count
The number of records passing the area filter.
FilterByAreaRequest()
Constructs a FilterByAreaRequest object with default parameters.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
Additional information.
string table_name
Name of the table to filter, in [schema_name.
FilterByAreaRequest(string table_name, string view_name, string x_column_name, IList< double > x_vector, string y_column_name, IList< double > y_vector, IDictionary< string, string > options=null)
Constructs a FilterByAreaRequest object with the specified parameters.
IDictionary< string, string > options
Optional parameters.