Skip to content

Commit acd830c

Browse files
ViacheslavKlimovViacheslavKlimov
committed
Update tb-examples.md for new EntityId model structure
Nested enums were extracted to standalone enums (EntityId.EntityTypeEnum → EntityType, Alarm.SeverityEnum → AlarmSeverity, EntityRelation.TypeGroupEnum → RelationTypeGroup) and EntityId now has typed subclasses (DeviceId, AssetId, etc.) with Jackson discriminator polymorphism, making .entityType() calls redundant when constructing ID objects.
1 parent a509a3c commit acd830c

4 files changed

Lines changed: 36 additions & 52 deletions

File tree

‎ce/docs/tb-examples.md‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ tb.deleteEntityTimeseries("DEVICE", deviceId,
152152
// Create an alarm
153153
Alarm alarm = new Alarm();
154154
alarm.setType("High Temperature");
155-
alarm.setOriginator(new EntityId().entityType(EntityId.EntityTypeEnum.DEVICE).id(deviceId));
156-
alarm.setSeverity(Alarm.SeverityEnum.CRITICAL);
155+
alarm.setOriginator(new DeviceId().id(deviceId));
156+
alarm.setSeverity(AlarmSeverity.CRITICAL);
157157
Alarm saved = tb.saveAlarm(alarm);
158158

159159
// Get alarm by ID
@@ -171,10 +171,10 @@ tb.clearAlarm(alarmId);
171171
```java
172172
// Create a relation
173173
EntityRelation relation = new EntityRelation();
174-
relation.setFrom(new EntityId().entityType(EntityId.EntityTypeEnum.ASSET).id(assetId));
175-
relation.setTo(new EntityId().entityType(EntityId.EntityTypeEnum.DEVICE).id(deviceId));
174+
relation.setFrom(new AssetId().id(assetId));
175+
relation.setTo(new DeviceId().id(deviceId));
176176
relation.setType("Contains");
177-
relation.setTypeGroup(EntityRelation.TypeGroupEnum.COMMON);
177+
relation.setTypeGroup(RelationTypeGroup.COMMON);
178178
tb.saveRelation(relation);
179179
```
180180

@@ -268,12 +268,9 @@ List<Role> roles = page.getData();
268268
```java
269269
// Grant a user group access to an entity group via a role
270270
GroupPermission gp = new GroupPermission();
271-
gp.setUserGroupId(new EntityGroupId()
272-
.id(UUID.fromString(userGroupId)).entityType(EntityType.ENTITY_GROUP));
273-
gp.setEntityGroupId(new EntityGroupId()
274-
.id(UUID.fromString(deviceGroupId)).entityType(EntityType.ENTITY_GROUP));
275-
gp.setRoleId(new RoleId()
276-
.id(UUID.fromString(roleId)).entityType(EntityType.ROLE));
271+
gp.setUserGroupId(new EntityGroupId().id(UUID.fromString(userGroupId)));
272+
gp.setEntityGroupId(new EntityGroupId().id(UUID.fromString(deviceGroupId)));
273+
gp.setRoleId(new RoleId().id(UUID.fromString(roleId)));
277274
GroupPermission saved = tb.saveGroupPermission(gp);
278275

279276
// List permissions for an entity group
@@ -327,8 +324,7 @@ String userGroupId = allUsers.getId().getId().toString();
327324
User user = new User();
328325
user.setEmail("operator@acme-west.com");
329326
user.setAuthority(Authority.CUSTOMER_USER);
330-
user.setCustomerId(new CustomerId()
331-
.id(UUID.fromString(subId)).entityType(EntityType.CUSTOMER));
327+
user.setCustomerId(new CustomerId().id(UUID.fromString(subId)));
332328
User savedUser = tb.saveUser(user, "false", userGroupId, null);
333329

334330
// List users in a user group (paginated)

‎common/docs/tb-examples.md‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ tb.deleteEntityTimeseries("DEVICE", deviceId,
152152
// Create an alarm
153153
Alarm alarm = new Alarm();
154154
alarm.setType("High Temperature");
155-
alarm.setOriginator(new EntityId().entityType(EntityId.EntityTypeEnum.DEVICE).id(deviceId));
156-
alarm.setSeverity(Alarm.SeverityEnum.CRITICAL);
155+
alarm.setOriginator(new DeviceId().id(deviceId));
156+
alarm.setSeverity(AlarmSeverity.CRITICAL);
157157
Alarm saved = tb.saveAlarm(alarm);
158158

159159
// Get alarm by ID
@@ -171,10 +171,10 @@ tb.clearAlarm(alarmId);
171171
```java
172172
// Create a relation
173173
EntityRelation relation = new EntityRelation();
174-
relation.setFrom(new EntityId().entityType(EntityId.EntityTypeEnum.ASSET).id(assetId));
175-
relation.setTo(new EntityId().entityType(EntityId.EntityTypeEnum.DEVICE).id(deviceId));
174+
relation.setFrom(new AssetId().id(assetId));
175+
relation.setTo(new DeviceId().id(deviceId));
176176
relation.setType("Contains");
177-
relation.setTypeGroup(EntityRelation.TypeGroupEnum.COMMON);
177+
relation.setTypeGroup(RelationTypeGroup.COMMON);
178178
tb.saveRelation(relation);
179179
```
180180

@@ -268,12 +268,9 @@ List<Role> roles = page.getData();
268268
```java
269269
// Grant a user group access to an entity group via a role
270270
GroupPermission gp = new GroupPermission();
271-
gp.setUserGroupId(new EntityGroupId()
272-
.id(UUID.fromString(userGroupId)).entityType(EntityType.ENTITY_GROUP));
273-
gp.setEntityGroupId(new EntityGroupId()
274-
.id(UUID.fromString(deviceGroupId)).entityType(EntityType.ENTITY_GROUP));
275-
gp.setRoleId(new RoleId()
276-
.id(UUID.fromString(roleId)).entityType(EntityType.ROLE));
271+
gp.setUserGroupId(new EntityGroupId().id(UUID.fromString(userGroupId)));
272+
gp.setEntityGroupId(new EntityGroupId().id(UUID.fromString(deviceGroupId)));
273+
gp.setRoleId(new RoleId().id(UUID.fromString(roleId)));
277274
GroupPermission saved = tb.saveGroupPermission(gp);
278275

279276
// List permissions for an entity group
@@ -327,8 +324,7 @@ String userGroupId = allUsers.getId().getId().toString();
327324
User user = new User();
328325
user.setEmail("operator@acme-west.com");
329326
user.setAuthority(Authority.CUSTOMER_USER);
330-
user.setCustomerId(new CustomerId()
331-
.id(UUID.fromString(subId)).entityType(EntityType.CUSTOMER));
327+
user.setCustomerId(new CustomerId().id(UUID.fromString(subId)));
332328
User savedUser = tb.saveUser(user, "false", userGroupId, null);
333329

334330
// List users in a user group (paginated)

‎paas/docs/tb-examples.md‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ tb.deleteEntityTimeseries("DEVICE", deviceId,
152152
// Create an alarm
153153
Alarm alarm = new Alarm();
154154
alarm.setType("High Temperature");
155-
alarm.setOriginator(new EntityId().entityType(EntityId.EntityTypeEnum.DEVICE).id(deviceId));
156-
alarm.setSeverity(Alarm.SeverityEnum.CRITICAL);
155+
alarm.setOriginator(new DeviceId().id(deviceId));
156+
alarm.setSeverity(AlarmSeverity.CRITICAL);
157157
Alarm saved = tb.saveAlarm(alarm);
158158

159159
// Get alarm by ID
@@ -171,10 +171,10 @@ tb.clearAlarm(alarmId);
171171
```java
172172
// Create a relation
173173
EntityRelation relation = new EntityRelation();
174-
relation.setFrom(new EntityId().entityType(EntityId.EntityTypeEnum.ASSET).id(assetId));
175-
relation.setTo(new EntityId().entityType(EntityId.EntityTypeEnum.DEVICE).id(deviceId));
174+
relation.setFrom(new AssetId().id(assetId));
175+
relation.setTo(new DeviceId().id(deviceId));
176176
relation.setType("Contains");
177-
relation.setTypeGroup(EntityRelation.TypeGroupEnum.COMMON);
177+
relation.setTypeGroup(RelationTypeGroup.COMMON);
178178
tb.saveRelation(relation);
179179
```
180180

@@ -268,12 +268,9 @@ List<Role> roles = page.getData();
268268
```java
269269
// Grant a user group access to an entity group via a role
270270
GroupPermission gp = new GroupPermission();
271-
gp.setUserGroupId(new EntityGroupId()
272-
.id(UUID.fromString(userGroupId)).entityType(EntityType.ENTITY_GROUP));
273-
gp.setEntityGroupId(new EntityGroupId()
274-
.id(UUID.fromString(deviceGroupId)).entityType(EntityType.ENTITY_GROUP));
275-
gp.setRoleId(new RoleId()
276-
.id(UUID.fromString(roleId)).entityType(EntityType.ROLE));
271+
gp.setUserGroupId(new EntityGroupId().id(UUID.fromString(userGroupId)));
272+
gp.setEntityGroupId(new EntityGroupId().id(UUID.fromString(deviceGroupId)));
273+
gp.setRoleId(new RoleId().id(UUID.fromString(roleId)));
277274
GroupPermission saved = tb.saveGroupPermission(gp);
278275

279276
// List permissions for an entity group
@@ -327,8 +324,7 @@ String userGroupId = allUsers.getId().getId().toString();
327324
User user = new User();
328325
user.setEmail("operator@acme-west.com");
329326
user.setAuthority(Authority.CUSTOMER_USER);
330-
user.setCustomerId(new CustomerId()
331-
.id(UUID.fromString(subId)).entityType(EntityType.CUSTOMER));
327+
user.setCustomerId(new CustomerId().id(UUID.fromString(subId)));
332328
User savedUser = tb.saveUser(user, "false", userGroupId, null);
333329

334330
// List users in a user group (paginated)

‎pe/docs/tb-examples.md‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ tb.deleteEntityTimeseries("DEVICE", deviceId,
152152
// Create an alarm
153153
Alarm alarm = new Alarm();
154154
alarm.setType("High Temperature");
155-
alarm.setOriginator(new EntityId().entityType(EntityId.EntityTypeEnum.DEVICE).id(deviceId));
156-
alarm.setSeverity(Alarm.SeverityEnum.CRITICAL);
155+
alarm.setOriginator(new DeviceId().id(deviceId));
156+
alarm.setSeverity(AlarmSeverity.CRITICAL);
157157
Alarm saved = tb.saveAlarm(alarm);
158158

159159
// Get alarm by ID
@@ -171,10 +171,10 @@ tb.clearAlarm(alarmId);
171171
```java
172172
// Create a relation
173173
EntityRelation relation = new EntityRelation();
174-
relation.setFrom(new EntityId().entityType(EntityId.EntityTypeEnum.ASSET).id(assetId));
175-
relation.setTo(new EntityId().entityType(EntityId.EntityTypeEnum.DEVICE).id(deviceId));
174+
relation.setFrom(new AssetId().id(assetId));
175+
relation.setTo(new DeviceId().id(deviceId));
176176
relation.setType("Contains");
177-
relation.setTypeGroup(EntityRelation.TypeGroupEnum.COMMON);
177+
relation.setTypeGroup(RelationTypeGroup.COMMON);
178178
tb.saveRelation(relation);
179179
```
180180

@@ -268,12 +268,9 @@ List<Role> roles = page.getData();
268268
```java
269269
// Grant a user group access to an entity group via a role
270270
GroupPermission gp = new GroupPermission();
271-
gp.setUserGroupId(new EntityGroupId()
272-
.id(UUID.fromString(userGroupId)).entityType(EntityType.ENTITY_GROUP));
273-
gp.setEntityGroupId(new EntityGroupId()
274-
.id(UUID.fromString(deviceGroupId)).entityType(EntityType.ENTITY_GROUP));
275-
gp.setRoleId(new RoleId()
276-
.id(UUID.fromString(roleId)).entityType(EntityType.ROLE));
271+
gp.setUserGroupId(new EntityGroupId().id(UUID.fromString(userGroupId)));
272+
gp.setEntityGroupId(new EntityGroupId().id(UUID.fromString(deviceGroupId)));
273+
gp.setRoleId(new RoleId().id(UUID.fromString(roleId)));
277274
GroupPermission saved = tb.saveGroupPermission(gp);
278275

279276
// List permissions for an entity group
@@ -327,8 +324,7 @@ String userGroupId = allUsers.getId().getId().toString();
327324
User user = new User();
328325
user.setEmail("operator@acme-west.com");
329326
user.setAuthority(Authority.CUSTOMER_USER);
330-
user.setCustomerId(new CustomerId()
331-
.id(UUID.fromString(subId)).entityType(EntityType.CUSTOMER));
327+
user.setCustomerId(new CustomerId().id(UUID.fromString(subId)));
332328
User savedUser = tb.saveUser(user, "false", userGroupId, null);
333329

334330
// List users in a user group (paginated)

0 commit comments

Comments
 (0)