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
3.0 KiB
vmodl.query.PropertyCollector.UpdateSet
A set of updates that represent the changes since a prior call to CheckForUpdates , WaitForUpdates , or WaitForUpdatesEx .
- extends
- Attributes:
-
version (str):
New data version to pass in the next call to CheckForUpdates , WaitForUpdates , or WaitForUpdatesEx . These versions, although they are opaque, are strongly ordered in the sense that passing a version to WaitForUpdates , CheckForUpdates or WaitForUpdatesEx requests updates that reflect changes in the objects selected by the Filter that happened after the specified version.
filterSet (vmodl.query.PropertyCollector.FilterUpdate, optional):
Set of managed object updates detected by specific filters. Updates are reported in sets. Each set is associated with a reference to a filter that detected the updates in the set.
truncated (bool, optional):
If true, this UpdateSet contains results from a suspended change calculation, which places restrictions on the use of version.The PropertyCollector may suspend a calculation due to server policy or if the total number of ObjectUpdate entries summed across every PropertyFilterUpdate reached the maximum specified in maxObjectUpdates . The client can pass the "truncated data version" to WaitForUpdatesEx to resume the update calculation, which will start on the filter where it left off. A truncated data version cannot be used more than once and may not be passed to CheckForUpdates or WaitForUpdates . truncated will never be true in an UpdateSet returned from CheckForUpdates or WaitForUpdates .If false, this UpdateSet contains a complete change calculation or the last part of a series of suspended change calculations. The version may be passed to CheckForUpdates , WaitForUpdates , or WaitForUpdatesEx more than once. Re-using a version allows a client to recover a change sequence after a transient failure on a previous call.