A set of parameters for Kinetica.createTriggerByArea(string,IList<string>,string,IList<double>,string,IList<double>,IDictionary<string, string>). More...

Inheritance diagram for kinetica.CreateTriggerByAreaRequest:

Collaboration diagram for kinetica.CreateTriggerByAreaRequest:

Public Member Functions
	CreateTriggerByAreaRequest ()
	Constructs a CreateTriggerByAreaRequest object with default parameters. More...

	CreateTriggerByAreaRequest (string request_id, IList< string > table_names, string x_column_name, IList< double > x_vector, string y_column_name, IList< double > y_vector, IDictionary< string, string > options=null)
	Constructs a CreateTriggerByAreaRequest 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	request_id `[get, set]`
	User-created ID for the trigger. More...

IList< string >	table_names `[get, set]`
	Names of the tables on which the trigger will be activated and maintained. More...

string	x_column_name = new List<string>() `[get, set]`
	Name of a numeric column on which the trigger is activated. More...

IList< double >	x_vector `[get, set]`
	The respective coordinate values for the region on which the trigger is activated. More...

string	y_column_name = new List<double>() `[get, set]`
	Name of a second numeric column on which the trigger is activated. More...

IList< double >	y_vector `[get, set]`
	The respective coordinate values for the region on which the trigger is activated. More...

IDictionary< string, string >	options = new List<double>() `[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.createTriggerByArea(string,IList<string>,string,IList<double>,string,IList<double>,IDictionary<string, string>).

Sets up an area trigger mechanism for two column_names for one or more tables. (This function is essentially the two-dimensional version of Kinetica.createTriggerByRange(string,IList<string>,string,double,double,IDictionary<string, string>).) Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords<T>(string,IList<T>,IDictionary<string, string>) with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via Kinetica.showSystemStatus(IDictionary<string, string>)) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger(string,IDictionary<string, string>) endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Definition at line 36 of file CreateTriggerByArea.cs.

Constructor & Destructor Documentation

◆ CreateTriggerByAreaRequest() [1/2]

kinetica.CreateTriggerByAreaRequest.CreateTriggerByAreaRequest ( )

inline

Constructs a CreateTriggerByAreaRequest object with default parameters.

Definition at line 74 of file CreateTriggerByArea.cs.

◆ CreateTriggerByAreaRequest() [2/2]

kinetica.CreateTriggerByAreaRequest.CreateTriggerByAreaRequest	(	string	request_id,
		IList< string >	table_names,
		string	x_column_name,
		IList< double >	x_vector,
		string	y_column_name,
		IList< double >	y_vector,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateTriggerByAreaRequest object with the specified parameters.

Parameters

request_id	User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
table_names	Names of the tables on which the trigger will be activated and maintained.
x_column_name	Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
x_vector	The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
y_column_name	Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
y_vector	The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 100 of file CreateTriggerByArea.cs.

Property Documentation

◆ options

IDictionary<string, string> kinetica.CreateTriggerByAreaRequest.options = new List<double>()

getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 69 of file CreateTriggerByArea.cs.

◆ request_id

string kinetica.CreateTriggerByAreaRequest.request_id

getset

User-created ID for the trigger.

The ID can be alphanumeric, contain symbols, and must contain at least one character.

Definition at line 42 of file CreateTriggerByArea.cs.

◆ table_names

IList<string> kinetica.CreateTriggerByAreaRequest.table_names

getset

Names of the tables on which the trigger will be activated and maintained.

Definition at line 46 of file CreateTriggerByArea.cs.

◆ x_column_name

string kinetica.CreateTriggerByAreaRequest.x_column_name = new List<string>()

getset

Name of a numeric column on which the trigger is activated.

Usually 'x' for geospatial data points.

Definition at line 50 of file CreateTriggerByArea.cs.

◆ x_vector

IList<double> kinetica.CreateTriggerByAreaRequest.x_vector

getset

The respective coordinate values for the region on which the trigger is activated.

This usually translates to the x-coordinates of a geospatial region.

Definition at line 55 of file CreateTriggerByArea.cs.

◆ y_column_name

string kinetica.CreateTriggerByAreaRequest.y_column_name = new List<double>()

getset

Name of a second numeric column on which the trigger is activated.

Usually 'y' for geospatial data points.

Definition at line 59 of file CreateTriggerByArea.cs.

◆ y_vector

IList<double> kinetica.CreateTriggerByAreaRequest.y_vector

getset

The respective coordinate values for the region on which the trigger is activated.

This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.

Definition at line 65 of file CreateTriggerByArea.cs.

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

Kinetica/Protocol/CreateTriggerByArea.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateTriggerByAreaRequest() [1/2]

◆ CreateTriggerByAreaRequest() [2/2]

Property Documentation

◆ options

◆ request_id

◆ table_names

◆ x_column_name

◆ x_vector

◆ y_column_name

◆ y_vector