Managed Object - PropertyFilter(vmodl.query.PropertyCollector.Filter)

Property of
PropertyCollector, PropertyFilterUpdate
Returned by
CreateFilter
See also
PropertyFilterSpec
Since
vmodl.query.version.version1


Managed Object Description

The PropertyFilter managed object type defines a filter that controls the properties for which a PropertyCollector detects incremental changes. Filters are subordinate objects; they are part of the PropertyCollector and do not have independent lifetimes. A Filter is automatically destroyed when the session on which it was created is closed or the PropertyCollector on which it was created is destroyed.

Properties

Name Type Description
partialUpdatesxsd:boolean

Flag to indicate if a change to a nested property reports only the nested change or the entire specified property value. If the value is true, a change reports only the nested property. If the value is false, a change reports the enclosing property named in the filter.
specPropertyFilterSpec

Specifications for this filter.

Methods

Methods defined in this Managed Object
DestroyPropertyFilter

DestroyPropertyFilter(destroy)

Destroys this filter.

This operation can be called explicitly, or it can take place implicitly when the session that created the filter is closed.

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PropertyFilter 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

Show WSDL type definition