Data Object - TaskFilterSpec

Parameter to
CreateCollectorForTasks
Extends
DynamicData
See also
Alarm, ScheduledTask, TaskFilterSpecByEntity, TaskFilterSpecByTime, TaskFilterSpecByUsername, TaskInfoState

Data Object Description

This data object type defines the specification for the task filter used to query tasks in the history collector database. The client creates a task history collector with a filter specification, then retrieves the tasks from the task history collector.

Properties

Name Type Description
alarm*ManagedObjectReference
to a Alarm
This property, if provided, limits the set of collected tasks to those associated with the specified alarm. If not provided, tasks are collected regardless of their association with alarms.
entity*TaskFilterSpecByEntity The filter specification for retrieving tasks by managed entity. If not provided, then the tasks attached to all managed entities are collected.
scheduledTask*ManagedObjectReference
to a ScheduledTask
This property, if provided, limits the set of collected tasks to those associated with the specified scheduled task. If not provided, tasks are collected regardless of their association with any scheduled task.
state*TaskInfoState[] This property, if provided, limits the set of collected tasks by their states. Task states are enumerated in State. If not provided, tasks are collected regardless of their state.
time*TaskFilterSpecByTime The filter specification for retrieving tasks by time. If not provided, then the tasks with any time stamp are collected.
userName*TaskFilterSpecByUsername The filter specification for retrieving tasks by user name. If not provided, then the tasks belonging to any user are collected.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition