Kinetica   C#   API  Version 7.2.3.0
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 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 
62  public string table_name { get; set; }
63 
72  public string view_name { get; set; } = "";
73 
77  public string x_column_name { get; set; }
78 
83  public double min_x { get; set; }
84 
88  public double max_x { get; set; }
89 
93  public string y_column_name { get; set; }
94 
98  public double min_y { get; set; }
99 
103  public double max_y { get; set; }
104 
144  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
145 
148  public FilterByBoxRequest() { }
149 
223  string view_name,
224  string x_column_name,
225  double min_x,
226  double max_x,
227  string y_column_name,
228  double min_y,
229  double max_y,
230  IDictionary<string, string> options = null)
231  {
232  this.table_name = table_name ?? "";
233  this.view_name = view_name ?? "";
234  this.x_column_name = x_column_name ?? "";
235  this.min_x = min_x;
236  this.max_x = max_x;
237  this.y_column_name = y_column_name ?? "";
238  this.min_y = min_y;
239  this.max_y = max_y;
240  this.options = options ?? new Dictionary<string, string>();
241  } // end constructor
242  } // end class FilterByBoxRequest
243 
248  {
252  public struct Info
253  {
256  public const string QUALIFIED_VIEW_NAME = "qualified_view_name";
257  } // end struct Info
258 
260  public long count { get; set; }
261 
273  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
274  } // end class FilterByBoxResponse
275 } // 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:72
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:42
double min_x
Lower bound for the column chosen by x_column_name.
Definition: FilterByBox.cs:83
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:222
IDictionary< string, string > options
Optional parameters.
Definition: FilterByBox.cs:144
string table_name
Name of the table on which the bounding box operation will be performed, in [schema_name.
Definition: FilterByBox.cs:62
double max_y
Upper bound for y_column_name.
Definition: FilterByBox.cs:103
double min_y
Lower bound for y_column_name.
Definition: FilterByBox.cs:98
const string QUALIFIED_VIEW_NAME
The fully qualified name of the view (i.e.
Definition: FilterByBox.cs:256
string x_column_name
Name of the column on which to perform the bounding box query.
Definition: FilterByBox.cs:77
FilterByBoxRequest()
Constructs a FilterByBoxRequest object with default parameters.
Definition: FilterByBox.cs:148
long count
The number of records passing the box filter.
Definition: FilterByBox.cs:260
A set of string constants for the parameter options.
Definition: FilterByBox.cs:26
A set of string constants for the parameter info.
Definition: FilterByBox.cs:252
A set of results returned by Kinetica.filterByBox.
Definition: FilterByBox.cs:247
double max_x
Upper bound for x_column_name.
Definition: FilterByBox.cs:88
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica....
Definition: FilterByBox.cs:54
IDictionary< string, string > info
Additional information.
Definition: FilterByBox.cs:273
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:93
A set of parameters for Kinetica.filterByBox.
Definition: FilterByBox.cs:21