15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
123 lines
3.5 KiB
ReStructuredText
123 lines
3.5 KiB
ReStructuredText
.. _int: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _object: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vim.Task: ../vim/Task.rst
|
|
|
|
.. _ReadNextTasks: ../vim/TaskHistoryCollector.rst#readNext
|
|
|
|
.. _ReadNextEvents: ../vim/event/EventHistoryCollector.rst#readNext
|
|
|
|
.. _ReadPreviousTasks: ../vim/TaskHistoryCollector.rst#readPrev
|
|
|
|
.. _ReadPreviousEvents: ../vim/event/EventHistoryCollector.rst#readPrev
|
|
|
|
.. _vmodl.fault.InvalidArgument: ../vmodl/fault/InvalidArgument.rst
|
|
|
|
|
|
vim.HistoryCollector
|
|
====================
|
|
This managed object type enables clients to retrieve historical data and receive updates when the server appends new data to a collection. This is a base type for item-specific types related to event or task history. Historical data is inherently append-only, although a server administrator may periodically purge old data.Typically, a client creates a history collector by using a filter on a potentially large set, such as all the events in a datacenter. The collector provides access to the items that match the filter, which could also be a relatively large set.The items in a collector are always ordered by date and time of creation. Item properties normally include this time stamp.The client may set the "viewable latest page" for the collector, which is the contiguous subset of the items that are of immediate interest. These items are available as the "latestPage" property, which the client may retrieve and monitor by using the `PropertyCollector`_ managed object.Clients can change the page size of the "latestPage" by using `setLatestPageSize()`_ .The client may use the following features of the history collector.
|
|
* `RewindCollector`_
|
|
* - Moves the "scrollable view" to the oldest item (the default setting).
|
|
* readNext - Retrieves all the items in the collector, from the oldest item to the newest item. Retrieves either
|
|
* `tasks`_
|
|
* or
|
|
* `events`_
|
|
* depending on the operation.
|
|
* readPrev - Retrieves all items (excluding the "viewable latest page") in the collector, from the newest item to the oldest item. Retrieves either
|
|
* `tasks`_
|
|
* or
|
|
* `events`_
|
|
* depending on the operation.
|
|
* `ResetCollector`_
|
|
* - Moves the "scrollable view" to the item immediately preceding the "viewable latest page".
|
|
*
|
|
|
|
|
|
|
|
|
|
Attributes
|
|
----------
|
|
filter (`object`_):
|
|
The filter used to create this collector.The type of the returned filter is determined by the managed object for which the collector is created.
|
|
|
|
|
|
Methods
|
|
-------
|
|
|
|
|
|
SetCollectorPageSize(maxCount):
|
|
Sets the "viewable latest page" size to contain at most the number of items specified by the maxCount parameter).
|
|
|
|
|
|
Privilege:
|
|
|
|
|
|
|
|
Args:
|
|
maxCount (`int`_):
|
|
The maximum number of items in the page.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
Raises:
|
|
|
|
`vmodl.fault.InvalidArgument`_:
|
|
if maxCount is out of range.
|
|
|
|
|
|
RewindCollector():
|
|
Moves the "scrollable view" to the oldest item. If you use `ReadNextTasks`_ or `ReadNextEvents`_ , all items are retrieved from the oldest item to the newest item. This is the default setting when the collector is created.
|
|
|
|
|
|
Privilege:
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
|
|
ResetCollector():
|
|
Moves the "scrollable view" to the item immediately preceding the "viewable latest page". If you use "readPrev", `ReadPreviousTasks`_ or `ReadPreviousEvents`_ , all items are retrieved from the newest item to the oldest item.
|
|
|
|
|
|
Privilege:
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
|
|
DestroyCollector():
|
|
Destroys this collector.
|
|
|
|
|
|
Privilege:
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
|