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.
- To use the paging model, create a query with the QueryService_Create method,
get successive results with the QueryService_GetNext method, then release
server-side resources with the QueryService_Delete method.
- To use the "virtual list" model, use the QueryService_Query method to get one
page of results at the offset of your choice. There is no need to free
server-side resources using this model, but successive queries may be
significantly less performant as a result.
- The privileges on an individual query will be based on the
queried entity type.
Methods
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
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidState | Thrown if the per session query limit has been reached. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown 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
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown 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
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown 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
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown 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
Return Value
Type
|
Description
|
xsd:int | count of objects which match this query. |
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown 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
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown 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
Return Value
Faults
Type
|
Description
|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
© 2021 VMware, Inc. All rights reserved.
Revision Nov-2021 Version 8.4.0