Data Object - ConverterTaskFilterSpec

Parameter to
ConverterCreateCollectorForTasks
Extends
DynamicData
See also
ConverterServerJobJob, ConverterTask, ConverterTaskFilterSpecByTime, ConverterTaskFilterSpecByUsername, ConverterTaskInfoState
Since
Converter API 1.0

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

This property, if provided, limits the set of collected tasks to those specified identifiers. If not provided, tasks are collected regardless of their identifiers.
job*ManagedObjectReference
to a ConverterServerJobJob

This property, if provided, limits the set of collected tasks to those associated with the specified job. If not provided, tasks are collected regardless of their association with any job.

Since Converter API 2.0
parentTask*ManagedObjectReference[]
to a ConverterTask[]

This property, if provided, limits the set of collected tasks to those associated with the specified parent task. If not provided, tasks are collected regardless of their association with any parent tasks.

Since Converter API 2.0
rootTask*ManagedObjectReference[]
to a ConverterTask[]

This property, if provided, limits the set of collected tasks to those associated with the specified root task. If not provided, tasks are collected regardless of their association with any root tasks.

Since Converter API 2.0
rootTaskOnly*xsd:boolean

This property, if provided, limits the set of collected tasks to those that are root tasks.

Since Converter API 2.0
state*ConverterTaskInfoState[]

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.
timeRange*ConverterTaskFilterSpecByTime

The filter specification for retrieving tasks by time. If not provided, then the tasks with any time stamp are collected.
userName*ConverterTaskFilterSpecByUsername

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