FindTenantOptions

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.11.3.3

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.cumulocity
Event FindTenantOptions

Finds tenant options, searching on system, category and key.

By default will return all TenantOptions which match the criteria. You can set params to select which TenantOptions to receive.

Send this event to FindTenantOptions.SEND_CHANNEL. Cumulocity will respond with a single FindTenantOptionsResponse event on FindTenantOptionsResponse.SUBSCRIBE_CHANNEL containing all matching tenant options.

Since:: 10.5.2.0

See Also:: com.apama.cumulocity.TenantOption -; com.apama.cumulocity.FindTenantOptionsResponse -

Constant summary
`string`	`SEND_CHANNEL := "CumulocityIoTGenericChain"` Channel for sending tenant options.

Member summary
`integer`	`reqId` Request identifier. Must be generated using com.apama.cumulocity.Util.generateReqId().
`boolean`	`system` If system properties are requested.
`string`	`category` Tenant option category. May be empty.
`string`	`key` Tenant option key. May be empty. If you search only using a key, then all tenant options will be fetched from Cumulocity and they will be filtered by key by the correlator.
`dictionary<string, string>`	`params` Additional request params. 'pageSize', 'currentPage' can be provided.

Constant detail

SEND_CHANNEL

            string SEND_CHANNEL := "CumulocityIoTGenericChain"

Channel for sending tenant options.

Since:: 10.5.2.0

Member detail

key

            string key

Tenant option key. May be empty. If you search only using a key, then all tenant options will be fetched from Cumulocity and they will be filtered by key by the correlator.

params

            dictionary<string, string> params

Additional request params. 'pageSize', 'currentPage' can be provided.

pageSize represents a batching parameter for getting multiple responses from Cumulocity. A larger pageSize will do fewer requests to Cumulocity to retrieve all the tenant options, but each will be larger
currentPage can be set to retrieve a specific page of results for the given pageSize. If you set current page then only a single page will be requested, rather than all of them

reqId

            integer reqId

Request identifier. Must be generated using com.apama.cumulocity.Util.generateReqId().

system

            boolean system

If system properties are requested.