SearchIndexResultSet

SearchIndexResultSet
SearchIndexResultSet

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

Since: vSphere API Release 9.1.0.0

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "properties": [
        "string"
    ],
    "items": [
        {
            "_typeName": "string",
            "propertyValues": [
                {
                    "_typeName": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ]
        }
    ],
    "totalCount": 0,
    "marker": "string"
}
array of string
properties
Optional

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 SearchIndexResourceItem.propertyValues list is given by the string with the same index (position) in this list.

array of SearchIndexResourceItem
items
Optional

The list of result items.

Each item corresponds to a particular resource that matched the conditions in the specified SearchIndexQuerySpec instance and containing the property data retrieved for that resource.

integer As int32 As int32
totalCount
Optional

The total number of resources that matched the query, regardless of the actual number that is returned in SearchIndexResultSet.items.

This value is set only if it has been explicitly requested in the query, i.e. if the SearchIndexQuerySpec.returnTotalCount flag has been set to true. The 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.

string
marker
Optional

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 SearchIndexIterationSpec.marker, so the paging can be continued.

Property Of
Returned By