Glossary:
com.pcbsys.nirvana.client.nConflationAttributes Class Reference
This class represents the conflation attributes that can be used when creating resources which allow conflation. More...
Public Member Functions | |
| int | getAction () |
| This can be either Drop or Merge. | |
| long | getInterval () |
| The time that the configured resource will conflate events. | |
| nConflationAttributes (int action, long interval) throws nIllegalArgumentException | |
| Creates a conflation attribute specifying the action as either drop or merge within the time interval specified. | |
| nConflationAttributes (long interval) | |
| Creates a conflation attributes object defaulting the action to merging of events within the conflation interval. | |
Protected Member Functions | |
| void | setAction (int action) throws nIllegalArgumentException |
| Sets the action for this conflation attribute. | |
Detailed Description
This class represents the conflation attributes that can be used when creating resources which allow conflation.Constructor & Destructor Documentation
| com.pcbsys.nirvana.client.nConflationAttributes.nConflationAttributes | ( | long | interval | ) |
Creates a conflation attributes object defaulting the action to merging of events within the conflation interval.
- Parameters:
-
interval time in milliseconds that events will be conflated
| com.pcbsys.nirvana.client.nConflationAttributes.nConflationAttributes | ( | int | action, | |
| long | interval | |||
| ) | throws nIllegalArgumentException |
Creates a conflation attribute specifying the action as either drop or merge within the time interval specified.
- Parameters:
-
action Set the action to either drop or merge events interval time in milliseconds that events will be conflated
- Exceptions:
-
nIllegalArgumentException
Member Function Documentation
| int com.pcbsys.nirvana.client.nConflationAttributes.getAction | ( | ) |
This can be either Drop or Merge.
- Returns:
- the configured action
| long com.pcbsys.nirvana.client.nConflationAttributes.getInterval | ( | ) |
The time that the configured resource will conflate events.
- Returns:
- time in milliseconds
| void com.pcbsys.nirvana.client.nConflationAttributes.setAction | ( | int | action | ) | throws nIllegalArgumentException [protected] |
Sets the action for this conflation attribute.
- Parameters:
-
action to use to set
- Exceptions:
-
nIllegalArgumentException
