Kinetica   C#   API  Version 7.2.3.1
FilterBySeriesRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes

const string CREATE_TEMP_TABLE = "create_temp_table"
 If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of view_name. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string COLLECTION_NAME = "collection_name"
 [DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the newly created view. More...
 
const string SPATIAL_RADIUS = "spatial_radius"
 A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. More...
 
const string TIME_RADIUS = "time_radius"
 A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. More...
 
const string SPATIAL_DISTANCE_METRIC = "spatial_distance_metric"
 A string representing the coordinate system to use for the spatial search criteria. More...
 
const string EUCLIDEAN = "euclidean"
 
const string GREAT_CIRCLE = "great_circle"
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 32 of file FilterBySeries.cs.

Member Data Documentation

◆ COLLECTION_NAME

const string FilterBySeriesRequest.Options.COLLECTION_NAME = "collection_name"

[DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the newly created view.

If the schema is non-existent, it will be automatically created.

Definition at line 60 of file FilterBySeries.cs.

◆ CREATE_TEMP_TABLE

const string FilterBySeriesRequest.Options.CREATE_TEMP_TABLE = "create_temp_table"

If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of view_name.

Supported values:

The default value is FALSE.

Definition at line 48 of file FilterBySeries.cs.

◆ EUCLIDEAN

const string FilterBySeriesRequest.Options.EUCLIDEAN = "euclidean"

Definition at line 90 of file FilterBySeries.cs.

◆ FALSE

const string FilterBySeriesRequest.Options.FALSE = "false"

Definition at line 51 of file FilterBySeries.cs.

◆ GREAT_CIRCLE

const string FilterBySeriesRequest.Options.GREAT_CIRCLE = "great_circle"

Definition at line 91 of file FilterBySeries.cs.

◆ SPATIAL_DISTANCE_METRIC

const string FilterBySeriesRequest.Options.SPATIAL_DISTANCE_METRIC = "spatial_distance_metric"

A string representing the coordinate system to use for the spatial search criteria.

Supported values:

Definition at line 88 of file FilterBySeries.cs.

◆ SPATIAL_RADIUS

const string FilterBySeriesRequest.Options.SPATIAL_RADIUS = "spatial_radius"

A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates.

The value is interpreted in meters. Required parameter. The minimum allowed value is '0'.

Definition at line 67 of file FilterBySeries.cs.

◆ TIME_RADIUS

const string FilterBySeriesRequest.Options.TIME_RADIUS = "time_radius"

A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points.

The value is interpreted in seconds. Required parameter. The minimum allowed value is '0'.

Definition at line 74 of file FilterBySeries.cs.

◆ TRUE

const string FilterBySeriesRequest.Options.TRUE = "true"

Definition at line 50 of file FilterBySeries.cs.


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