com.bosch.iot.dm.devices

Interface DeviceInventory

All Superinterfaces:

DirectoryInventory, EventSubscriptions, FilterInventory, Provisioning, TagInventory

All Known Subinterfaces:

DeviceInventoryRemote

public interface DeviceInventory
extends DirectoryInventory, TagInventory, FilterInventory, EventSubscriptions, Provisioning

Device Inventory is an entry point to list, search and view IoT device assets of a solution

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DeviceInventory.Type

Method Summary

Modifier and Type	Method and Description
CompletionStage<List<String>>	definitions() Deprecated.
default com.bosch.iot.dm.util.PageIterator<String>	definitions(int pageSize) Deprecated. Use VortoInventory.models(Options, int, com.bosch.iot.dm.vorto.Type...) instead. Returns Vorto definitions referenced in device features the current caller has access rights for.
CompletionStage<Void>	delete(String deviceId) Deletes the Device specified by the given identifier
CompletionStage<Device>	device(String deviceId, String... fields) Returns the device identified by the given deviceId.
CompletionStage<List<Device>>	devices(Filter filter) Returns a list of devices matching the given filter.
PageIterator<Device>	devices(Filter filter, int pageSize) Returns a list of devices matching the given filter grouped in pages.
CompletionStage<List<Device>>	devices(List<String> fields, String... deviceIds) Returns a list of devices specified by the given identifiers.
CompletionStage<List<Device>>	devices(String... deviceIds) Returns a list of devices specified by the given identifiers.
CompletionStage<List<Device>>	devices(String gatewayId, Filter filter) Returns a list of edge devices attached to the gateway identified by gatewayId and matching the given filter.
CompletionStage<Integer>	devicesCount(Filter filter) Returns the number of devices matching the given filter.
CompletionStage<Integer>	devicesCount(String gatewayId, Filter filter) Returns the number of edge devices attached to the gateway identified by gatewayId and matching the given filter.
PageIterator<Directory>	directories(Filter filter, int pageSize) Returns a list of directories matching the specified filter, divided into pages.
PageIterator<Directory>	directories(int pageSize) Returns a list of all directories, divided into pages.
CompletionStage<Feature>	feature(String deviceId, String featureId, String... fields) Returns the feature identified by the given featureId for the device with deviceId.
PageIterator<FilterEntry>	filterEntries(Filter filter, int pageSize) Returns a list of filter entries matching the specified filter, divided into pages.
PageIterator<FilterEntry>	filterEntries(int pageSize) Returns a list of all filter entries, divided into pages.
CompletionStage<Gateway>	gateway(String gatewayId, String... fields) Returns an already existing Gateway identified by the given gatewayId.
CompletionStage<List<Gateway>>	gateways(Filter filter) Returns a list of gateways matching the given filter.
PageIterator<Gateway>	gateways(Filter filter, int pageSize) Returns a list of gateways matching the given filter grouped in pages.
CompletionStage<List<Gateway>>	gateways(List<String> fields, String... gatewayIds) Returns a list of gateways specified by the given identifiers.
CompletionStage<List<Gateway>>	gateways(String... gatewayIds) Returns a list of gateways specified by the given identifiers.
CompletionStage<Integer>	gatewaysCount(Filter filter) Returns the number of gateways matching the given filter.
CompletionStage<Boolean>	match(String deviceId, String query) Returns if the device identified by the given deviceId matches the given filter.
CompletionStage<Policy>	policy(String policyId) Returns an already existing Policy specified by the given identifier
PageIterator<Tag>	tags(Filter filter, int pageSize) Returns a list of tags matching the specified filter, divided into pages.
PageIterator<Tag>	tags(int pageSize) Returns a list of all tags, divided into pages.

Methods inherited from interface com.bosch.iot.dm.devices.groups.DirectoryInventory

createDirectory, deleteDirectory, directoriesCount, directory, directoryEventSubscriptions, moveDevice, moveDirectory, root, subscribeForDirectoryEvents, subscribeForDirectoryEvents, unsubscribeForDirectoryEvents

Methods inherited from interface com.bosch.iot.dm.devices.groups.TagInventory

createTag, deleteTag, subscribeForTagEvents, subscribeForTagEvents, tag, tagDevice, tagEventSubscriptions, tagsCount, unsubscribeForTagEvents, untagDevice

Methods inherited from interface com.bosch.iot.dm.devices.groups.FilterInventory

createFilterEntry, deleteFilterEntry, filterEntriesCount, filterEntry, filterEntryEventSubscriptions, subscribeForFilterEntryEvents, subscribeForFilterEntryEvents, unsubscribeForFilterEntryEvents

Methods inherited from interface com.bosch.iot.dm.devices.EventSubscriptions

