kinetica.ClearTableMonitorRequest Class Reference
A set of parameters for Kinetica.clearTableMonitor. More...
Inheritance diagram for kinetica.ClearTableMonitorRequest:
Collaboration diagram for kinetica.ClearTableMonitorRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ClearTableMonitorRequest () | |
| Constructs a ClearTableMonitorRequest object with default parameters. More... | |
| ClearTableMonitorRequest (string topic_id, IDictionary< string, string > options=null) | |
| Constructs a ClearTableMonitorRequest 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 | topic_id [get, set] |
| The topic ID returned by Kinetica.createTableMonitor. 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... | |
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.clearTableMonitor.
Deactivates a table monitor previously created with Kinetica.createTableMonitor.
Definition at line 17 of file ClearTableMonitor.cs.
Constructor & Destructor Documentation
◆ ClearTableMonitorRequest() [1/2]
|
inline |
Constructs a ClearTableMonitorRequest object with default parameters.
Definition at line 116 of file ClearTableMonitor.cs.
◆ ClearTableMonitorRequest() [2/2]
|
inline |
Constructs a ClearTableMonitorRequest object with the specified parameters.
- Parameters
-
topic_id The topic ID returned by Kinetica.createTableMonitor. options Optional parameters. - KEEP_AUTOGENERATED_SINK: If TRUE, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If FALSE, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values: The default value is FALSE.
- CLEAR_ALL_REFERENCES: If TRUE, all references that share the same topic_id will be cleared. Supported values: The default value is FALSE.
Definition at line 170 of file ClearTableMonitor.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- KEEP_AUTOGENERATED_SINK: If TRUE, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If FALSE, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values: The default value is FALSE.
- CLEAR_ALL_REFERENCES: If TRUE, all references that share the same topic_id will be cleared. Supported values: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 112 of file ClearTableMonitor.cs.
◆ topic_id
|
getset |
The topic ID returned by Kinetica.createTableMonitor.
Definition at line 64 of file ClearTableMonitor.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/ClearTableMonitor.cs
