com.apama.cumulocity
Event FindCacheManagedObject
Request managed objects from the shared cache. If a ManagedObject is not in the cache, then the inventory will be queried.
The cache only works for requests based upon ManagedObject ids, and the semantics are the same as for FindManagedObject. The use of any params intended to query by other properties will be ignored.
There are two extra parameters that can be used with this event. Only their presence matters: their actual value is ignored:
query: this queries the inventory directly and returns the entire ManagedObject. This is useful if you want properties such as the parent hierarchy, which is not included on update notifications, and hence cannot be cached. It will also return all the params. The result of a query will be cached, but only with the specified params. The cache does not support multi-page results and so will only work up tp the maximum page size of 2,000 ManagedObject ids.
batch: this returns the results of the request as a single batch of results in the FindCacheManagedObjectBatchResponse event, rather than as a set of individual FindCacheManagedObjectResponse events.- Since:
- 10.15.5.0
| Constant summary |
|---|
string | SEND_CHANNEL := "SharedManagedObjectCache_Send"
Channel to which to send requests. |
| Action summary |
|---|
void | setIds(sequence<string> ids)
Correctly sets the ids parameter for a request based upon a sequence of required ManagedObject ids. |
SEND_CHANNEL
string SEND_CHANNEL := "SharedManagedObjectCache_Send"
Channel to which to send requests.
deviceId
string deviceId
Id of the ManagedObject being requested.
params
dictionary<string, string> params
Parameters for the request.
reqId
integer reqId
Unique request id with which to identify the response.
setIds
void setIds(sequence<string> ids)
Correctly sets the ids parameter for a request based upon a sequence of required ManagedObject ids.
The required format for the ids parameter is a comma separated list.- Parameters:
- ids