> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.CreateTriggerByAreaRequest > kinetica.CreateTriggerByAreaRequest — Kinetica C# API

A set of parameters for Kinetica.createTriggerByArea. More...

Inheritance diagram for kinetica.CreateTriggerByAreaRequest:
Collaboration diagram for kinetica.CreateTriggerByAreaRequest:

Public Member Functions
  CreateTriggerByAreaRequest ()
  Constructs a CreateTriggerByAreaRequest object with default parameters.
 
  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.
 
  CreateTriggerByAreaRequest ()
  Constructs a CreateTriggerByAreaRequest object with default parameters.
 
  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.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  request\_id \[get, set]
  User-created ID for the trigger.
 
IList\< string >  table\_names = new List\() \[get, set]
  Names of the tables on which the trigger will be activated and maintained, each in \[schema\_name.
 
string  x\_column\_name \[get, set]
  Name of a numeric column on which the trigger is activated.
 
IList\< double >  x\_vector = new List\() \[get, set]
  The respective coordinate values for the region on which the trigger is activated.
 
string  y\_column\_name \[get, set]
  Name of a second numeric column on which the trigger is activated.
 
IList\< double >  y\_vector = new List\() \[get, set]
  The respective coordinate values for the region on which the trigger is activated.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.createTriggerByArea.

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.) Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords 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) for any listening client to collect. Active triggers can be cancelled by using the Kinetica.clearTrigger 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 31 of file CreateTriggerByArea.cs.

Constructor & Destructor Documentation

◆ CreateTriggerByAreaRequest() \[1/4]

kinetica.CreateTriggerByAreaRequest.CreateTriggerByAreaRequest ( )
inline

Constructs a CreateTriggerByAreaRequest object with default parameters.

Definition at line 73 of file CreateTriggerByArea.cs.

◆ CreateTriggerByAreaRequest() \[2/4]

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, each in \[schema\_name.]table\_name format, using standard name resolution rules.
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.

◆ CreateTriggerByAreaRequest() \[3/4]

kinetica.CreateTriggerByAreaRequest.CreateTriggerByAreaRequest ( )
inline

Constructs a CreateTriggerByAreaRequest object with default parameters.

Definition at line 73 of file CreateTriggerByArea.cs.

◆ CreateTriggerByAreaRequest() \[4/4]

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, each in \[schema\_name.]table\_name format, using standard name resolution rules.
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 Dictionary\()
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 36 of file CreateTriggerByArea.cs.

◆ table\_names

IList\< string > kinetica.CreateTriggerByAreaRequest.table\_names = new List\()
getset

Names of the tables on which the trigger will be activated and maintained, each in \[schema\_name.

]table\_name format, using standard name resolution rules.

Definition at line 42 of file CreateTriggerByArea.cs.

◆ x\_column\_name

string kinetica.CreateTriggerByAreaRequest.x\_column\_name
getset

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

Usually 'x' for geospatial data points.

Definition at line 47 of file CreateTriggerByArea.cs.

◆ x\_vector

IList\< double > kinetica.CreateTriggerByAreaRequest.x\_vector = new List\()
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 53 of file CreateTriggerByArea.cs.

◆ y\_column\_name

string kinetica.CreateTriggerByAreaRequest.y\_column\_name
getset

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

Usually 'y' for geospatial data points.

Definition at line 58 of file CreateTriggerByArea.cs.

◆ y\_vector

IList\< double > kinetica.CreateTriggerByAreaRequest.y\_vector = new List\()
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 64 of file CreateTriggerByArea.cs.

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