Files
deb-python-pyvmomi/docs/vim/PerformanceManager/SampleInfo.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
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
2014-06-17 14:07:42 -04:00

22 lines
929 B
ReStructuredText

.. _int: https://docs.python.org/2/library/stdtypes.html
.. _datetime: https://docs.python.org/2/library/stdtypes.html
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
.. _UpdatePerfInterval: ../../vim/PerformanceManager.rst#updateHistoricalInterval
vim.PerformanceManager.SampleInfo
=================================
This data object type describes information contained in a sample collection, its timestamp, and sampling interval.
:extends: vmodl.DynamicData_
Attributes:
timestamp (`datetime`_):
The time at which the sample was collected.
interval (`int`_):
The interval in seconds for which performance statistics were collected. This can be the refreshRate of the managed object for which this statistics was collected or one of the intervals for historical statistics configured in the system. See `UpdatePerfInterval`_ for more information about the intervals configured in the system.