Scripting Object - VcListView

Scripting-object corresponding to
ListView
Returned by
createListView, createListViewFromView

Scripting Object Description

The {@link ListView} managed object provides access to updates on a specific set of objects. You can use a {@link ListView} with a {@link vmodl.query.PropertyCollector} method to retrieve data or receive notification of changes. For information about using views with the {@link vmodl.query.PropertyCollector}, see the description of {@link ViewManager}.

When you invoke the {@link ViewManager#createListView} method, you specify a list of objects. The {@link ManagedObjectView#view} list always represents the current configuration of the virtual environment and reflects any subsequent changes that occur.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
viewVcManagedObject []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, destroyView, modifyListView, resetListView, resetListViewFromView

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

destroyView

Destroy this view. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

resetListView

Replaces the list with an entirely new set of objects. If the entire set is changing, this is less data to send than a delta.

May partially succeed if some objects could not be resolved. The operation will still succeed for all objects which could be resolved, and the list of those which failed is as the result. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcManagedObject []


Return Value

Type Description
VcManagedObject []

modifyListView

Modify the list by giving a delta of entities to add and entities to remove.

May partially succeed if some objects could not be resolved. The operation will still succeed for all objects which could be resolved, and the list of those which failed is returned as the result. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcManagedObject []

arg1VcManagedObject []


Return Value

Type Description
VcManagedObject []

resetListViewFromView

Replaces the list with the set of objects in a given view. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcView


Return Value

Type Description
None