Service - GlobalSessionQueryService
Java Class
com.omnissa.vdi.vlsi.binding.vdi.users.GlobalSessionQueryService
See also
DesktopId, GlobalEntitlementId, GlobalSessionPodSessionCounter, GlobalSessionQueryServiceCountSpec, GlobalSessionQueryServiceQuerySpec, PodId, QueryId, QueryResults, UserOrGroupId
Since
Horizon View 6.0
Service Description¶
Service that supports a pre-defined set of global session queries.
Methods
Methods defined in this Service: GlobalSessionQueryService_Delete, GlobalSessionQueryService_GetCount, GlobalSessionQueryService_GetCountWithSpec, GlobalSessionQueryService_GetNext, GlobalSessionQueryService_QueryByBrokeringPod, GlobalSessionQueryService_QueryByDesktop, GlobalSessionQueryService_QueryByPod, GlobalSessionQueryService_QueryByUser, GlobalSessionQueryService_QueryWithSpec
Deletes the server-side state associated with query. To be used after queryByuser, queryByPod, queryByBrokeringPod, queryByDesktop and queryBySpec.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| id | QueryId | from a result set. |
Return Value
| Type | Description |
|---|---|
| None |
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
Deprecated.use #getCountWithSpec(CountSpec) instead
Returns global session count for combination of parameters. All criteria are optional, though at least one must be specified.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_SESSIONS_VIEW | Global session read is required to return a count of query results. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| user | UserOrGroupId | unique identifier for user or group 1 |
| pod | PodId | unique identifier for pod 1 |
| brokeringPod | PodId | unique identifier for brokering pod 1 |
| globalEntitlement | GlobalEntitlementId | unique identifier for global entitlement 1 |
Return Value
| Type | Description |
|---|---|
| GlobalSessionPodSessionCounter[] | PodSessionCounter with session counts broken down by pods |
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
Returns global session count for combination of parameters. All criteria are optional, though at least one must be specified.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_SESSIONS_VIEW | Global session read is required to return a count of query results. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| countSpec | GlobalSessionQueryServiceCountSpec |
Return Value
| Type | Description |
|---|---|
| GlobalSessionPodSessionCounter[] | PodSessionCounter with session counts broken down by pods |
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. |
| InvalidRequest | Thrown if both globalEntitlement and globalApplicationEntitlement are set to non null values. If any two or more fields of user, pod, brokeringPod, desktop, clientName are set to non null values. |
| 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
Gets next page from query. To be used with queryByUser, queryByPod, queryByBrokeringPod, queryByDesktop and queryBySpec.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| id | QueryId | from a result set. |
Return Value
| Type | Description |
|---|---|
| QueryResults | next page of results. |
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
Deprecated.use #queryWithSpec(QuerySpec) instead
Queries global sessions by brokering pod. 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. Server side state will also time out eventually.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_SESSIONS_VIEW | Global session read is required to query by brokering pod. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| pod | PodId | unique identifier for brokering pod |
| globalEntitlement | GlobalEntitlementId | unique identifier for global entitlement 1 |
| sortBy | xsd:string | Member name to sort results by. 1 |
| sortDescending | xsd:boolean | Sort order: false (ascending) by default. 1 |
| maxPageSize | xsd:int | Maximum page size to return (the server may use a smaller size). 1 |
Return Value
| Type | Description |
|---|---|
| QueryResults | one page of results. |
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
Deprecated.use #queryWithSpec(QuerySpec) instead
Queries global sessions by desktop and GE for local pod. 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. Server side state will also time out eventually.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_SESSIONS_VIEW | Global session read is required to query by desktop. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| desktop | DesktopId | unique identifier for desktop |
| globalEntitlement | GlobalEntitlementId | unique identifier for global entitlement 1 |
| sortBy | xsd:string | Member name to sort results by. 1 |
| sortDescending | xsd:boolean | Sort order: false (ascending) by default. 1 |
| maxPageSize | xsd:int | Maximum page size to return (the server may use a smaller size). 1 |
Return Value
| Type | Description |
|---|---|
| QueryResults | one page of results. |
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
Deprecated.use #queryWithSpec(QuerySpec) instead
Queries sessions by resource/destination pod. 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. Server side state will also time out eventually.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_SESSIONS_VIEW | Global session read is required to query by resource/destination pod. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| pod | PodId | unique identifier for pod |
| globalEntitlement | GlobalEntitlementId | unique identifier for global entitlement 1 |
| sortBy | xsd:string | Member name to sort results by. 1 |
| sortDescending | xsd:boolean | Sort order: false (ascending) by default. 1 |
| maxPageSize | xsd:int | Maximum page size to return (the server may use a smaller size). 1 |
Return Value
| Type | Description |
|---|---|
| QueryResults | one page of results. |
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
Deprecated.use #queryWithSpec(QuerySpec) instead
Queries global sessions by user. 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. Server side state will also time out eventually.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_SESSIONS_VIEW | Global session read is required to query by user. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| user | UserOrGroupId | unique identifier for user |
| globalEntitlement | GlobalEntitlementId | unique identifier for global entitlement 1 |
| sortBy | xsd:string | Member name to sort results by. 1 |
| sortDescending | xsd:boolean | Sort order: false (ascending) by default. 1 |
| maxPageSize | xsd:int | Maximum page size to return (the server may use a smaller size). 1 |
Return Value
| Type | Description |
|---|---|
| QueryResults | one page of results. |
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
Queries global sessions based on QuerySpec . Creates a cursor for iterating though query results efficiently, and return the first set of results. Creates server-side state which should be explicitly deleted. Server side state will also time out eventually.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_SESSIONS_VIEW | Global session read is required to query by user. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the GlobalSessionQueryService used to make the method call. |
| querySpec | GlobalSessionQueryServiceQuerySpec | querySpec to filter the results |
Return Value
| Type | Description |
|---|---|
| QueryResults | one page of results. |
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. |
| InvalidRequest | Thrown if both globalEntitlement and globalApplicationEntitlement are set to non null values. |
| If any two or more fields of user, pod, brokeringPod, desktop, clientName are set to non null values. | |
| 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