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

1.5 KiB

vmodl.query.PropertyCollector.RetrieveOptions

Options for RetrievePropertiesEx .

extends

vmodl.DynamicData

since

vSphere API 4.1

Attributes:

maxObjects (int, optional):

The maximum number of ObjectContent data objects that should be returned in a single result from RetrievePropertiesEx .An unset value indicates that there is no maximum. In this case PropertyCollector policy may still limit the number of objects. Any remaining objects may be retrieved with ContinueRetrievePropertiesEx .A positive value causes RetrievePropertiesEx to suspend the retrieval when the count of objects reaches the specified maximum. PropertyCollector policy may still limit the count to something less than maxObjects . Any remaining objects may be retrieved with ContinueRetrievePropertiesEx .A value less than or equal to 0 is illegal.