Data Object - EventFilterSpec

Parameter to
CreateCollectorForEvents, QueryEvents
Extends
DynamicData
See also
Alarm, EventFilterSpecByEntity, EventFilterSpecByTime, EventFilterSpecByUsername, ScheduledTask

Data Object Description

Event filter used to query events in the history collector database. The client creates an event history collector with a filter specification, then retrieves the events from the event history collector.

Properties

Name Type Description
alarm*ManagedObjectReference
to a Alarm
This property, if set, limits the set of collected events to those associated with the specified alarm. If the property is not set, events are collected regardless of their association with alarms.
category*xsd:string[] This property, if set, limits the set of collected events to those associated with the specified category. If the property is not set, events are collected regardless of their association with any category.
disableFullMessage*xsd:boolean Flag to specify whether or not to prepare the full formatted message for each event. If the property is not set, the collected events do not include the full formatted message.
entity*EventFilterSpecByEntity The filter specification for retrieving events by managed entity. If the property is not set, then events attached to all managed entities are collected.
eventChainId*xsd:int The filter specification for retrieving events by chain ID. If the property is not set, events with any chain ID are collected.
scheduledTask*ManagedObjectReference
to a ScheduledTask
This property, if set, limits the set of collected events to those associated with the specified scheduled task. If the property is not set, events are collected regardless of their association with any scheduled task.
time*EventFilterSpecByTime The filter specification for retrieving tasks by time. If the property is not set, then events with any time stamp are collected.
type*xsd:string[] This property, if set, limits the set of collected events to those specified types. If the property is not set, events are collected regardless of their types.
userName*EventFilterSpecByUsername The filter specification for retrieving events by username. If the property is not set, then events belonging to any user are collected.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition