public class Tag extends GroupEntity
Modifier and Type | Class and Description |
---|---|
static class |
Tag.Builder<T extends Tag.Builder<T>> |
Jsonifiable.JsonMapper
name
attributes, remote
Modifier and Type | Method and Description |
---|---|
Optional<String> |
color()
Returns the color of this tag.
|
Optional<String> |
description()
Returns the description of this tag.
|
PageIterator<Device> |
devices(Filter filter,
int pageSize)
Returns a list of tagged devices matching the specified filter, divided into pages.
|
PageIterator<Device> |
devices(int pageSize)
Returns a list of tagged devices, divided into pages.
|
PageIterator<Gateway> |
gateways(Filter filter,
int pageSize)
Returns a list of tagged gateways matching the specified filter, divided into pages.
|
PageIterator<Gateway> |
gateways(int pageSize)
Returns a list of tagged gateways, divided into pages.
|
static Tag.Builder<?> |
newBuilder(DeviceInventoryRemote remote) |
CompletionStage<Void> |
setName(String name)
Change the name of this tag.
|
String |
toString() |
attribute, equals, hashCode, name
attributes, canonize, created, definition, deleteAttribute, deleteAttributes, identifier, modified, revision, setAttribute, setAttributes
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
toJsonString
public static Tag.Builder<?> newBuilder(DeviceInventoryRemote remote)
public Optional<String> description()
Returns the description of this tag.
It is kept in attributes under which is defined in ModelConstants.COLOR_PATH
.
For setting use Entity.setAttribute(Attribute)
. Attribute path should be ModelConstants.DESCRIPTION_PATH
.
Optional
containing the description of this tagpublic Optional<String> color()
Returns the color of this tag.
It is kept in attributes under which is defined in ModelConstants.COLOR_PATH
.
For setting use Entity.setAttribute(Attribute)
, attribute path should be ModelConstants.COLOR_PATH
.
Color format should be case insensitive Hexadecimal RGB color code (#RRGGBB).
Note: No color format validation is applied
Optional
containing the color of this tagpublic PageIterator<Device> devices(int pageSize)
pageSize
- the page sizePageIterator
providing a list of tagged devices, divided into pagespublic PageIterator<Device> devices(Filter filter, int pageSize)
filter
- the filter to match againstpageSize
- the page sizePageIterator
providing a list of tagged devices, divided into pagespublic PageIterator<Gateway> gateways(int pageSize)
pageSize
- the page sizePageIterator
providing a list of tagged gateways, divided into pagespublic PageIterator<Gateway> gateways(Filter filter, int pageSize)
filter
- the filter to match againstpageSize
- the page sizePageIterator
providing a list of tagged gateways, divided into pagespublic CompletionStage<Void> setName(String name)
name
- the new name for the tagCompletionStage
providing the result of the operationCopyright © 2022 Bosch.IO GmbH. All rights reserved.