Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
22  {
26  public struct Options
27  {
42  public const string CREATE_TEMP_TABLE = "create_temp_table";
43 
44  public const string TRUE = "true";
45  public const string FALSE = "false";
46 
54  public const string COLLECTION_NAME = "collection_name";
55  } // end struct Options
56 
63  public string table_name { get; set; }
64 
73  public string view_name { get; set; } = "";
74 
77  public string x_column_name { get; set; }
78 
81  public IList<double> x_vector { get; set; } = new List<double>();
82 
85  public string y_column_name { get; set; }
86 
89  public IList<double> y_vector { get; set; } = new List<double>();
90 
131  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
132 
135  public FilterByAreaRequest() { }
136 
202  string view_name,
203  string x_column_name,
204  IList<double> x_vector,
205  string y_column_name,
206  IList<double> y_vector,
207  IDictionary<string, string> options = null)
208  {
209  this.table_name = table_name ?? "";
210  this.view_name = view_name ?? "";
211  this.x_column_name = x_column_name ?? "";
212  this.x_vector = x_vector ?? new List<double>();
213  this.y_column_name = y_column_name ?? "";
214  this.y_vector = y_vector ?? new List<double>();
215  this.options = options ?? new Dictionary<string, string>();
216  } // end constructor
217  } // end class FilterByAreaRequest
218 
223  {
227  public struct Info
228  {
231  public const string QUALIFIED_VIEW_NAME = "qualified_view_name";
232  } // end struct Info
233 
235  public long count { get; set; }
236 
248  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
249  } // end class FilterByAreaResponse
250 } // 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.
Definition: FilterByArea.cs:89
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica....
Definition: FilterByArea.cs:54
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.
Definition: FilterByArea.cs:81
string y_column_name
Name of the column containing the y values to be filtered.
Definition: FilterByArea.cs:85
A set of string constants for the parameter options.
Definition: FilterByArea.cs:26
A set of parameters for Kinetica.filterByArea.
Definition: FilterByArea.cs:21
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:42
A set of results returned by Kinetica.filterByArea.
string x_column_name
Name of the column containing the x values to be filtered.
Definition: FilterByArea.cs:77
string view_name
If provided, then this will be the name of the view containing the results, in [schema_name.
Definition: FilterByArea.cs:73
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
A set of string constants for the parameter info.
string table_name
Name of the table to filter, in [schema_name.
Definition: FilterByArea.cs:63
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.