Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
FilterByList.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 
35  {
36 
74  public struct Options
75  {
76 
81  public const string COLLECTION_NAME = "collection_name";
82 
102  public const string FILTER_MODE = "filter_mode";
103 
106  public const string IN_LIST = "in_list";
107 
110  public const string NOT_IN_LIST = "not_in_list";
111  } // end struct Options
112 
113 
120  public string table_name { get; set; }
121 
126  public string view_name { get; set; } = "";
127 
130  public IDictionary<string, IList<string>> column_values_map { get; set; } = new Dictionary<string, IList<string>>();
131 
167  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
168 
169 
172  public FilterByListRequest() { }
173 
226  string view_name,
227  IDictionary<string, IList<string>> column_values_map,
228  IDictionary<string, string> options = null)
229  {
230  this.table_name = table_name ?? "";
231  this.view_name = view_name ?? "";
232  this.column_values_map = column_values_map ?? new Dictionary<string, IList<string>>();
233  this.options = options ?? new Dictionary<string, string>();
234  } // end constructor
235 
236  } // end class FilterByListRequest
237 
238 
239 
244  {
245 
247  public long count { get; set; }
248 
250  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
251 
252  } // end class FilterByListResponse
253 
254 
255 
256 
257 } // end namespace kinetica
const string IN_LIST
The filter will match all items that are in the provided list(s).
const string FILTER_MODE
String indicating the filter mode, either &#39;in_list&#39; or &#39;not_in_list&#39;.
const string NOT_IN_LIST
The filter will match all items that are not in the provided list(s).
IDictionary< string, IList< string > > column_values_map
List of values for the corresponding column in the table
string table_name
Name of the table to filter.
string view_name
If provided, then this will be the name of the view containing the results.
A set of parameters for Kinetica.filterByList(string,string,IDictionary{string, IList{string}},IDictionary{string, string}).
Definition: FilterByList.cs:34
IDictionary< string, string > options
Optional parameters.
long count
The number of records passing the list filter.
FilterByListRequest(string table_name, string view_name, IDictionary< string, IList< string >> column_values_map, IDictionary< string, string > options=null)
Constructs a FilterByListRequest object with the specified parameters.
const string COLLECTION_NAME
Name of a collection which is to contain the newly created view.
Definition: FilterByList.cs:81
IDictionary< string, string > info
Additional information.
FilterByListRequest()
Constructs a FilterByListRequest object with default parameters.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of results returned by Kinetica.filterByList(string,string,IDictionary{string, IList{string}},IDictionary{string, string}).