Property Collector Wait For Updates Ex

Calculate the set of updates for each existing filter in the session.

WaitForUpdatesEx may return only partial update calculations. See truncated for a more detailed explanation. WaitForUpdatesEx may also return null after a timeout, either as requested by maxWaitSeconds or due to PropertyCollector policy.

If an application uses waitForUpdatesEx it is strongly recommended that it not make concurrent calls to WaitForUpdates, CheckForUpdates, or WaitForUpdatesEx in the same session. Concurrent calls may cause suspended change calculations to be discarded.

Required privileges: System.View

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/WaitForUpdatesEx

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case PropertyCollector/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body

WaitForUpdatesExRequestType of type(s) application/json

Required

"WaitForUpdatesExRequestType Object"

string

version

Optional

The data version currently known to the client. The value must be either

the special initial data version (an empty string),
a data version returned from PropertyCollector.CheckForUpdates or PropertyCollector.WaitForUpdates
a non-truncated data version returned from PropertyCollector.WaitForUpdatesEx
a truncated data version returned from the last call to PropertyCollector.WaitForUpdatesEx with no intervening calls to PropertyCollector.WaitForUpdates or PropertyCollector.CheckForUpdates.

options

Optional

Additional options controlling the change calculation. If omitted, equivalent to an options argument with no fields set.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Changes since the passed in version or null if there are no changes.

This response body class contains all of the following: UpdateSet

{
    "0": "U",
    "1": "p",
    "2": "d",
    "3": "a",
    "4": "t",
    "5": "e",
    "6": "S",
    "7": "e",
    "8": "t",
    "9": " ",
    "10": "O",
    "11": "b",
    "12": "j",
    "13": "e",
    "14": "c",
    "15": "t"
}

500

InvalidCollectorVersion: if the data version does not meet the requirements above.

RequestCanceled: if CancelWaitForUpdates has been called or the session was closed or the PropertyCollector was destroyed at some point after the call was received

Returns InvalidCollectorVersion of type(s) application/json

This response body class contains all of the following: InlineInvalidCollectorVersion0

"InvalidCollectorVersion Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/WaitForUpdatesEx

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST

Property Collector Cancel Retrieve Properties Ex