SearchIndexQuerySpec

SearchIndexQuerySpec
SearchIndexQuerySpec

Since: vSphere API Release 9.1.0.0

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "properties": [
        "string"
    ],
    "resourceType": "string",
    "filters": [
        {
            "_typeName": "string",
            "predicates": [
                {
                    "_typeName": "string",
                    "propertyPath": "string",
                    "operator": "string",
                    "arrayOperator": "string",
                    "comparableValue": {
                        "_typeName": "string"
                    },
                    "comparableList": [
                        {
                            "_typeName": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "returnTotalCount": false,
    "limit": 0
}
array of string
properties
Optional

Specifies the SearchIndexQuerySpecResourceTypeEnum'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. runtime
  • dot-separated chain of property names to indicate a child property. e.g. runtime.powerState
  • the special identifier property @moRef which will extract the corresponding identifier ManagedObjectReference of the object

If the property is an array of DataObject you can additionally:

  • index a specific object by its "key" property example with string key config.network.pnic["key-vim.host.PhysicalNic-vmnic0"] example with int key config.hardware[10]
  • get a specific property of specific object e.g. config.network.pnic["key-vim.host.PhysicalNic-vmnic0"].mac
  • use array aggregation to obtain specific properties from all elements e.g. config.network.pnic[*].mac
  • use tupling to obtain tuples of properties example with aggregation config.network.pnic[*].(key,mac,ip) example with indexing config.network.pnic["key-vim.host.PhysicalNic-vmnic0"].(key,mac,ip)
string
resourceType
Required

Specifies the resource type (e.g., VirtualMachine, HostSystem or Datacenter) to be queried.

It should be one of the values in the SearchIndexQuerySpecResourceTypeEnum enum.

array of SearchIndexFilter
filters
Optional

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 SearchIndexQuerySpecResourceTypeEnum

boolean
returnTotalCount
Optional

Indicates whether the result will bring the number of discovered resources as well.

integer As int32 As int32
limit
Optional

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 SearchIndexResultSet will be set, allowing the client to continue the iteration using the SearchIndexIterationSpec and QueryNext methods.

Property Of