Data Object - ConverterEventFilterSpec

Parameter to
ConverterCreateCollectorForEvents, ConverterQueryEvents
Extends
DynamicData
See also
ConverterEventFilterSpecByTime, ConverterEventFilterSpecByUsername, ConverterEventType, ConverterServerJobJob
Since
Converter API 1.0

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
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.
job*ManagedObjectReference
to a ConverterServerJobJob

This property, if set, limits the set of collected events to those associated with the specified job. If the property is not set, events are collected regardless of their association with jobs.

Since Converter API 2.0
timeRange*ConverterEventFilterSpecByTime

The filter specification for retrieving tasks by time. If the property is not set, then events with any time stamp are collected.
type*ConverterEventType[]

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.
typeId*xsd:string[]

This property, if set, limits the set of collected events to those specified type identifiers. If the property is not set, events are collected regardless of their type identifiers.
userName*ConverterEventFilterSpecByUsername

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
None
*Need not be set