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

Inheritance diagram for kinetica.CreateTriggerByRangeRequest:

Collaboration diagram for kinetica.CreateTriggerByRangeRequest:

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

	CreateTriggerByRangeRequest (string request_id, IList< string > table_names, string column_name, double min, double max, IDictionary< string, string > options=null)
	Constructs a CreateTriggerByRangeRequest object with the specified parameters. More...

	CreateTriggerByRangeRequest ()
	Constructs a CreateTriggerByRangeRequest object with default parameters. More...

	CreateTriggerByRangeRequest (string request_id, IList< string > table_names, string column_name, double min, double max, IDictionary< string, string > options=null)
	Constructs a CreateTriggerByRangeRequest 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...

	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 = new List<string>() `[get, set]`
	Tables on which the trigger will be active, each in [schema_name. More...

string	column_name `[get, set]`
	Name of a numeric column_name on which the trigger is activated. More...

double	min `[get, set]`
	The lower bound (inclusive) for the trigger range. More...

double	max `[get, set]`
	The upper bound (inclusive) for the trigger range. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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...

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.createTriggerByRange.

Sets up a simple range trigger for a column_name for one or more tables. Once the trigger has been activated, any record added to the listed tables(s) via Kinetica.insertRecords with the chosen column_name's value falling within the specified range 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 28 of file CreateTriggerByRange.cs.

Constructor & Destructor Documentation

◆ CreateTriggerByRangeRequest() [1/4]

kinetica.CreateTriggerByRangeRequest.CreateTriggerByRangeRequest ( )

inline

Constructs a CreateTriggerByRangeRequest object with default parameters.

Definition at line 60 of file CreateTriggerByRange.cs.

◆ CreateTriggerByRangeRequest() [2/4]

kinetica.CreateTriggerByRangeRequest.CreateTriggerByRangeRequest	(	string	request_id,
		IList< string >	table_names,
		string	column_name,
		double	min,
		double	max,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateTriggerByRangeRequest 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	Tables on which the trigger will be active, each in [schema_name.]table_name format, using standard name resolution rules.
column_name	Name of a numeric column_name on which the trigger is activated.
min	The lower bound (inclusive) for the trigger range.
max	The upper bound (inclusive) for the trigger range.
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 80 of file CreateTriggerByRange.cs.

◆ CreateTriggerByRangeRequest() [3/4]

kinetica.CreateTriggerByRangeRequest.CreateTriggerByRangeRequest ( )

inline

Constructs a CreateTriggerByRangeRequest object with default parameters.

Definition at line 60 of file CreateTriggerByRange.cs.

◆ CreateTriggerByRangeRequest() [4/4]

kinetica.CreateTriggerByRangeRequest.CreateTriggerByRangeRequest	(	string	request_id,
		IList< string >	table_names,
		string	column_name,
		double	min,
		double	max,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateTriggerByRangeRequest 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	Tables on which the trigger will be active, each in [schema_name.]table_name format, using standard name resolution rules.
column_name	Name of a numeric column_name on which the trigger is activated.
min	The lower bound (inclusive) for the trigger range.
max	The upper bound (inclusive) for the trigger range.
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 80 of file CreateTriggerByRange.cs.

Property Documentation

◆ column_name

string kinetica.CreateTriggerByRangeRequest.column_name

getset

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

Definition at line 43 of file CreateTriggerByRange.cs.

◆ max

double kinetica.CreateTriggerByRangeRequest.max

getset

The upper bound (inclusive) for the trigger range.

Definition at line 51 of file CreateTriggerByRange.cs.

◆ min

double kinetica.CreateTriggerByRangeRequest.min

getset

The lower bound (inclusive) for the trigger range.

Definition at line 47 of file CreateTriggerByRange.cs.

◆ options

IDictionary< string, string > kinetica.CreateTriggerByRangeRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 56 of file CreateTriggerByRange.cs.

◆ request_id

string kinetica.CreateTriggerByRangeRequest.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 33 of file CreateTriggerByRange.cs.

◆ table_names

IList< string > kinetica.CreateTriggerByRangeRequest.table_names = new List<string>()

getset

Tables on which the trigger will be active, each in [schema_name.

]table_name format, using standard name resolution rules.

Definition at line 39 of file CreateTriggerByRange.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateTriggerByRange.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateTriggerByRangeRequest() [1/4]

◆ CreateTriggerByRangeRequest() [2/4]

◆ CreateTriggerByRangeRequest() [3/4]

◆ CreateTriggerByRangeRequest() [4/4]

Property Documentation

◆ column_name

◆ max

◆ min

◆ options

◆ request_id

◆ table_names