Data Object - SearchIndexQuerySpec(vim.SearchIndex.QuerySpec)

Parameter to: Query
Extends: DynamicData
See also: SearchIndexFilter
Since: vSphere API Release 9.1.0.0

Data Object Description

Properties

Name	Type	Description
filters*	SearchIndexFilter[]	Define query criteria. Only properties matching all provided filters will be returned by the query. Provides abilities to specify comparison predicates on the properties of the resources to search for or even on properties of their related resources as well as logical compositions of such predicates. If unset, the query matches all resource instances of the given ResourceType
limit*	xsd:int	Page size. If not set, it will return all results that matched the query. Otherwise, it will return the first page of results, and the marker in the ResultSet will be set, allowing the client to continue the iteration using the IterationSpec and QueryNext methods.
properties*	xsd:string[]	Specifies the ResourceType's properties to be included in the result set for the query. There should be no duplicated properties. Each property in the list can be: top level property name e.g. {@code runtime} dot-separated chain of property names to indicate a child property. e.g. {@code runtime.powerState} the special identifier property @moRef which will extract the corresponding identifier {@code ManagedObjectReference} of the object If the property is an array of {@code DataObject} you can additionally: index a specific object by its "key" property example with string key {@code config.network.pnic["key-vim.host.PhysicalNic-vmnic0"]} example with int key {@code config.hardware[10]} get a specific property of specific object e.g. {@code config.network.pnic["key-vim.host.PhysicalNic-vmnic0"].mac} use array aggregation to obtain specific properties from all elements e.g. {@code config.network.pnic[].mac} use tupling to obtain tuples of properties example with aggregation {@code config.network.pnic[].(key,mac,ip)} example with indexing {@code config.network.pnic["key-vim.host.PhysicalNic-vmnic0"].(key,mac,ip)}
resourceType	xsd:string	Specifies the resource type (e.g., VirtualMachine, HostSystem or Datacenter) to be queried. It should be one of the values in the ResourceType enum.
returnTotalCount*	xsd:boolean	Indicates whether the result will bring the number of discovered resources as well.
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="SearchIndexQuerySpec">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="properties" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="resourceType" type="xsd:string"/>
                     <element name="filters" type="vim25:SearchIndexFilter" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="returnTotalCount" type="xsd:boolean" minOccurs="0"/>
                     <element name="limit" type="xsd:int" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSphere Web Services API

Data Object - SearchIndexQuerySpec(vim.SearchIndex.QuerySpec)

Data Object Description