Data Object - SearchIndexResultSet(vim.SearchIndex.ResultSet)

Returned by: Query, QueryNext
Extends: DynamicData
See also: SearchIndexResourceItem
Since: vSphere API Release 9.1.0.0

Data Object Description

Contains the data returned in response to a particular query instance.

Properties

Name	Type	Description
items*	SearchIndexResourceItem[]	The list of result items. Each item corresponds to a particular resource that matched the conditions in the specified QuerySpec instance and containing the property data retrieved for that resource.
marker*	xsd:string	Used for continuation of result paging. If paging used this one will be filled with the place where the next page should continue from. It should be passed to IterationSpec#marker, so the paging can be continued.
properties*	xsd:string[]	The names of the resource model properties returned for each resource item in the result set. The position (index) of each model property in this list corresponds to the position of the model property value in each resource item's values list. In other words, the name of each model property in the ResourceItem#propertyValues list is given by the string with the same index (position) in this list.
totalCount*	xsd:int	The total number of resources that matched the query, regardless of the actual number that is returned in items. This value is set only if it has been explicitly requested in the query, i.e. if the QuerySpec#returnTotalCount flag has been set to {@code true}. The {@code totalCount} can change as new records are added or removed between requests. This means the count is recalculated on each subsequent request to reflect the most up-to-date results. The usecase of this property is for requesting only the items matching certain query without any further properties for the resource model. For example: find the number of all vms that are powered on.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="SearchIndexResultSet">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="properties" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="items" type="vim25:SearchIndexResourceItem" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="totalCount" type="xsd:int" minOccurs="0"/>
                     <element name="marker" type="xsd:string" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSphere Web Services API

Data Object - SearchIndexResultSet(vim.SearchIndex.ResultSet)

Data Object Description