Managed Object -
TaskHistoryCollector(vim.TaskHistoryCollector)
- Returned by
-
CreateCollectorForTasks
- Extends
-
HistoryCollector
- See also
-
TaskInfo
Managed Object Description
TaskHistoryCollector provides a mechanism for
retrieving historical data and updates when the server appends new
tasks.
Properties
Name
|
Type
|
Description
|
latestPage | TaskInfo[] |
The items in the 'viewable latest page'. As new tasks that match the
collector's TaskFilterSpec are created, they are added to this
page, and the oldest tasks are removed from the collector to keep the
size of the page to that allowed by
SetCollectorPageSize.
The "oldest task" is the one with the oldest creation time. The
tasks in the returned page are unordered.
|
Properties inherited from HistoryCollector |
filter |
Methods
ReadNextTasks(readNext)
Reads the 'scrollable view' from the current position. The scrollable
position is moved to the next newer page after the read. No item is
returned when the end of the collector is reached.
- Required Privileges
- None
Parameters
Return Value
Faults
Type
|
Description
|
InvalidArgument | Thrown if maxCount is out of range. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
ReadPreviousTasks(readPrev)
Reads the 'scrollable view' from the current position. The scrollable
position is then moved to the next older page after the read. No item is
returned when the head of the collector is reached.
- Required Privileges
- None
Parameters
Return Value
Faults
Type
|
Description
|
InvalidArgument | Thrown if maxCount is out of range. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition