kinetica.AlterTableMonitorRequest Class Reference
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 monitor_updates_map. More... | |
Public Member Functions | |
| AlterTableMonitorRequest () | |
| Constructs an AlterTableMonitorRequest object with default parameters. More... | |
| AlterTableMonitorRequest (string topic_id, IDictionary< string, string > monitor_updates_map, IDictionary< string, string > options) | |
| Constructs an AlterTableMonitorRequest object with the specified parameters. More... | |
| AlterTableMonitorRequest () | |
| Constructs an AlterTableMonitorRequest object with default parameters. More... | |
| AlterTableMonitorRequest (string topic_id, IDictionary< string, string > monitor_updates_map, IDictionary< string, string > options=null) | |
| Constructs an AlterTableMonitorRequest 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 | topic_id [get, set] |
| The topic ID returned by Kinetica.createTableMonitor. More... | |
| IDictionary< string, string > | monitor_updates_map = new Dictionary<string, string>() [get, set] |
| Map containing the properties of the table monitor to be updated. 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.alterTableMonitor.
Alters a table monitor previously created with Kinetica.createTableMonitor.
Definition at line 17 of file AlterTableMonitor.cs.
Constructor & Destructor Documentation
◆ AlterTableMonitorRequest() [1/4]
|
inline |
Constructs an AlterTableMonitorRequest object with default parameters.
Definition at line 62 of file AlterTableMonitor.cs.
◆ AlterTableMonitorRequest() [2/4]
|
inline |
Constructs an AlterTableMonitorRequest object with the specified parameters.
- Parameters
-
topic_id The topic ID returned by Kinetica.createTableMonitor. monitor_updates_map 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.
options Optional parameters.
Definition at line 86 of file AlterTableMonitor.cs.
◆ AlterTableMonitorRequest() [3/4]
|
inline |
Constructs an AlterTableMonitorRequest object with default parameters.
Definition at line 117 of file AlterTableMonitor.cs.
◆ AlterTableMonitorRequest() [4/4]
|
inline |
Constructs an AlterTableMonitorRequest object with the specified parameters.
- Parameters
-
topic_id The topic ID returned by Kinetica.createTableMonitor. monitor_updates_map 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.
options Optional parameters. The default value is an empty Dictionary.
Definition at line 170 of file AlterTableMonitor.cs.
Property Documentation
◆ monitor_updates_map
|
getset |
Map containing the properties of the table monitor to be updated.
- 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.
- 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 55 of file AlterTableMonitor.cs.
◆ options
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 58 of file AlterTableMonitor.cs.
◆ topic_id
|
getset |
The topic ID returned by Kinetica.createTableMonitor.
Definition at line 38 of file AlterTableMonitor.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/AlterTableMonitor.cs
