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

31 lines
968 B
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _SystemError: ../../../vmodl/fault/SystemError.rst
.. _SecurityError: ../../../vmodl/fault/SecurityError.rst
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
.. _vmodl.LocalizedMethodFault: ../../../vmodl/LocalizedMethodFault.rst
vmodl.query.PropertyCollector.MissingProperty
=============================================
Used for reporting properties for which values could not be retrieved.
:extends: vmodl.DynamicData_
Attributes:
path (`str`_):
Property for which a value could not be retrieved
fault (`vmodl.LocalizedMethodFault`_):
Fault describing the failure to retrieve the property value.The possible faults for missing properties are:
*
* `SystemError`_
* if there was some unknown problem reading the value
*
* `SecurityError`_
* if the logged in session did not have permission to read the value
*