Managed Object - ViewManager

Property of: ServiceContent
See also: ContainerView, InventoryView, ListView, ManagedEntity, View
Since: VI API 2.5

Managed Object Description

This managed object provides access to managed objects which make accessing objects and providing updates more convenient for specific use cases.

For example, when rendering a list view of a container for which a client desires updates on only a subset of the objects, but also wants to know whenever objects are added or removed from the container, the following pattern could be used:

Create a ContainerView on the container.
Create a filter on the ContainerView's view property, retreiving only the list of managed objects but not thier properties.
Create a ListView from the container using the CreateListFromContainer method.
Create a filter on the ListView that returns the desired managed object's properties.
After the first update from this filter, modify the ListView to contain only the desired subset of objects.

This pattern is useful when displaying large lists of objects, only some of which may be visible to a user at any given time.

Properties

Name	Type	Description
viewList* P	ManagedObjectReference[] to a View[]	Views created by this ViewManager.

*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
CreateContainerView, CreateInventoryView, CreateListView, CreateListViewFromView

CreateContainerView

Create a ContainerView object for this session. This returns a session object with a property that contains all objects in the container.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewManager used to make the method call.
container P	ManagedObjectReference to a ManagedEntity	A Folder, Datacenter, ComputeResource or ResourcePool to filter objects by.
type*	xsd:string[]	An optional list of types to filter by. If empty, all types are included.
recursive	xsd:boolean	Whether to include objects from sub-containers, or just immediate children.

*Need not be set P Required privilege: System.View

Return Value

Type	Description
ManagedObjectReference to a ContainerView

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateContainerView" type="vim25:CreateContainerViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateContainerViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

CreateInventoryView

Create a new InventoryView managed object for this session.

See InventoryView

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewManager used to make the method call.

Return Value

Type	Description
ManagedObjectReference to a InventoryView

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateInventoryView" type="vim25:CreateInventoryViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateInventoryViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

CreateListView

Create a ListView object for this session. This returns a session object with a view property that contains the specified objects, and which may be modified on demand.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewManager used to make the method call.
obj* P	ManagedObjectReference[]	The initial list of objects in the view.

*Need not be set P Required privilege: System.View

Return Value

Type	Description
ManagedObjectReference to a ListView

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateListView" type="vim25:CreateListViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateListViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

CreateListViewFromView

Create a ListView object for this session from an existing view. This returns a session object with a view property that contains a copy of the set of objects in an existing view.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ViewManager used to make the method call.
view	ManagedObjectReference to a View	The view from whose object set to construct a ListView.

Return Value

Type	Description
ManagedObjectReference to a ListView

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateListViewFromView" type="vim25:CreateListViewFromViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateListViewFromViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>