RealtimeEvent¶
Definition¶
Extends¶
Extended By¶
None
Description¶
AMI Script Class to represent a Realtime Event
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| RealtimeEvent | getAction() | Character | Returns this action: S=Snapshot, I=Insert, U=Update, D=Delete, A=AddColumn, R=DropColumn, M=ModifyColumn |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| RealtimeEvent | getFeed() | String | Returns the name of the feed. |
| RealtimeEvent | getNext() | RealtimeEvent | Returns the next event. |
| RealtimeEvent | getValue(key) | String | Returns the value associated with this event given the key. |
| RealtimeEvent | getValues() | Map | Returns a map of the values associated with this event. |
| RealtimeEvent | isAdd() | Boolean | Returns true if the event is of type snapshot or insert; false otherwise. |
| RealtimeEvent | isAddColumn() | Boolean | Returns true if the event is adding a column to the schema; false otherwise. |
| RealtimeEvent | isDelete() | Boolean | Returns true if the event is of type delete; false otherwise. |
| RealtimeEvent | isDropColumn() | Boolean | Returns true if the event is dropping a column from the schema; false otherwise. |
| RealtimeEvent | isInsert() | Boolean | Returns true if the event is of type insert; false otherwise. |
| RealtimeEvent | isModifyColumn() | Boolean | Returns true if the event is modifying a column within the schema; false otherwise. |
| RealtimeEvent | isSnapshot() | Boolean | Returns true if the event is of type snapshot; false otherwise. |
| RealtimeEvent | isUpdate() | Boolean | Returns true if the event is of type update; false otherwise. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
getAction()¶
Character RealtimeEvent::getAction()
Description¶
Returns this action: S=Snapshot, I=Insert, U=Update, D=Delete, A=AddColumn, R=DropColumn, M=ModifyColumn
getFeed()¶
String RealtimeEvent::getFeed()
Description¶
Returns the name of the feed.
getNext()¶
RealtimeEvent RealtimeEvent::getNext()
Description¶
Returns the next event.
getValue(key)¶
String RealtimeEvent::getValue(Object key)
Description¶
Returns the value associated with this event given the key.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| key | Object | corresponds to the column name |
getValues()¶
Map RealtimeEvent::getValues()
Description¶
Returns a map of the values associated with this event.
isAdd()¶
Boolean RealtimeEvent::isAdd()
Description¶
Returns true if the event is of type snapshot or insert; false otherwise.
isAddColumn()¶
Boolean RealtimeEvent::isAddColumn()
Description¶
Returns true if the event is adding a column to the schema; false otherwise.
isDelete()¶
Boolean RealtimeEvent::isDelete()
Description¶
Returns true if the event is of type delete; false otherwise.
isDropColumn()¶
Boolean RealtimeEvent::isDropColumn()
Description¶
Returns true if the event is dropping a column from the schema; false otherwise.
isInsert()¶
Boolean RealtimeEvent::isInsert()
Description¶
Returns true if the event is of type insert; false otherwise.
isModifyColumn()¶
Boolean RealtimeEvent::isModifyColumn()
Description¶
Returns true if the event is modifying a column within the schema; false otherwise.
isSnapshot()¶
Boolean RealtimeEvent::isSnapshot()
Description¶
Returns true if the event is of type snapshot; false otherwise.
isUpdate()¶
Boolean RealtimeEvent::isUpdate()
Description¶
Returns true if the event is of type update; false otherwise.