Service - QueryService

Class
VMware.Hv.QueryService
See also
QueryDefinition, QueryId, QueryResults
Since
Horizon View 6.0


Service Description

The Query Service provides a uniform simple query interface to allow bulk enumeration of entities, using either a paging or "virtual list" model.

Methods

Methods defined in this Service
QueryService_Create, QueryService_Delete, QueryService_DeleteAll, QueryService_DeleteByIds, QueryService_GetCount, QueryService_GetNext, QueryService_Query

QueryService_Create

Create a cursor for iterating though query results efficiently, and return the first set of results. Creates server-side state which should be explicitly deleted via QueryService_Delete. Server side state will also time out eventually.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the QueryService used to make the method call.
definitionQueryDefinition

query definition.

Return Value

Type Description
QueryResultsfirst page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidStateThrown if the per session query limit has been reached.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



QueryService_Delete

Delete the server-side state associated with this cursor. To be used after QueryService_Create.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the QueryService used to make the method call.
idQueryId

from a result set.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



QueryService_DeleteAll

Delete the server-side state associated with any outstanding cursors. To be used after QueryService_Create.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the QueryService used to make the method call.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



QueryService_DeleteByIds

Deletes the server-side states associated with given cursors. To be used after multiple QueryService_Create invocations.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the QueryService used to make the method call.
idsQueryId[]

Array of Query Ids to delete.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



QueryService_GetCount

Get only a count of results. Resources are released automatically. This should not be used if any results are needed to be read.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the QueryService used to make the method call.
definitionQueryDefinition

query definition.

Return Value

Type Description
xsd:intcount of objects which match this query.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



QueryService_GetNext

Get the next set of results. To be used after QueryService_Create.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the QueryService used to make the method call.
idQueryId

from the previous result set.

Return Value

Type Description
QueryResultsnext page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



QueryService_Query

Perform a "virtual list"-style query for a set of results. Inefficient for iterating through many items. Resources are released automatically.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the QueryService used to make the method call.
definitionQueryDefinition

query definition.

Return Value

Type Description
QueryResultsone page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition