Kinetica   C#   API  Version 7.2.3.0
CreateTableMonitor.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica
10 {
32  public class CreateTableMonitorRequest : KineticaData
33  {
37  public struct Options
38  {
64  public const string EVENT = "event";
65 
69  public const string INSERT = "insert";
70 
74  public const string UPDATE = "update";
75 
79  public const string DELETE = "delete";
80 
83  public const string MONITOR_ID = "monitor_id";
84 
88  public const string DATASINK_NAME = "datasink_name";
89 
94  public const string MAX_CONSECUTIVE_FAILURES = "max_consecutive_failures";
95 
105  public const string FAILED_NOTIFICATIONS_TABLE_NAME = "failed_notifications_table_name";
106 
111  public const string DESTINATION = "destination";
112 
116  public const string KAFKA_TOPIC_NAME = "kafka_topic_name";
117 
120  public const string INCREASING_COLUMN = "increasing_column";
121 
124  public const string EXPRESSION = "expression";
125 
133  public const string JOIN_TABLE_NAMES = "join_table_names";
134 
141  public const string JOIN_COLUMN_NAMES = "join_column_names";
142 
150  public const string JOIN_EXPRESSIONS = "join_expressions";
151 
173  public const string REFRESH_METHOD = "refresh_method";
174 
176  public const string ON_CHANGE = "on_change";
177 
180  public const string PERIODIC = "periodic";
181 
186  public const string REFRESH_PERIOD = "refresh_period";
187 
194  public const string REFRESH_START_TIME = "refresh_start_time";
195  } // end struct Options
196 
201  public string table_name { get; set; }
202 
381  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
382 
386 
573  IDictionary<string, string> options = null)
574  {
575  this.table_name = table_name ?? "";
576  this.options = options ?? new Dictionary<string, string>();
577  } // end constructor
578  } // end class CreateTableMonitorRequest
579 
583  public class CreateTableMonitorResponse : KineticaData
584  {
588  public struct Info
589  {
592  public const string TTL = "ttl";
593 
598  public const string INSERT_TOPIC_ID = "insert_topic_id";
599 
604  public const string UPDATE_TOPIC_ID = "update_topic_id";
605 
610  public const string DELETE_TOPIC_ID = "delete_topic_id";
611 
614  public const string INSERT_TYPE_SCHEMA = "insert_type_schema";
615 
617  public const string UPDATE_TYPE_SCHEMA = "update_type_schema";
618 
620  public const string DELETE_TYPE_SCHEMA = "delete_type_schema";
621  } // end struct Info
622 
625  public string topic_id { get; set; }
626 
630  public string table_name { get; set; }
631 
634  public string type_schema { get; set; }
635 
693  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
694  } // end class CreateTableMonitorResponse
695 } // end namespace kinetica
CreateTableMonitorRequest(string table_name, IDictionary< string, string > options=null)
Constructs a CreateTableMonitorRequest object with the specified parameters.
const string REFRESH_START_TIME
When REFRESH_METHOD is PERIODIC, specifies the first time at which changes are reported.
const string UPDATE_TOPIC_ID
The topic id for 'update' EVENT in options
const string DELETE
Get notifications of delete operations.
const string DESTINATION
Destination for the output data in format 'destination_type://path[:port]'.
const string MONITOR_ID
ID to use for this monitor instead of a randomly generated one
string table_name
Value of table_name.
const string INSERT_TYPE_SCHEMA
The JSON Avro schema of the table in table_name
CreateTableMonitorRequest()
Constructs a CreateTableMonitorRequest object with default parameters.
IDictionary< string, string > info
Additional information.
const string DATASINK_NAME
Name of an existing data sink to send change data notifications to
const string JOIN_TABLE_NAMES
A comma-separated list of tables (optionally with aliases) to include in the join.
const string UPDATE
Get notifications of update operations.
const string PERIODIC
Report changes periodically at rate specified by REFRESH_PERIOD.
const string TTL
For insert_table/delete_table events, the ttl of the table.
const string KAFKA_TOPIC_NAME
Name of the Kafka topic to publish to if DESTINATION in options is specified and is a Kafka broker
IDictionary< string, string > options
Optional parameters.
string topic_id
The ZMQ topic ID to subscribe to for table events.
const string EVENT
Type of modification event on the target table to be monitored by this table monitor.
const string JOIN_EXPRESSIONS
Optional filter or join expressions to apply when combining the tables.
const string ON_CHANGE
Report changes as they occur.
const string JOIN_COLUMN_NAMES
A comma-separated list of columns or expressions to include from the joined tables.
const string UPDATE_TYPE_SCHEMA
The JSON Avro schema for 'update' events
const string INSERT_TOPIC_ID
The topic id for 'insert' EVENT in options
const string INCREASING_COLUMN
Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
const string MAX_CONSECUTIVE_FAILURES
Maximum number of consecutive failed notification attempts before suspending the stream.
const string DELETE_TOPIC_ID
The topic id for 'delete' EVENT in options
const string EXPRESSION
Filter expression to limit records for notification
string type_schema
JSON Avro schema of the table, for use in decoding published records.
string table_name
Name of the table to monitor, in [schema_name.
const string REFRESH_METHOD
Method controlling when the table monitor reports changes to the table_name.
const string REFRESH_PERIOD
When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which changes are reported.
const string INSERT
Get notifications of new record insertions.
const string FAILED_NOTIFICATIONS_TABLE_NAME
Name of a table to which failed stream notifications are written when the stream is suspended.
const string DELETE_TYPE_SCHEMA
The JSON Avro schema for 'delete' events