Data Object - WaitOptions

Parameter to
vSphere API 4.1

Data Object Description

Options for WaitForUpdatesEx.


Name Type Description

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.


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.

Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition