public interface DeviceInventoryRemote extends DeviceInventory
DeviceInventory.Type
Modifier and Type | Method and Description |
---|---|
CompletionStage<Void> |
deleteAttribute(Identifier identifier,
String attributePath,
String... acknowledgements)
Deletes the attribute with the specified attribute path from the entity with the specified identifier.
|
CompletionStage<Void> |
deleteAttributes(Identifier identifier,
String... acknowledgements)
Deletes the attributes of the entity with the specified identifier.
|
CompletionStage<Void> |
deleteFeature(String deviceId,
String featureId,
String... acknowledgements)
Deletes the feature with the specified feature id from the device with the specified identifier.
|
CompletionStage<Void> |
deleteFeatureDesiredProperties(String deviceId,
String featureId,
String... acknowledgements)
Delete the desired properties of the specified feature on the device with the specified identifier.
|
CompletionStage<Void> |
deleteFeatureDesiredProperty(String deviceId,
String featureId,
String path,
String... acknowledgements)
Deletes the desired property of the specified feature on the device with the specified identifier.
|
CompletionStage<Void> |
deleteFeatureProperties(String deviceId,
String featureId,
String... acknowledgements)
Delete the properties of the specified feature on the device with the specified identifier.
|
CompletionStage<Void> |
deleteFeatureProperty(String deviceId,
String featureId,
String path,
String... acknowledgements)
Deletes the property of the specified feature on the device with the specified identifier.
|
default com.bosch.iot.dm.util.PageIterator<Subscription<Options.DeviceOptions>> |
deviceEventSubscriptions(int pageSize)
Returns a list of device event subscriptions grouped in pages.
|
default PageIterator<Device> |
devices(Filter filter,
int pageSize)
Returns a list of devices matching the given filter grouped in pages.
|
default com.bosch.iot.dm.util.PageIterator<Subscription<Options.DeviceStatusOptions>> |
deviceStatusEventSubscriptions(int pageSize)
Returns a list of device status event subscriptions grouped in pages.
|
default PageIterator<Directory> |
directories(Filter filter,
int pageSize)
Returns a list of directories matching the specified filter, divided into pages.
|
default PageIterator<Directory> |
directories(int pageSize)
Returns a list of all directories, divided into pages.
|
default com.bosch.iot.dm.util.PageIterator<Subscription<List<DirectoryEvent.Type>>> |
directoryEventSubscriptions(int pageSize)
Returns a list of directory event subscriptions grouped in pages.
|
<T> CompletionStage<T> |
exec(String thingId,
String featureId,
String action,
Object[] args,
List<DefinitionIdentifier> definitions)
Executes a command and gets response in the same process, asynchronously
|
CompletionStage<FunctionBlock> |
featureDefinition(String fullyQualifiedIdentifier)
Deprecated.
Use
VortoInventory.content(ModelId) (ModelId)} instead.
Returns the Vorto Model |
default com.bosch.iot.dm.util.PageIterator<Subscription<Options.FeatureOptions>> |
featureEventSubscriptions(int pageSize)
Returns a list of feature event subscriptions grouped in pages.
|
default com.bosch.iot.dm.util.PageIterator<Subscription<Options.FeaturePropertyOptions>> |
featurePropertyEventSubscriptions(int pageSize)
Returns a list of feature property event subscriptions grouped in pages.
|
default PageIterator<FilterEntry> |
filterEntries(Filter filter,
int pageSize)
Returns a list of filter entries matching the specified filter, divided into pages.
|
default PageIterator<FilterEntry> |
filterEntries(int pageSize)
Returns a list of all filter entries, divided into pages.
|
default com.bosch.iot.dm.util.PageIterator<Subscription<List<FilterEntryEvent.Type>>> |
filterEntryEventSubscriptions(int pageSize)
Returns a list of filterEntry event subscriptions grouped in pages.
|
default PageIterator<Gateway> |
gateways(Filter filter,
int pageSize)
Returns a list of gateways matching the given filter grouped in pages.
|
default com.bosch.iot.dm.util.PageIterator<Subscription<Options.LiveMessageOptions>> |
liveMessagesSubscriptions(int pageSize)
Returns a list of messages subscriptions grouped in pages.
|
<T> CompletionStage<Void> |
message(String thingId,
Optional<String> featureId,
String subject,
T message)
Send opaque message without response
|
<T> CompletionStage<com.bosch.iot.dm.util.Page<T>> |
page(String gatewayId,
Filter filter,
DeviceInventory.Type valueType)
Returns a page of devices attached to the gateway and matching the given filter.
|
CompletionStage<Directory> |
parentOf(String path)
Retrieves the parent directory for the directory with the specified path
|
CompletionStage<List<Attribute<?>>> |
replaceAttributes(Identifier identifier,
List<Attribute<?>> attributes,
String... acknowledgements)
Replaces all previously existing attributes of an entity.
|
<T> CompletionStage<T> |
request(String thingId,
Optional<String> featureId,
String subject,
T message)
Send opaque request wit response
|
CompletionStage<Void> |
setAttribute(Identifier identifier,
Attribute<?> attribute,
String... acknowledgements)
Sets the attribute with the specified path to the entity with the specified identifier.
|
CompletionStage<Void> |
setDirectoryName(String path,
String newDirectoryName,
String... acknowledgements)
Renames the directory identified by the
path parameter. |
CompletionStage<Void> |
setFeature(String deviceId,
Feature feature,
String... acknowledgements)
Sets the feature to the device with the specified identifier.
|
CompletionStage<Void> |
setFeatureDesiredProperties(String deviceId,
String featureId,
List<Property<?>> desiredProperties,
String... acknowledgements)
Sets the desired properties of the specified feature on the device with the specified identifier.
|
CompletionStage<Void> |
setFeatureDesiredProperty(String deviceId,
String featureId,
Property<?> desiredProperty,
String... acknowledgements)
Sets the desired property to the specified feature on the device with the specified identifier.
|
CompletionStage<Void> |
setFeatureProperties(String deviceId,
String featureId,
List<Property<?>> properties,
String... acknowledgements)
Sets the properties of the specified feature on the device with the specified identifier.
|
CompletionStage<Void> |
setFeatureProperty(String deviceId,
String featureId,
Property<?> property,
String... acknowledgements)
Sets the property to the specified feature on the device with the specified identifier.
|
CompletionStage<Void> |
setFilterEntryFilter(String targetFilterName,
Filter filter,
String... acknowledgements)
Edits a filter entry's filter.
|
CompletionStage<Void> |
setFilterEntryName(String targetFilterName,
String newFilterName,
String... acknowledgements)
Edits a filter entry's name.
|
CompletionStage<Void> |
setTagName(String targetTagName,
String newTagName,
String... acknowledgements)
Edits a tag's name.
|
default <O> com.bosch.iot.dm.util.PageIterator<Subscription<O>> |
subscriptions(String sourceType,
int pageSize) |
<O> void |
subscriptions(String sourceType,
StreamConsumer<Subscription<O>> consumer) |
default com.bosch.iot.dm.util.PageIterator<Subscription<List<TagEvent.Type>>> |
tagEventSubscriptions(int pageSize)
Returns a list of tag event subscriptions grouped in pages.
|
default PageIterator<Tag> |
tags(Filter filter,
int pageSize)
Returns a list of tags matching the specified filter, divided into pages.
|
default PageIterator<Tag> |
tags(int pageSize)
Returns a list of all tags, divided into pages.
|
default com.bosch.iot.dm.util.PageIterator<Subscription<Options.UploadRequestOptions>> |
uploadRequestEventSubscriptions(int pageSize)
Returns a list of upload request event subscriptions grouped in pages.
|
definitions, definitions, delete, device, devices, devices, devices, devices, devicesCount, devicesCount, feature, gateway, gateways, gateways, gateways, gatewaysCount, match, policy
createDirectory, deleteDirectory, directoriesCount, directory, moveDevice, moveDirectory, root, subscribeForDirectoryEvents, subscribeForDirectoryEvents, unsubscribeForDirectoryEvents
createTag, deleteTag, subscribeForTagEvents, subscribeForTagEvents, tag, tagDevice, tagsCount, unsubscribeForTagEvents, untagDevice
createFilterEntry, deleteFilterEntry, filterEntriesCount, filterEntry, subscribeForFilterEntryEvents, subscribeForFilterEntryEvents, unsubscribeForFilterEntryEvents
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
register, unregister
<T> CompletionStage<com.bosch.iot.dm.util.Page<T>> page(String gatewayId, Filter filter, DeviceInventory.Type valueType)
T
- Result TypegatewayId
- the gateway identifierfilter
- the filter the devices to be returned to be matched againstvalueType
- member type<T> CompletionStage<T> exec(String thingId, String featureId, String action, Object[] args, List<DefinitionIdentifier> definitions)
T
- Result TypethingId
- the thing id.featureId
- a feature.action
- action nameargs
- argumentsdefinitions
- vorto definitions of the feature<T> CompletionStage<Void> message(String thingId, Optional<String> featureId, String subject, T message)
T
- payload type - String or byte[] ONLY. The correspondent content types are test/plain or application/octet-streamthingId
- the thing id.featureId
- a feature. If not present the message is to thing itself.subject
- message subjectmessage
- message<T> CompletionStage<T> request(String thingId, Optional<String> featureId, String subject, T message)
T
- payload type - String or byte[] ONLY. The correspondent content types are test/plain or application/octet-streamthingId
- the thing id.featureId
- a feature. If not present the message is to thing itself.subject
- message subjectmessage
- message@Deprecated CompletionStage<FunctionBlock> featureDefinition(String fullyQualifiedIdentifier)
VortoInventory.content(ModelId)
(ModelId)} instead.
Returns the Vorto ModelfullyQualifiedIdentifier
- feature definition in form namespace:name:version
CompletionStage
to track the operation progress.CompletionStage<Directory> parentOf(String path)
path
- the path of the directoryCompletionStage
providing the parent directory for the directory with the specified pathCompletionStage<List<Attribute<?>>> replaceAttributes(Identifier identifier, List<Attribute<?>> attributes, String... acknowledgements)
attributes
argument, it will be skipped and not replaced. Such unsuccessful
replacements will be reflected in the returned result.identifier
- the identifier of the entity to set the attributes toattributes
- the attributes to setacknowledgements
- requested acknowledgements for this operationCompletionStage
providing a list with the successfully replaced attributesModelConstants
CompletionStage<Void> setAttribute(Identifier identifier, Attribute<?> attribute, String... acknowledgements)
identifier
- the identifier of the entity to set the attribute toattribute
- the attribute to be setacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> deleteAttributes(Identifier identifier, String... acknowledgements)
identifier
- the identifier of the entity whose attributes will be deletedacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> deleteAttribute(Identifier identifier, String attributePath, String... acknowledgements)
identifier
- the identifier of the entity whose attribute will be deletedattributePath
- the path of the attribute to be deletedacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> setTagName(String targetTagName, String newTagName, String... acknowledgements)
CompletionStage
will complete exceptionally.targetTagName
- the tag name of the desired tag to editnewTagName
- the new name of the desired tag to editacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> setFeature(String deviceId, Feature feature, String... acknowledgements)
deviceId
- the identifier of the entity to set the feature tofeature
- the feature to be setacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> deleteFeature(String deviceId, String featureId, String... acknowledgements)
deviceId
- the identifier of the entity whose feature will be deletedfeatureId
- the feature identifier of the feature to be deletedacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> setFeatureProperty(String deviceId, String featureId, Property<?> property, String... acknowledgements)
deviceId
- the identifier of the devicefeatureId
- the feature identifier of the feature the property to be set toproperty
- the property to be set to the specified feature.
Property
id can be provided as path to point to nested object in the feature properties.acknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> deleteFeatureProperty(String deviceId, String featureId, String path, String... acknowledgements)
deviceId
- the identifier of the devicefeatureId
- the feature identifier of the feature the property to be set topath
- the path to the property to be deleted. Can be nested.acknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> setFeatureProperties(String deviceId, String featureId, List<Property<?>> properties, String... acknowledgements)
deviceId
- the identifier of the devicefeatureId
- the feature identifierproperties
- properties to be setacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> deleteFeatureProperties(String deviceId, String featureId, String... acknowledgements)
deviceId
- the identifier of the devicefeatureId
- the feature identifieracknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> setFeatureDesiredProperty(String deviceId, String featureId, Property<?> desiredProperty, String... acknowledgements)
deviceId
- the identifier of the devicefeatureId
- the feature identifier of the feature the property to be set todesiredProperty
- the desired property to be set to the specified feature.
Property
id can be provided as path to point to nested object in the feature properties.acknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> deleteFeatureDesiredProperty(String deviceId, String featureId, String path, String... acknowledgements)
deviceId
- the identifier of the devicefeatureId
- the feature identifier of the feature the property to be set topath
- the path to the desired property to be deleted. Can be nested.acknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> setFeatureDesiredProperties(String deviceId, String featureId, List<Property<?>> desiredProperties, String... acknowledgements)
deviceId
- the identifier of the devicefeatureId
- the feature identifierdesiredProperties
- the desired properties to be setacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> deleteFeatureDesiredProperties(String deviceId, String featureId, String... acknowledgements)
deviceId
- the identifier of the devicefeatureId
- the feature identifieracknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationdefault PageIterator<Gateway> gateways(Filter filter, int pageSize)
gateways
in interface DeviceInventory
filter
- the filter the gateways to be returned to be matched againstpageSize
- the number of gateways returned within a pagedefault PageIterator<Device> devices(Filter filter, int pageSize)
devices
in interface DeviceInventory
filter
- the filter the devices to be returned to be matched againstpageSize
- the number of devices returned within a pagedefault PageIterator<Directory> directories(Filter filter, int pageSize)
DirectoryInventory
directories
in interface DeviceInventory
directories
in interface DirectoryInventory
filter
- the filter to match againstpageSize
- the page sizePageIterator
providing a list of directories matching the specified filter, divided into pagesdefault PageIterator<Directory> directories(int pageSize)
DirectoryInventory
directories
in interface DeviceInventory
directories
in interface DirectoryInventory
pageSize
- the page sizePageIterator
providing a list of all directories, divided into pagesdefault PageIterator<Tag> tags(int pageSize)
TagInventory
tags
in interface DeviceInventory
tags
in interface TagInventory
pageSize
- the page sizePageIterator
providing a list of all tags, divided into pagesdefault PageIterator<Tag> tags(Filter filter, int pageSize)
TagInventory
tags
in interface DeviceInventory
tags
in interface TagInventory
filter
- the filter to match againstpageSize
- the page sizePageIterator
providing a list of tags matching the specified filter, divided into pagesdefault PageIterator<FilterEntry> filterEntries(int pageSize)
FilterInventory
filterEntries
in interface DeviceInventory
filterEntries
in interface FilterInventory
pageSize
- the page sizePageIterator
providing a list of all filter entries, divided into pagesdefault PageIterator<FilterEntry> filterEntries(Filter filter, int pageSize)
FilterInventory
filterEntries
in interface DeviceInventory
filterEntries
in interface FilterInventory
filter
- the filter to match againstpageSize
- the page sizePageIterator
providing a list of filter entries matching the specified filter, divided into pagesCompletionStage<Void> setFilterEntryName(String targetFilterName, String newFilterName, String... acknowledgements)
CompletionStage
will complete exceptionally.targetFilterName
- The name of the filter entry to editnewFilterName
- The new filter entry nameacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> setFilterEntryFilter(String targetFilterName, Filter filter, String... acknowledgements)
targetFilterName
- The Name of the filter entry to editfilter
- The new filter entry search queryacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationCompletionStage<Void> setDirectoryName(String path, String newDirectoryName, String... acknowledgements)
path
parameter.
If a directory with the new name already exists, the CompletionStage
will complete exceptionally.path
- The path of the directory to editnewDirectoryName
- The new directory nameacknowledgements
- requested acknowledgements for this operationCompletionStage
providing the result of the operationdefault com.bosch.iot.dm.util.PageIterator<Subscription<Options.DeviceOptions>> deviceEventSubscriptions(int pageSize)
EventSubscriptions
deviceEventSubscriptions
in interface EventSubscriptions
pageSize
- the number of subscriptions returned within a pagedefault com.bosch.iot.dm.util.PageIterator<Subscription<Options.FeatureOptions>> featureEventSubscriptions(int pageSize)
EventSubscriptions
featureEventSubscriptions
in interface EventSubscriptions
pageSize
- the number of subscriptions returned within a pagedefault com.bosch.iot.dm.util.PageIterator<Subscription<Options.FeaturePropertyOptions>> featurePropertyEventSubscriptions(int pageSize)
EventSubscriptions
featurePropertyEventSubscriptions
in interface EventSubscriptions
pageSize
- the number of subscriptions returned within a pagedefault com.bosch.iot.dm.util.PageIterator<Subscription<Options.DeviceStatusOptions>> deviceStatusEventSubscriptions(int pageSize)
EventSubscriptions
deviceStatusEventSubscriptions
in interface EventSubscriptions
pageSize
- the number of subscriptions returned within a pagedefault com.bosch.iot.dm.util.PageIterator<Subscription<List<FilterEntryEvent.Type>>> filterEntryEventSubscriptions(int pageSize)
FilterInventory
filterEntryEventSubscriptions
in interface FilterInventory
pageSize
- the number of subscriptions returned within a pagedefault com.bosch.iot.dm.util.PageIterator<Subscription<List<DirectoryEvent.Type>>> directoryEventSubscriptions(int pageSize)
DirectoryInventory
directoryEventSubscriptions
in interface DirectoryInventory
pageSize
- the number of subscriptions returned within a pagedefault com.bosch.iot.dm.util.PageIterator<Subscription<List<TagEvent.Type>>> tagEventSubscriptions(int pageSize)
TagInventory
tagEventSubscriptions
in interface TagInventory
pageSize
- the number of subscriptions returned within a pagedefault com.bosch.iot.dm.util.PageIterator<Subscription<Options.UploadRequestOptions>> uploadRequestEventSubscriptions(int pageSize)
EventSubscriptions
uploadRequestEventSubscriptions
in interface EventSubscriptions
pageSize
- the number of subscriptions returned within a pagedefault com.bosch.iot.dm.util.PageIterator<Subscription<Options.LiveMessageOptions>> liveMessagesSubscriptions(int pageSize)
EventSubscriptions
liveMessagesSubscriptions
in interface EventSubscriptions
pageSize
- the number of subscriptions returned within a page<O> void subscriptions(String sourceType, StreamConsumer<Subscription<O>> consumer)
default <O> com.bosch.iot.dm.util.PageIterator<Subscription<O>> subscriptions(String sourceType, int pageSize)
Copyright © 2022 Bosch.IO GmbH. All rights reserved.