Files
deb-python-pyvmomi/docs/vim/PerformanceManager/CompositeEntityMetric.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

24 lines
1.4 KiB
ReStructuredText

.. _metrics: ../../vim/PerformanceManager/EntityMetric.rst
.. _PerfSampleInfo: ../../vim/PerformanceManager/SampleInfo.rst
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
.. _PerfCompositeMetric: ../../vim/PerformanceManager/CompositeEntityMetric.rst
.. _vim.PerformanceManager.EntityMetricBase: ../../vim/PerformanceManager/EntityMetricBase.rst
vim.PerformanceManager.CompositeEntityMetric
============================================
`PerfCompositeMetric`_ includes an optional aggregated entity performance statistics and a list of composite entities performance statisticsThe aggregated entity statistics are optional because some entities, such as folders, do not have their own statistics
:extends: vmodl.DynamicData_
Attributes:
entity (`vim.PerformanceManager.EntityMetricBase`_, optional):
The aggregated entity performance metrics. If it exists, the `PerfSampleInfo`_ list of the aggregate entity is a complete list of `PerfSampleInfo`_ that could be contained in `PerfSampleInfo`_ lists of child entities.
childEntity (`vim.PerformanceManager.EntityMetricBase`_, optional):
A list of `metrics`_ of performance providers that comprise the aggregated entity. For example, Host is an aggregated entity for virtual machines and virtual machine Folders. ResourcePools are aggregate entities for virtual machines. Host, Folder, and Cluster are aggregate entities for hosts in the cluster or folder.