public interface EventSubscriptions
Modifier and Type | Method and Description |
---|---|
com.bosch.iot.dm.util.PageIterator<Subscription<Options.DeviceOptions>> |
deviceEventSubscriptions(int pageSize)
Returns a list of device event subscriptions grouped in pages.
|
com.bosch.iot.dm.util.PageIterator<Subscription<Options.DeviceStatusOptions>> |
deviceStatusEventSubscriptions(int pageSize)
Returns a list of device status event subscriptions grouped in pages.
|
com.bosch.iot.dm.util.PageIterator<Subscription<Options.FeatureOptions>> |
featureEventSubscriptions(int pageSize)
Returns a list of feature event subscriptions grouped in pages.
|
com.bosch.iot.dm.util.PageIterator<Subscription<Options.FeaturePropertyOptions>> |
featurePropertyEventSubscriptions(int pageSize)
Returns a list of feature property event subscriptions grouped in pages.
|
com.bosch.iot.dm.util.PageIterator<Subscription<Options.LiveMessageOptions>> |
liveMessagesSubscriptions(int pageSize)
Returns a list of messages subscriptions grouped in pages.
|
void |
subscribeForDeviceEvents(Options.DeviceOptions options,
StreamConsumer<DeviceEvent> consumer)
Subscribe for device state events.
|
CompletionStage<Void> |
subscribeForDeviceEvents(String subscriptionId,
Options.DeviceOptions options,
Target target)
Subscribe for device state events using an RQL filter
(https://things.eu-1.bosch-iot-suite.com/dokuwiki/doku.php?id=dev_guide:protocol:filter).
|
void |
subscribeForDeviceOfflineEvents(Optional<String> deviceId,
StreamConsumer<DeviceOfflineEvent> consumer)
Subscribe for device offline events.
|
CompletionStage<Void> |
subscribeForDeviceOfflineEvents(String subscriptionId,
Optional<String> deviceId,
Target target)
Subscribe for offline events.
|
void |
subscribeForDeviceOnlineEvents(Optional<String> deviceId,
StreamConsumer<DeviceOnlineEvent> consumer)
Subscribe for device online events.
|
CompletionStage<Void> |
subscribeForDeviceOnlineEvents(String subscriptionId,
Optional<String> deviceId,
Target target)
Subscribe for device online events.
|
void |
subscribeForDeviceStatusChangeEvents(Optional<String> deviceId,
StreamConsumer<DeviceStatusChangeEvent> consumer)
Subscribe for device status (offline/online) change events.
|
CompletionStage<Void> |
subscribeForDeviceStatusChangeEvents(String subscriptionId,
Optional<String> deviceId,
Target target)
Subscribe for device status (offline and online) change events.
|
void |
subscribeForFeatureEvents(Options.FeatureOptions options,
StreamConsumer<FeatureEvent> consumer)
Subscribe for feature events.
|
CompletionStage<Void> |
subscribeForFeatureEvents(String subscriptionId,
Options.FeatureOptions options,
Target target)
Subscribe for feature events.
|
void |
subscribeForFeaturePropertyEvents(Options.FeaturePropertyOptions options,
StreamConsumer<FeaturePropertyEvent> consumer)
Subscribe for feature property events.
|
CompletionStage<Void> |
subscribeForFeaturePropertyEvents(String subscriptionId,
Options.FeaturePropertyOptions options,
Target target)
Subscribe for feature property events.
|
void |
subscribeForLiveMessages(Options.LiveMessageOptions options,
StreamConsumer<LiveMessage> consumer)
Subscribe for live messages.
|
CompletionStage<Void> |
subscribeForLiveMessages(String subscriptionId,
Options.LiveMessageOptions options,
Target target)
Subscribe for messages.
|
void |
subscribeForUploadRequestEvents(Options.UploadRequestOptions options,
StreamConsumer<UploadRequestEvent> consumer)
Subscribe for upload request events.
|
CompletionStage<Void> |
subscribeForUploadRequestEvents(String subscriptionId,
Options.UploadRequestOptions options,
Target target)
Subscribe for upload request events.
|
<O> CompletionStage<Subscription<O>> |
subscription(String subscriptionId)
Get event subscription
|
CompletionStage<Void> |
unsubscribeForDeviceEvents(String subscriptionId)
Delete a persistent subscription for device events with subscription id.
|
CompletionStage<Void> |
unsubscribeForDeviceOfflineEvents(String subscriptionId)
Delete a persistent subscription for device online events with given subscription id.
|
CompletionStage<Void> |
unsubscribeForDeviceOnlineEvents(String subscriptionId)
Delete a persistent subscription for device online events with given subscription id.
|
CompletionStage<Void> |
unsubscribeForDeviceStatusChangeEvents(String subscriptionId)
Delete a persistent subscription for device status events with given subscription id.
|
CompletionStage<Void> |
unsubscribeForFeatureEvents(String subscriptionId)
Delete a persistent subscription for feature events with given subscription id.
|
CompletionStage<Void> |
unsubscribeForFeaturePropertyEvents(String subscriptionId)
Delete a persistent subscription for feature property events with given subscription id.
|
CompletionStage<Void> |
unsubscribeForLiveMessages(String subscriptionId)
Delete a persistent subscription for messages with given subscription id.
|
CompletionStage<Void> |
unsubscribeForUploadRequestEvents(String subscriptionId)
Delete a persistent subscription for upload request events with given subscription id.
|
com.bosch.iot.dm.util.PageIterator<Subscription<Options.UploadRequestOptions>> |
uploadRequestEventSubscriptions(int pageSize)
Returns a list of upload request event subscriptions grouped in pages.
|
void subscribeForDeviceEvents(Options.DeviceOptions options, StreamConsumer<DeviceEvent> consumer)
options
- subscription options, e.g. event type, filterconsumer
- event consumerCompletionStage<Void> subscribeForDeviceEvents(String subscriptionId, Options.DeviceOptions options, Target target)
unsubscribeForDeviceEvents(String)
.subscriptionId
- subscription id. The subscription id must be unique in the scope of the event source.
Using this subscription id the user may set consumer for the subscriptionoptions
- an event filter. The filter is opaque for the Event Service and is to be interpreted by event
source only.target
- target where the events shall be sent toCompletionStage
that is completed successfully if the subscription has been finished
and exceptionally in case of failure.CompletionStage<Void> unsubscribeForDeviceEvents(String subscriptionId)
subscriptionId
- subscription id.CompletionStage
that is completed successfully if the subscription has been finished
and exceptionally in case of failure.com.bosch.iot.dm.util.PageIterator<Subscription<Options.DeviceOptions>> deviceEventSubscriptions(int pageSize)
pageSize
- the number of subscriptions returned within a pagevoid subscribeForFeatureEvents(Options.FeatureOptions options, StreamConsumer<FeatureEvent> consumer)
options
- feature event subscription optionsconsumer
- the consumer of the eventsCompletionStage<Void> subscribeForFeatureEvents(String subscriptionId, Options.FeatureOptions options, Target target)
unsubscribeForFeatureEvents(String)
.subscriptionId
- unique subscription idoptions
- feature event subscription optionstarget
- target where the events shall be sent toCompletionStage
that is completed successfully if the subscription has been finished and exceptionally in case of failure.CompletionStage<Void> unsubscribeForFeatureEvents(String subscriptionId)
subscriptionId
- the id of an existing subscriptionCompletionStage
that is completed successfully if the subscription has been cancelled and exceptionally in case of failure.com.bosch.iot.dm.util.PageIterator<Subscription<Options.FeatureOptions>> featureEventSubscriptions(int pageSize)
pageSize
- the number of subscriptions returned within a pagevoid subscribeForFeaturePropertyEvents(Options.FeaturePropertyOptions options, StreamConsumer<FeaturePropertyEvent> consumer)
options
- feature property event subscription optionsconsumer
- the consumer of the eventsCompletionStage<Void> subscribeForFeaturePropertyEvents(String subscriptionId, Options.FeaturePropertyOptions options, Target target)
unsubscribeForFeaturePropertyEvents(String)
.subscriptionId
- unique subscription idoptions
- feature property event subscription optionstarget
- target where the events shall be sent toCompletionStage
that is completed successfully if the subscription has been created and exceptionally in case of failure.CompletionStage<Void> unsubscribeForFeaturePropertyEvents(String subscriptionId)
subscriptionId
- the id of an existing subscriptionCompletionStage
that is completed successfully if the subscription has been cancelled and exceptionally in case of failure.com.bosch.iot.dm.util.PageIterator<Subscription<Options.FeaturePropertyOptions>> featurePropertyEventSubscriptions(int pageSize)
pageSize
- the number of subscriptions returned within a pagevoid subscribeForDeviceOfflineEvents(Optional<String> deviceId, StreamConsumer<DeviceOfflineEvent> consumer)
deviceId
- the id of the device to receive events forconsumer
- the consumer of the eventsCompletionStage<Void> subscribeForDeviceOfflineEvents(String subscriptionId, Optional<String> deviceId, Target target)
unsubscribeForDeviceOfflineEvents(String)
.subscriptionId
- unique subscription iddeviceId
- the id of the device to receive events fortarget
- target where the events shall be sent toCompletionStage
that is completed successfully if the subscription has been created and exceptionally in case of failure.CompletionStage<Void> unsubscribeForDeviceOfflineEvents(String subscriptionId)
subscriptionId
- the id of an existing subscriptionCompletionStage
that is completed successfully if the subscription has been cancelled and exceptionally in case of failure.void subscribeForDeviceStatusChangeEvents(Optional<String> deviceId, StreamConsumer<DeviceStatusChangeEvent> consumer)
deviceId
- the id of the device to receive events forconsumer
- the consumer of the eventsCompletionStage<Void> subscribeForDeviceStatusChangeEvents(String subscriptionId, Optional<String> deviceId, Target target)
unsubscribeForDeviceStatusChangeEvents(String)
.subscriptionId
- unique subscription iddeviceId
- the id of the device to receive events fortarget
- target where the events shall be sent toCompletionStage
that is completed successfully if the subscription has been created and exceptionally in case of failure.CompletionStage<Void> unsubscribeForDeviceStatusChangeEvents(String subscriptionId)
subscriptionId
- the id of an existing subscriptionCompletionStage
that is completed successfully if the subscription has been cancelled and exceptionally in case of failure.void subscribeForDeviceOnlineEvents(Optional<String> deviceId, StreamConsumer<DeviceOnlineEvent> consumer)
deviceId
- the id of the device to receive events forconsumer
- the consumer of the eventsCompletionStage<Void> subscribeForDeviceOnlineEvents(String subscriptionId, Optional<String> deviceId, Target target)
unsubscribeForDeviceOnlineEvents(String)
.subscriptionId
- unique subscription iddeviceId
- the id of the device to receive events fortarget
- target where the events shall be sent toCompletionStage
that is completed successfully if the subscription has been created and exceptionally in case of failure.CompletionStage<Void> unsubscribeForDeviceOnlineEvents(String subscriptionId)
subscriptionId
- the id of an existing subscriptionCompletionStage
that is completed successfully if the subscription has been cancelled and exceptionally in case of failure.com.bosch.iot.dm.util.PageIterator<Subscription<Options.DeviceStatusOptions>> deviceStatusEventSubscriptions(int pageSize)
pageSize
- the number of subscriptions returned within a page<O> CompletionStage<Subscription<O>> subscription(String subscriptionId)
O
- subscription option typesubscriptionId
- subscription idsubscriptionId
void subscribeForUploadRequestEvents(Options.UploadRequestOptions options, StreamConsumer<UploadRequestEvent> consumer)
options
- upload request event subscription optionsconsumer
- the consumer of the eventsCompletionStage<Void> subscribeForUploadRequestEvents(String subscriptionId, Options.UploadRequestOptions options, Target target)
unsubscribeForUploadRequestEvents(String)
.subscriptionId
- unique subscription idoptions
- upload request event subscription optionstarget
- target where the events shall be sent toCompletionStage
that is completed successfully if the subscription has been finished and exceptionally in case of failure.CompletionStage<Void> unsubscribeForUploadRequestEvents(String subscriptionId)
subscriptionId
- the id of an existing subscriptionCompletionStage
that is completed successfully if the subscription has been cancelled and exceptionally in case of failure.com.bosch.iot.dm.util.PageIterator<Subscription<Options.UploadRequestOptions>> uploadRequestEventSubscriptions(int pageSize)
pageSize
- the number of subscriptions returned within a pagevoid subscribeForLiveMessages(Options.LiveMessageOptions options, StreamConsumer<LiveMessage> consumer)
options
- live messages subscription optionsconsumer
- the consumer of the messagesCompletionStage<Void> subscribeForLiveMessages(String subscriptionId, Options.LiveMessageOptions options, Target target)
unsubscribeForLiveMessages(String)
.subscriptionId
- unique subscription idoptions
- live messages subscription optionstarget
- target where the events shall be sent toCompletionStage
that is completed successfully if the subscription has been finished and exceptionally in case of failure.CompletionStage<Void> unsubscribeForLiveMessages(String subscriptionId)
subscriptionId
- the id of an existing subscriptionCompletionStage
that is completed successfully if the subscription has been cancelled and exceptionally in case of failure.com.bosch.iot.dm.util.PageIterator<Subscription<Options.LiveMessageOptions>> liveMessagesSubscriptions(int pageSize)
pageSize
- the number of subscriptions returned within a pageCopyright © 2022 Bosch.IO GmbH. All rights reserved.