deviceEventSubscriptions, deviceStatusEventSubscriptions, featureEventSubscriptions, featurePropertyEventSubscriptions, liveMessagesSubscriptions, subscribeForDeviceEvents, subscribeForDeviceEvents, subscribeForDeviceOfflineEvents, subscribeForDeviceOfflineEvents, subscribeForDeviceOnlineEvents, subscribeForDeviceOnlineEvents, subscribeForDeviceStatusChangeEvents, subscribeForDeviceStatusChangeEvents, subscribeForFeatureEvents, subscribeForFeatureEvents, subscribeForFeaturePropertyEvents, subscribeForFeaturePropertyEvents, subscribeForLiveMessages, subscribeForLiveMessages, subscribeForUploadRequestEvents, subscribeForUploadRequestEvents, subscription, unsubscribeForDeviceEvents, unsubscribeForDeviceOfflineEvents, unsubscribeForDeviceOnlineEvents, unsubscribeForDeviceStatusChangeEvents, unsubscribeForFeatureEvents, unsubscribeForFeaturePropertyEvents, unsubscribeForLiveMessages, unsubscribeForUploadRequestEvents, uploadRequestEventSubscriptions

Methods inherited from interface com.bosch.iot.dm.devices.Provisioning

register, unregister

Method Detail

gateways

PageIterator<Gateway> gateways(Filter filter,
                               int pageSize)

Returns a list of gateways matching the given filter grouped in pages. The result contains only existing and readable gateways.

Parameters:

filter - the filter the gateways to be returned to be matched against

pageSize - the number of gateways returned within a page

Returns:

PageIterator<Gateway> providing the requested gateways, an empty list or a specific Exception if the operation has failed

devices

PageIterator<Device> devices(Filter filter,
                             int pageSize)

Returns a list of devices matching the given filter grouped in pages. The result contains only existing and readable devices.

Parameters:

filter - the filter the devices to be returned to be matched against

pageSize - the number of devices returned within a page

Returns:

PageIterator<Device> providing the requested devices, an empty list or a specific Exception if the operation has failed

directories

PageIterator<Directory> directories(Filter filter,
                                    int pageSize)

Description copied from interface: DirectoryInventory

Returns a list of directories matching the specified filter, divided into pages.

Specified by:

directories in interface DirectoryInventory

Parameters:

filter - the filter to match against

pageSize - the page size

Returns:

PageIterator providing a list of directories matching the specified filter, divided into pages

tags

PageIterator<Tag> tags(int pageSize)

Description copied from interface: TagInventory

Returns a list of all tags, divided into pages.

Specified by:

tags in interface TagInventory

Parameters:

pageSize - the page size

Returns:

PageIterator providing a list of all tags, divided into pages

tags

PageIterator<Tag> tags(Filter filter,
                       int pageSize)

Description copied from interface: TagInventory

Returns a list of tags matching the specified filter, divided into pages.

Specified by:

tags in interface TagInventory

Parameters:

filter - the filter to match against

pageSize - the page size

Returns:

PageIterator providing a list of tags matching the specified filter, divided into pages

filterEntries

PageIterator<FilterEntry> filterEntries(int pageSize)

Description copied from interface: FilterInventory

Returns a list of all filter entries, divided into pages.

Specified by:

filterEntries in interface FilterInventory

Parameters:

pageSize - the page size

Returns:

PageIterator providing a list of all filter entries, divided into pages

filterEntries

PageIterator<FilterEntry> filterEntries(Filter filter,
                                        int pageSize)

Description copied from interface: FilterInventory

Returns a list of filter entries matching the specified filter, divided into pages.

Specified by:

filterEntries in interface FilterInventory

Parameters:

filter - the filter to match against

pageSize - the page size

Returns:

PageIterator providing a list of filter entries matching the specified filter, divided into pages

directories

PageIterator<Directory> directories(int pageSize)

Description copied from interface: DirectoryInventory

Returns a list of all directories, divided into pages.

Specified by:

directories in interface DirectoryInventory

Parameters:

pageSize - the page size

Returns:

PageIterator providing a list of all directories, divided into pages

gateways

CompletionStage<List<Gateway>> gateways(Filter filter)

Returns a list of gateways matching the given filter. The filter supports limit option and if not explicitly specified, a default count of 25 devices are returned. Maximum list size is 200. The result contains only existing and readable gateways.

Parameters:

filter - the filter the gateways to be returned to be matched against

Returns:

CompletionStage providing the requested gateways, an empty list or a specific Exception if the operation has failed

devices

CompletionStage<List<Device>> devices(Filter filter)

Returns a list of devices matching the given filter. The filter supports limit option and if not explicitly specified, a default count of 25 devices are returned. Maximum list size is 200. The result contains only existing and readable devices.

Parameters:

filter - the filter the devices to be returned to be matched against

Returns:

CompletionStage providing the requested devices, an empty list or a specific Exception if the operation has failed

devices

CompletionStage<List<Device>> devices(String gatewayId,
                                      Filter filter)

Returns a list of edge devices attached to the gateway identified by gatewayId and matching the given filter. The filter supports limit option and if not explicitly specified, a default count of 25 devices are returned. Maximum list size is 200. The result contains only existing and readable devices.

Parameters:

gatewayId - the gateway ID the edge devices are attached to

