Files
deb-python-pyvmomi/docs/vmodl/query/PropertyCollector/Change.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

29 lines
1.2 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _object: https://docs.python.org/2/library/stdtypes.html
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
.. _vmodl.query.PropertyCollector.Change.Op: ../../../vmodl/query/PropertyCollector/Change/Op.rst
vmodl.query.PropertyCollector.Change
====================================
Describes a change to a property.
:extends: vmodl.DynamicData_
Attributes:
name (`str`_):
Property or nested property to which the change applies. Nested properties are specified by paths; for example,
* foo.bar
* foo.arProp["key val"]
* foo.arProp["key val"].baz
*
op (`vmodl.query.PropertyCollector.Change.Op`_):
Change operation for the property. Valid values are:addThe property is a collection and the change inserts an element into the collection.removeThe property is a collection and the change deletes an element from the collection.assignThe change is a new value for the property.indirectRemoveThe property was removed because a containing property was removed or unset
val (`object`_, optional):
New value for the property when "op" is either "add" or "assign".