A set of parameters for Kinetica.filterByBox(string,string,string,double,double,string,double,double,IDictionary<string, string>). More...
Inheritance diagram for kinetica.FilterByBoxRequest:
Collaboration diagram for kinetica.FilterByBoxRequest:
Public Member Functions | |
| FilterByBoxRequest () | |
| Constructs a FilterByBoxRequest object with default parameters. More... | |
| 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. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | table_name [get, set] |
| Name of the table on which the bounding box operation will be performed. More... | |
| string | view_name [get, set] |
| Optional name of the result view that will be created containing the results of the query. More... | |
| string | x_column_name = "" [get, set] |
| Name of the column on which to perform the bounding box query. More... | |
| double | min_x [get, set] |
| Lower bound for the column chosen by . More... | |
| double | max_x [get, set] |
| Upper bound for . More... | |
| string | y_column_name [get, set] |
| Name of a column on which to perform the bounding box query. More... | |
| double | min_y [get, set] |
| Lower bound for . More... | |
| double | max_y [get, set] |
| Upper bound for . More... | |
| IDictionary< string, string > | options [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.filterByBox(string,string,string,double,double,string,double,double,IDictionary<string, string>).
Calculates how many objects within the given table lie in a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a view_name is passed in as part of the input payload.
Definition at line 25 of file FilterByBox.cs.
Constructor & Destructor Documentation
◆ FilterByBoxRequest() [1/2]
|
inline |
Constructs a FilterByBoxRequest object with default parameters.
Definition at line 73 of file FilterByBox.cs.
◆ FilterByBoxRequest() [2/2]
|
inline |
Constructs a FilterByBoxRequest object with the specified parameters.
- Parameters
-
table_name Name of the table on which the bounding box operation will be performed. Must be an existing table. view_name Optional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables. x_column_name Name of the column on which to perform the bounding box query. Must be a valid numeric column. min_x Lower bound for the column chosen by . Must be less than or equal to . max_x Upper bound for . Must be greater than or equal to . y_column_name Name of a column on which to perform the bounding box query. Must be a valid numeric column. min_y Lower bound for . Must be less than or equal to . max_y Upper bound for . Must be greater than or equal to . options Optional parameters.
Definition at line 103 of file FilterByBox.cs.
Property Documentation
◆ max_x
|
getset |
◆ max_y
|
getset |
◆ min_x
|
getset |
Lower bound for the column chosen by .
Must be less than or equal to .
Definition at line 45 of file FilterByBox.cs.
◆ min_y
|
getset |
◆ options
|
getset |
Optional parameters.
Definition at line 68 of file FilterByBox.cs.
◆ table_name
|
getset |
Name of the table on which the bounding box operation will be performed.
Must be an existing table.
Definition at line 30 of file FilterByBox.cs.
◆ view_name
|
getset |
Optional name of the result view that will be created containing the results of the query.
Has the same naming restrictions as tables.
Definition at line 36 of file FilterByBox.cs.
◆ x_column_name
|
getset |
Name of the column on which to perform the bounding box query.
Must be a valid numeric column.
Definition at line 40 of file FilterByBox.cs.
◆ y_column_name
|
getset |
Name of a column on which to perform the bounding box query.
Must be a valid numeric column.
Definition at line 55 of file FilterByBox.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/FilterByBox.cs
