Skip to main content

A set of parameters for Kinetica.alterTableMonitor. More…

Inheritance diagram for kinetica.AlterTableMonitorRequest:
Collaboration diagram for kinetica.AlterTableMonitorRequest:

Classes

struct  MonitorUpdatesMap
 A set of string constants for the parameter AlterTableMonitorRequest.monitor_updates_map. More…
 

Public Member Functions

 AlterTableMonitorRequest ()
 Constructs an AlterTableMonitorRequest object with default parameters.
 
 AlterTableMonitorRequest (string topic_id, IDictionary< string, string > monitor_updates_map, IDictionary< string, string > options=null)
 Constructs an AlterTableMonitorRequest object with the specified parameters.
 
 AlterTableMonitorRequest ()
 Constructs an AlterTableMonitorRequest object with default parameters.
 
 AlterTableMonitorRequest (string topic_id, IDictionary< string, string > monitor_updates_map, IDictionary< string, string > options=null)
 Constructs an AlterTableMonitorRequest 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 topic_id [get, set]
 The topic ID returned by Kinetica.createTableMonitor.
 
IDictionary< string, string > monitor_updates_map = new Dictionary<string, string>() [get, set]
 Map containing the properties of the table monitor to be updated.
 
IDictionary< string, string > options = new Dictionary<string, string>() [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.alterTableMonitor.

Alters a table monitor previously created with Kinetica.createTableMonitor.

Definition at line 17 of file AlterTableMonitor.cs.

Constructor & Destructor Documentation

◆ AlterTableMonitorRequest() [1/4]

kinetica.AlterTableMonitorRequest.AlterTableMonitorRequest ()
inline

Constructs an AlterTableMonitorRequest object with default parameters.

Definition at line 127 of file AlterTableMonitor.cs.

◆ AlterTableMonitorRequest() [2/4]

kinetica.AlterTableMonitorRequest.AlterTableMonitorRequest (stringtopic_id,
IDictionary< string, string >monitor_updates_map,
IDictionary< string, string >options = null )
inline

Constructs an AlterTableMonitorRequest object with the specified parameters.

Parameters
topic_idThe topic ID returned by Kinetica.createTableMonitor.
monitor_updates_mapMap containing the properties of the table monitor to be updated. Error if empty.
  • SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn’t exist, an error will be thrown. If SCHEMA_NAME is empty, then the user’s default schema will be used.
  • MAX_CONSECUTIVE_FAILURES: Updates the maximum number of consecutive failures before suspending the stream. A value of ‘-1’ to disables auto-suspend. This value is by rank and not overall.
  • NOTIFICATIONS: Updates the state of the monitor. Supported values:The default value is an empty Dictionary.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 181 of file AlterTableMonitor.cs.

◆ AlterTableMonitorRequest() [3/4]

kinetica.AlterTableMonitorRequest.AlterTableMonitorRequest ()
inline

Constructs an AlterTableMonitorRequest object with default parameters.

Definition at line 127 of file AlterTableMonitor.cs.

◆ AlterTableMonitorRequest() [4/4]

kinetica.AlterTableMonitorRequest.AlterTableMonitorRequest (stringtopic_id,
IDictionary< string, string >monitor_updates_map,
IDictionary< string, string >options = null )
inline

Constructs an AlterTableMonitorRequest object with the specified parameters.

Parameters
topic_idThe topic ID returned by Kinetica.createTableMonitor.
monitor_updates_mapMap containing the properties of the table monitor to be updated. Error if empty.
  • SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn’t exist, an error will be thrown. If SCHEMA_NAME is empty, then the user’s default schema will be used.
  • MAX_CONSECUTIVE_FAILURES: Updates the maximum number of consecutive failures before suspending the stream. A value of ‘-1’ to disables auto-suspend. This value is by rank and not overall.
  • NOTIFICATIONS: Updates the state of the monitor. Supported values:The default value is an empty Dictionary.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 181 of file AlterTableMonitor.cs.

Property Documentation

◆ monitor_updates_map

IDictionary< string, string > kinetica.AlterTableMonitorRequest.monitor_updates_map = new Dictionary<string, string>()
getset

Map containing the properties of the table monitor to be updated.

Error if empty.

  • SCHEMA_NAME: Updates the schema name. If SCHEMA_NAME doesn’t exist, an error will be thrown. If SCHEMA_NAME is empty, then the user’s default schema will be used.
  • MAX_CONSECUTIVE_FAILURES: Updates the maximum number of consecutive failures before suspending the stream. A value of ‘-1’ to disables auto-suspend. This value is by rank and not overall.
  • NOTIFICATIONS: Updates the state of the monitor. Supported values:The default value is an empty Dictionary.

Definition at line 118 of file AlterTableMonitor.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 123 of file AlterTableMonitor.cs.

◆ topic_id

string kinetica.AlterTableMonitorRequest.topic_id
getset

The topic ID returned by Kinetica.createTableMonitor.

Definition at line 71 of file AlterTableMonitor.cs.


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