15f7be9a52
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
2.6 KiB
vmodl.query.PropertyCollector.WaitOptions
Options for WaitForUpdatesEx .
- extends
- since
- Attributes:
-
maxWaitSeconds (int, optional):
The number of seconds the PropertyCollector should wait before returning null. Returning updates may take longer if the actual calculation time exceeds maxWaitSeconds . Additionally PropertyCollector policy may cause it to return null sooner than maxWaitSeconds .An unset value causes WaitForUpdatesEx to wait as long as possible for updates. Policy may still cause the PropertyCollector to return null at some point.A value of 0 causes WaitForUpdatesEx to do one update calculation and return any results. This behavior is similar to CheckForUpdates .A positive value causes WaitForUpdatesEx to return null if no updates are available within the specified number of seconds. The choice of a positive value often depends on the client communication stack. For example it may be helpful to choose a duration shorter than a local HTTP request timeout. Typically it should be no shorter than a few minutes.A negative value is illegal.
maxObjectUpdates (int, optional):
The maximum number of ObjectUpdate entries that should be returned in a single result from WaitForUpdatesEx . See truncated An unset value indicates that there is no maximum. In this case PropertyCollector policy may still limit the number of objects that appear in an UpdateSet .A positive value causes WaitForUpdatesEx to suspend the update calculation when the total count of ObjectUpdate entries ready to return reaches the specified maximum. PropertyCollector policy may still limit the total count to something less than maxObjectUpdates .A value less than or equal to 0 is illegal.