Skip to content

Commit 1a2e1b5

Browse files
Update documentation for generated models (#318)
Update the documentation for all the generated models.
1 parent 9dcbdd8 commit 1a2e1b5

File tree

6 files changed

+60
-2
lines changed

6 files changed

+60
-2
lines changed

sdk/src/main/java/software/amazon/awssdk/iot/iotidentity/IotIdentityClient.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ public class IotIdentityClient {
4646
private MqttClientConnection connection = null;
4747
private final Gson gson = getGson();
4848

49+
/**
50+
* Constructs a new IotIdentityClient
51+
* @param connection The connection to use
52+
*/
4953
public IotIdentityClient(MqttClientConnection connection) {
5054
this.connection = connection;
5155
}

sdk/src/main/java/software/amazon/awssdk/iot/iotjobs/IotJobsClient.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ public class IotJobsClient {
5959
private MqttClientConnection connection = null;
6060
private final Gson gson = getGson();
6161

62+
/**
63+
* Constructs a new IotJobsClient
64+
* @param connection The connection to use
65+
*/
6266
public IotJobsClient(MqttClientConnection connection) {
6367
this.connection = connection;
6468
}
@@ -282,7 +286,6 @@ public CompletableFuture<Integer> SubscribeToDescribeJobExecutionRejected(
282286
}
283287

284288
/**
285-
*
286289
*
287290
* Once subscribed, `handler` is invoked each time a message matching
288291
* the `topic` is received. It is possible for such messages to arrive before
@@ -325,7 +328,6 @@ public CompletableFuture<Integer> SubscribeToNextJobExecutionChangedEvents(
325328
}
326329

327330
/**
328-
*
329331
*
330332
* Once subscribed, `handler` is invoked each time a message matching
331333
* the `topic` is received. It is possible for such messages to arrive before

sdk/src/main/java/software/amazon/awssdk/iot/iotjobs/model/JobStatus.java

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,49 @@
1313
*/
1414
public enum JobStatus {
1515

16+
/**
17+
* Enum value is an unknown value
18+
*/
1619
UNKNOWN_ENUM_VALUE("UNKNOWN_ENUM_VALUE"),
1720

21+
/**
22+
* Enum value for IN_PROGRESS
23+
*/
1824
IN_PROGRESS("IN_PROGRESS"),
1925

26+
/**
27+
* Enum value for FAILED
28+
*/
2029
FAILED("FAILED"),
2130

31+
/**
32+
* Enum value for QUEUED
33+
*/
2234
QUEUED("QUEUED"),
2335

36+
/**
37+
* Enum value for TIMED_OUT
38+
*/
2439
TIMED_OUT("TIMED_OUT"),
2540

41+
/**
42+
* Enum value for SUCCEEDED
43+
*/
2644
SUCCEEDED("SUCCEEDED"),
2745

46+
/**
47+
* Enum value for CANCELED
48+
*/
2849
CANCELED("CANCELED"),
2950

51+
/**
52+
* Enum value for REJECTED
53+
*/
3054
REJECTED("REJECTED"),
3155

56+
/**
57+
* Enum value for REMOVED
58+
*/
3259
REMOVED("REMOVED");
3360

3461
private String value;
@@ -42,6 +69,12 @@ public String toString() {
4269
return value;
4370
}
4471

72+
/**
73+
* Returns The enum associated with the given string or UNKNOWN_ENUM_VALUE
74+
* if no enum is found.
75+
* @param val The string to use
76+
* @return The enum associated with the string or UNKNOWN_ENUM_VALUE
77+
*/
4578
static JobStatus fromString(String val) {
4679
for (JobStatus e : JobStatus.class.getEnumConstants()) {
4780
if (e.toString().compareTo(val) == 0) {

sdk/src/main/java/software/amazon/awssdk/iot/iotjobs/model/RejectedErrorCode.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
*/
1414
public enum RejectedErrorCode {
1515

16+
/**
17+
* Enum value is an unknown value
18+
*/
1619
UNKNOWN_ENUM_VALUE("UNKNOWN_ENUM_VALUE"),
1720

1821
/**
@@ -71,6 +74,12 @@ public String toString() {
7174
return value;
7275
}
7376

77+
/**
78+
* Returns The enum associated with the given string or UNKNOWN_ENUM_VALUE
79+
* if no enum is found.
80+
* @param val The string to use
81+
* @return The enum associated with the string or UNKNOWN_ENUM_VALUE
82+
*/
7483
static RejectedErrorCode fromString(String val) {
7584
for (RejectedErrorCode e : RejectedErrorCode.class.getEnumConstants()) {
7685
if (e.toString().compareTo(val) == 0) {

sdk/src/main/java/software/amazon/awssdk/iot/iotshadow/IotShadowClient.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ public class IotShadowClient {
6565
private MqttClientConnection connection = null;
6666
private final Gson gson = getGson();
6767

68+
/**
69+
* Constructs a new IotShadowClient
70+
* @param connection The connection to use
71+
*/
6872
public IotShadowClient(MqttClientConnection connection) {
6973
this.connection = connection;
7074
}

sdk/src/main/java/software/amazon/awssdk/iot/iotshadow/model/ShadowState.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ public class ShadowState {
2121
*/
2222
public HashMap<String, Object> desired;
2323

24+
/**
25+
* If set to true, then desired can be set to null.
26+
*/
2427
public transient boolean desiredIsNullable;
2528

2629
/**
@@ -29,6 +32,9 @@ public class ShadowState {
2932
*/
3033
public HashMap<String, Object> reported;
3134

35+
/**
36+
* If set to true, then reported can be set to null.
37+
*/
3238
public transient boolean reportedIsNullable;
3339

3440
}

0 commit comments

Comments
 (0)