Managed Object - PropertyCollector

Property of
ConverterHelperServiceContent, ConverterServiceContent, ServiceContent
Returned by
CreatePropertyCollector
See also
ObjectContent, PropertyFilter, PropertyFilterSpec, RetrieveOptions, RetrieveResult, UpdateSet, WaitOptions
Since
null


Managed Object Description

Properties

Name Type Description
filter* PManagedObjectReference[]
to a PropertyFilter[]


*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
CancelRetrievePropertiesEx, CancelWaitForUpdates, CheckForUpdates, ContinueRetrievePropertiesEx, CreateFilter, CreatePropertyCollector, DestroyPropertyCollector, RetrieveProperties, RetrievePropertiesEx, WaitForUpdates, WaitForUpdatesEx

CancelRetrievePropertiesEx

Required Privileges
System.Read
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.
token Pxsd:string

Since vSphere API 4.1
P Required privilege: token

Return Value

Type Description
None

Faults

Type Description
InvalidProperty
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CancelWaitForUpdates

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CheckForUpdates

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.
version* Pxsd:string

Since null
*Need not be set P Required privilege: version

Return Value

Type Description
UpdateSet

Faults

Type Description
InvalidCollectorVersion
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ContinueRetrievePropertiesEx

Required Privileges
System.Read
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.
token Pxsd:string

Since vSphere API 4.1
P Required privilege: token

Return Value

Type Description
RetrieveResult

Faults

Type Description
InvalidProperty
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CreateFilter

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.
spec PPropertyFilterSpec

Since null
partialUpdates Pxsd:boolean

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a PropertyFilter

Faults

Type Description
InvalidProperty
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CreatePropertyCollector

Required Privileges
System.View
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a PropertyCollector

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



DestroyPropertyCollector

Required Privileges
System.View
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RetrieveProperties

Deprecated.

Required Privileges
System.Anonymous

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.
specSet PPropertyFilterSpec[]

Since null
P Required privilege: specSet

Return Value

Type Description
ObjectContent[]

Faults

Type Description
InvalidProperty
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RetrievePropertiesEx

Required Privileges
System.Anonymous
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.
specSet PPropertyFilterSpec[]

Since vSphere API 4.1
options PRetrieveOptions

Since vSphere API 4.1
PRequired privilege - see tooltip for details

Return Value

Type Description
RetrieveResult

Faults

Type Description
InvalidProperty
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



WaitForUpdates

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.
version* Pxsd:string

Since null
*Need not be set P Required privilege: version

Return Value

Type Description
UpdateSet

Faults

Type Description
InvalidCollectorVersion
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



WaitForUpdatesEx

Required Privileges
System.View
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyCollector used to make the method call.
version* Pxsd:string

Since vSphere API 4.1
options* PWaitOptions

Since vSphere API 4.1
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
UpdateSet

Faults

Type Description
InvalidCollectorVersion
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None