com.vmware.vim25.mo
Class PropertyCollector

java.lang.Object
  com.vmware.vim25.mo.ManagedObject
      com.vmware.vim25.mo.PropertyCollector

public class PropertyCollector
extends ManagedObject

The managed object class corresponding to the one defined in VI SDK API reference.

Author:

Steve JIN (sjin@vmware.com)

Constructor Summary

PropertyCollector(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

void	cancelRetrievePropertiesEx(String token)
void	cancelWaitForUpdates()
UpdateSet	checkForUpdates(String version)
RetrieveResult	continueRetrievePropertiesEx(String token)
PropertyFilter	createFilter(PropertyFilterSpec spec, boolean partialUpdates)
PropertyCollector	createPropertyCollector()
void	destroyPropertyCollector()
PropertyFilter[]	getFilters()
ObjectContent[]	retrieveProperties(PropertyFilterSpec[] specSet) Deprecated. as of SDK4.1
RetrieveResult	retrievePropertiesEx(PropertyFilterSpec[] specSet, RetrieveOptions options)
UpdateSet	waitForUpdates(String version) Deprecated. as of SDK4.1
UpdateSet	waitForUpdatesEx(String version, WaitOptions options)

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyCollector

public PropertyCollector(ServerConnection serverConnection,
                         ManagedObjectReference mor)

Method Detail

getFilters

public PropertyFilter[] getFilters()

cancelRetrievePropertiesEx

public void cancelRetrievePropertiesEx(String token)
                                throws InvalidProperty,
                                       RuntimeFault,
                                       RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK4.1

cancelWaitForUpdates

public void cancelWaitForUpdates()
                          throws RuntimeFault,
                                 RemoteException

Throws:

RuntimeFault

RemoteException

continueRetrievePropertiesEx

public RetrieveResult continueRetrievePropertiesEx(String token)
                                            throws InvalidProperty,
                                                   RuntimeFault,
                                                   RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK4.1

checkForUpdates

public UpdateSet checkForUpdates(String version)
                          throws InvalidCollectorVersion,
                                 RuntimeFault,
                                 RemoteException

Throws:

InvalidCollectorVersion

RuntimeFault

RemoteException

createFilter

public PropertyFilter createFilter(PropertyFilterSpec spec,
                                   boolean partialUpdates)
                            throws InvalidProperty,
                                   RuntimeFault,
                                   RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

createPropertyCollector

public PropertyCollector createPropertyCollector()
                                          throws RuntimeFault,
                                                 RemoteException

Throws:

RuntimeFault

RemoteException

Since:

SDK4.1

destroyPropertyCollector

public void destroyPropertyCollector()
                              throws RuntimeFault,
                                     RemoteException

Throws:

RuntimeFault

RemoteException

Since:

SDK4.1

retrieveProperties

public ObjectContent[] retrieveProperties(PropertyFilterSpec[] specSet)
                                   throws InvalidProperty,
                                          RuntimeFault,
                                          RemoteException

Deprecated. as of SDK4.1

Throws:

InvalidProperty

RuntimeFault

RemoteException

retrievePropertiesEx

public RetrieveResult retrievePropertiesEx(PropertyFilterSpec[] specSet,
                                           RetrieveOptions options)
                                    throws InvalidProperty,
                                           RuntimeFault,
                                           RemoteException

Throws:

InvalidProperty

RuntimeFault

RemoteException

Since:

SDK4.1

waitForUpdates

public UpdateSet waitForUpdates(String version)
                         throws InvalidCollectorVersion,
                                RuntimeFault,
                                RemoteException

Deprecated. as of SDK4.1

Throws:

InvalidCollectorVersion

RuntimeFault

RemoteException

waitForUpdatesEx

public UpdateSet waitForUpdatesEx(String version,
                                  WaitOptions options)
                           throws InvalidCollectorVersion,
                                  RuntimeFault,
                                  RemoteException

Throws:

InvalidCollectorVersion

RuntimeFault

RemoteException

Since:

SDK4.1