# 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* P | ManagedObjectReference[] to a PropertyFilter[] |

*May not be present P 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.
token P | xsd:string | Since vSphere API 4.1

P Required privilege: token

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidProperty |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.
version* P | xsd:string | Since null

*Need not be set P Required privilege: version

Return Value

Type | Description
--- | ---
UpdateSet |

Faults

Type | Description
--- | ---
InvalidCollectorVersion |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.
token P | xsd:string | Since vSphere API 4.1

P Required privilege: token

Return Value

Type | Description
--- | ---
RetrieveResult |

Faults

Type | Description
--- | ---
InvalidProperty |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.
spec P | PropertyFilterSpec | Since null
partialUpdates P | xsd:boolean | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a PropertyFilter |

Faults

Type | Description
--- | ---
InvalidProperty |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a PropertyCollector |

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.
specSet P | PropertyFilterSpec[] | Since null

P Required privilege: specSet

Return Value

Type | Description
--- | ---
ObjectContent[] |

Faults

Type | Description
--- | ---
InvalidProperty |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.
specSet P | PropertyFilterSpec[] | Since vSphere API 4.1
options P | RetrieveOptions | Since vSphere API 4.1

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
RetrieveResult |

Faults

Type | Description
--- | ---
InvalidProperty |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.
version* P | xsd:string | Since null

*Need not be set P Required privilege: version

Return Value

Type | Description
--- | ---
UpdateSet |

Faults

Type | Description
--- | ---
InvalidCollectorVersion |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the PropertyCollector used to make the method call.
version* P | xsd:string | Since vSphere API 4.1
options* P | WaitOptions | Since vSphere API 4.1

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
UpdateSet |

Faults

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

Events

Type
None