Skip to content

Commit cd1405a

Browse files
Merge pull request #79 from thingsboard/request-object-args
Wrap operation parameters in per-operation Args request objects
2 parents 29553de + dc31b93 commit cd1405a

242 files changed

Lines changed: 173619 additions & 2165 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,17 @@ Replace `thingsboard-ce-client` with `thingsboard-pe-client` or `thingsboard-paa
3131

3232
```java
3333
import org.thingsboard.client.ThingsboardClient;
34+
import org.thingsboard.client.api.ThingsboardApi.GetTenantDevicesArgs;
3435

3536
// Credentials — logs in automatically, refreshes tokens before expiry
3637
ThingsboardClient client = ThingsboardClient.builder()
3738
.url("http://localhost:8080")
3839
.credentials("tenant@thingsboard.org", "tenant")
3940
.build();
4041

41-
var devices = client.getTenantDevices(10, 0, null, null, null, null);
42+
// Endpoints with parameters take a single <Method>Args request object built with a builder;
43+
// only required fields must be set, optional ones can be omitted.
44+
var devices = client.getTenantDevices(GetTenantDevicesArgs.builder().pageSize(10).page(0).build());
4245
```
4346

4447
### API Key Authentication
@@ -49,7 +52,7 @@ ThingsboardClient client = ThingsboardClient.builder()
4952
.apiKey("your-api-key")
5053
.build();
5154

52-
var devices = client.getTenantDevices(10, 0, null, null, null, null);
55+
var devices = client.getTenantDevices(GetTenantDevicesArgs.builder().pageSize(10).page(0).build());
5356
```
5457

5558
### Deferred Login

‎ce/docs/AdminControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
Boolean autoCommitSettingsExists() // Check auto commit settings exists (autoCommitSettingsExists)
713
void checkRepositoryAccess(@Nonnull RepositorySettings repositorySettings) // Check repository access (checkRepositoryAccess)

‎ce/docs/AiModelControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
Boolean deleteAiModelById(@Nonnull UUID modelUuid) // Delete AI model by ID (deleteAiModelById)
713
AiModel getAiModelById(@Nonnull UUID modelUuid) // Get AI model by ID (getAiModelById)

‎ce/docs/AlarmCommentControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
void deleteAlarmComment(@Nonnull String alarmId, @Nonnull String commentId) // Delete Alarm comment (deleteAlarmComment)
713
PageDataAlarmCommentInfo getAlarmComments(@Nonnull String alarmId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String sortProperty, @Nullable String sortOrder) // Get Alarm comments (getAlarmComments)

‎ce/docs/AlarmControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
AlarmInfo ackAlarm(@Nonnull String alarmId) // Acknowledge Alarm (ackAlarm)
713
Alarm assignAlarm(@Nonnull String alarmId, @Nonnull String assigneeId) // Assign/Reassign Alarm (assignAlarm)

‎ce/docs/AlarmRuleControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
void deleteAlarmRule(@Nonnull String alarmRuleId) // Delete Alarm Rule (deleteAlarmRule)
713
AlarmRuleDefinition getAlarmRuleById(@Nonnull String alarmRuleId) // Get Alarm Rule (getAlarmRuleById)

‎ce/docs/ApiKeyControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
void deleteApiKey(@Nonnull UUID id) // Delete API key by ID (deleteApiKey)
713
ApiKeyInfo enableApiKey(@Nonnull UUID id, @Nonnull Boolean enabledValue) // Enable or disable API key (enableApiKey)

‎ce/docs/AssetControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
Asset assignAssetToCustomer(@Nonnull String customerId, @Nonnull String assetId) // Assign asset to customer (assignAssetToCustomer)
713
Asset assignAssetToEdge(@Nonnull String edgeId, @Nonnull String assetId) // Assign asset to edge (assignAssetToEdge)

‎ce/docs/AssetProfileControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
void deleteAssetProfile(@Nonnull String assetProfileId) // Delete asset profile (deleteAssetProfile)
713
AssetProfile getAssetProfileById(@Nonnull String assetProfileId, @Nullable Boolean inlineImages) // Get Asset Profile (getAssetProfileById)

‎ce/docs/AuditLogControllerApi.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
`ThingsboardClient` methods:
44

5+
> Every method that takes input also has a request-object overload — `<method>(<Method>Args args)`,
6+
> built via `<Method>Args.builder()...build()`. The `*Args` classes are nested in `ThingsboardApi`,
7+
> e.g. `import org.thingsboard.client.api.ThingsboardApi.SaveDeviceArgs;`. Prefer that overload in
8+
> new code: adding an optional parameter to an endpoint changes the flat signatures documented
9+
> below, but only adds a builder field to `*Args`.
10+
511
```
612
PageDataAuditLog getAuditLogs(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder, @Nullable Long startTime, @Nullable Long endTime, @Nullable String actionTypes) // Get all audit logs (getAuditLogs)
713
PageDataAuditLog getAuditLogsByCustomerId(@Nonnull String customerId, @Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder, @Nullable Long startTime, @Nullable Long endTime, @Nullable String actionTypes) // Get audit logs by customer id (getAuditLogsByCustomerId)

0 commit comments

Comments
 (0)