filter - the filter the devices to be returned to be matched against

Returns:

CompletionStage providing the requested devices, an empty list or a specific Exception if the operation has failed

gatewaysCount

CompletionStage<Integer> gatewaysCount(Filter filter)

Returns the number of gateways matching the given filter. The filter supports limit option and if not explicitly specified, a default count of 25 devices are returned. Maximum list size is 200. The result contains only existing and readable gateways.

Parameters:

filter - the filter the gateways to be returned to be matched against

Returns:

CompletionStage providing the requested gateways count, or a specific Exception if the operation has failed

devicesCount

CompletionStage<Integer> devicesCount(Filter filter)

Returns the number of devices matching the given filter. The filter supports limit option and if not explicitly specified, a default count of 25 devices are returned. Maximum list size is 200. The result contains only existing and readable devices.

Parameters:

filter - the filter the devices to be returned to be matched against

Returns:

CompletionStage providing the requested devices count, or a specific Exception if the operation has failed

devicesCount

CompletionStage<Integer> devicesCount(String gatewayId,
                                      Filter filter)

Returns the number of edge devices attached to the gateway identified by gatewayId and matching the given filter. The filter supports limit option and if not explicitly specified, a default count of 25 devices are returned. Maximum list size is 200. The result contains only existing and readable devices.

Parameters:

gatewayId - the gateway ID the edge devices are attached to

filter - the filter the devices to be returned to be matched against

Returns:

CompletionStage providing the requested devices count, or a specific Exception if the operation has failed

gateways

CompletionStage<List<Gateway>> gateways(String... gatewayIds)

Returns a list of gateways specified by the given identifiers. The result contains only existing and readable gateways.

Parameters:

gatewayIds - the identifiers of the gateways to be retrieved.

Returns:

CompletionStage providing the requested gateways , an empty list or a specific Exception if the operation has failed

devices

CompletionStage<List<Device>> devices(String... deviceIds)

Returns a list of devices specified by the given identifiers. The result contains only existing and readable devices.

Parameters:

deviceIds - the identifiers of the devices to be retrieved.

Returns:

CompletionStage providing the requested devices, an empty list or a specific Exception if the operation has failed

gateways

CompletionStage<List<Gateway>> gateways(List<String> fields,
                                        String... gatewayIds)

Returns a list of gateways specified by the given identifiers. The result contains only existing and readable gateways.

Parameters:

fields - subset of fields on the gateways to be retrieved

gatewayIds - the identifiers of the gateways to be retrieved

Returns:

CompletionStage providing the requested gateways, an empty list or a specific Exception if the operation has failed

devices

CompletionStage<List<Device>> devices(List<String> fields,
                                      String... deviceIds)

Returns a list of devices specified by the given identifiers. The result contains only existing and readable devices.

Parameters:

fields - subset of fields on the devices to be retrieved

deviceIds - the identifiers of the devices to be retrieved

Returns:

CompletionStage providing the requested devices, an empty list or a specific Exception if the operation has failed

gateway

CompletionStage<Gateway> gateway(String gatewayId,
                                 String... fields)

Returns an already existing Gateway identified by the given gatewayId.

Parameters:

gatewayId - the identifier of the Gateway

fields - subset of fields on the devices to be retrieved

Returns:

the Gateway for the provided gatewayId

device

CompletionStage<Device> device(String deviceId,
                               String... fields)

Returns the device identified by the given deviceId.

Parameters:

deviceId - the identifier of the Device

fields - subset of fields on the devices to be retrieved

Returns:

the Device for the provided deviceId

policy

CompletionStage<Policy> policy(String policyId)

Returns an already existing Policy specified by the given identifier

Parameters:

policyId - the identifier of the Policy to get

Returns:

the Policy for the provided policyId

feature

CompletionStage<Feature> feature(String deviceId,
                                 String featureId,
                                 String... fields)

Returns the feature identified by the given featureId for the device with deviceId.

Parameters:

deviceId - the identifier of the Device

featureId - the feature identifier

fields - subset of fields on the devices to be retrieved

Returns:

the feature for the provided deviceId and featureId

delete

CompletionStage<Void> delete(String deviceId)

Deletes the Device specified by the given identifier

Parameters:

deviceId - the identifier of the Device to be deleted

Returns:

CompletionStage for handling the operation result

match

CompletionStage<Boolean> match(String deviceId,
                               String query)

Returns if the device identified by the given deviceId matches the given filter.

Parameters:

deviceId - the identifier of the Device

query - the query the device to matched against

Returns:

the true if the device matches the rql query, false otherwise

definitions

@Deprecated
default com.bosch.iot.dm.util.PageIterator<String> definitions(int pageSize)

Deprecated. Use VortoInventory.models(Options, int, com.bosch.iot.dm.vorto.Type...) instead. Returns Vorto definitions referenced in device features the current caller has access rights for.

Parameters:

pageSize - number of elements to be returned in a page

Returns:

Feature definitions

definitions

@Deprecated
CompletionStage<List<String>> definitions()

Deprecated.