Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.FilterByListRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string COLLECTION_NAME = "collection_name"
 Name of a collection which is to contain the newly created view. More...
 
const string FILTER_MODE = "filter_mode"
 String indicating the filter mode, either 'in_list' or 'not_in_list'. More...
 
const string IN_LIST = "in_list"
 The filter will match all items that are in the provided list(s). More...
 
const string NOT_IN_LIST = "not_in_list"
 The filter will match all items that are not in the provided list(s). More...
 

Detailed Description

Optional parameters.

  • COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
  • FILTER_MODE: String indicating the filter mode, either 'in_list' or 'not_in_list'. Supported values:
    • IN_LIST: The filter will match all items that are in the provided list(s).
    • NOT_IN_LIST: The filter will match all items that are not in the provided list(s).
    The default value is IN_LIST.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 74 of file FilterByList.cs.

Member Data Documentation

const string kinetica.FilterByListRequest.Options.COLLECTION_NAME = "collection_name"

Name of a collection which is to contain the newly created view.

If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.

Definition at line 81 of file FilterByList.cs.

const string kinetica.FilterByListRequest.Options.FILTER_MODE = "filter_mode"

String indicating the filter mode, either 'in_list' or 'not_in_list'.

Supported values:

  • IN_LIST: The filter will match all items that are in the provided list(s).
  • NOT_IN_LIST: The filter will match all items that are not in the provided list(s).

The default value is IN_LIST.

Definition at line 102 of file FilterByList.cs.

const string kinetica.FilterByListRequest.Options.IN_LIST = "in_list"

The filter will match all items that are in the provided list(s).

Definition at line 106 of file FilterByList.cs.

const string kinetica.FilterByListRequest.Options.NOT_IN_LIST = "not_in_list"

The filter will match all items that are not in the provided list(s).

Definition at line 110 of file FilterByList.cs.


The documentation for this struct was generated from the following file: