Skip to content

Commit f1471cc

Browse files
committed
updated jobs client
1 parent 5d15262 commit f1471cc

23 files changed

Lines changed: 261 additions & 208 deletions

jobs/include/aws/iotjobs/DescribeJobExecutionRequest.h

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,29 +37,32 @@ namespace Aws
3737
Aws::Crt::Optional<Aws::Crt::String> ThingName;
3838

3939
/**
40-
* The unique identifier assigned to this job when it was created. Or use $next to return the next pending
41-
* job execution for a thing (status IN_PROGRESS or QUEUED). In this case, any job executions with status
42-
* IN_PROGRESS are returned first. Job executions are returned in the order in which they were created.
40+
* The unique identifier assigned to this job when it was created. Or use
41+
* $next to return the next pending job execution for a thing (status
42+
* IN_PROGRESS or QUEUED). In this case, any job executions with status
43+
* IN_PROGRESS are returned first. Job executions are returned in the order in
44+
* which they were created.
4345
*
4446
*/
4547
Aws::Crt::Optional<Aws::Crt::String> JobId;
4648

4749
/**
48-
* An opaque string used to correlate requests and responses. Enter an arbitrary value here and it is
49-
* reflected in the response.
50+
* An opaque string used to correlate requests and responses. Enter an
51+
* arbitrary value here and it is reflected in the response.
5052
*
5153
*/
5254
Aws::Crt::Optional<Aws::Crt::String> ClientToken;
5355

5456
/**
55-
* Optional. A number that identifies a job execution on a device. If not specified, the latest job
56-
* execution is returned.
57+
* Optional. A number that identifies a job execution on a device. If not
58+
* specified, the latest job execution is returned.
5759
*
5860
*/
5961
Aws::Crt::Optional<int64_t> ExecutionNumber;
6062

6163
/**
62-
* Optional. Unless set to false, the response contains the job document. The default is true.
64+
* Optional. Unless set to false, the response contains the job document. The
65+
* default is true.
6366
*
6467
*/
6568
Aws::Crt::Optional<bool> IncludeJobDocument;

jobs/include/aws/iotjobs/DescribeJobExecutionSubscriptionRequest.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,15 @@ namespace Aws
3131
void SerializeToObject(Crt::JsonObject &doc) const;
3232

3333
/**
34-
* Name of the IoT Thing that you want to subscribe to DescribeJobExecution response events for.
34+
* Name of the IoT Thing that you want to subscribe to DescribeJobExecution
35+
* response events for.
3536
*
3637
*/
3738
Aws::Crt::Optional<Aws::Crt::String> ThingName;
3839

3940
/**
40-
* Job ID that you want to subscribe to DescribeJobExecution response events for.
41+
* Job ID that you want to subscribe to DescribeJobExecution response events
42+
* for.
4143
*
4244
*/
4345
Aws::Crt::Optional<Aws::Crt::String> JobId;

jobs/include/aws/iotjobs/Exports.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@
1818

1919
#else /* defined (AWS_IOTJOBS_USE_WINDOWS_DLL_SEMANTICS) || defined (WIN32) */
2020
# define AWS_IOTJOBS_API
21-
#endif /* defined (AWS_IOTJOBS__USE_WINDOWS_DLL_SEMANTICS) || defined (WIN32) */
21+
#endif /* defined (AWS_IOTJOBS__USE_WINDOWS_DLL_SEMANTICS) || defined (WIN32) \
22+
*/

jobs/include/aws/iotjobs/GetPendingJobExecutionsRequest.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ namespace Aws
3737
Aws::Crt::Optional<Aws::Crt::String> ThingName;
3838

3939
/**
40-
* Optional. A client token used to correlate requests and responses. Enter an arbitrary value here and it
41-
* is reflected in the response.
40+
* Optional. A client token used to correlate requests and responses. Enter an
41+
* arbitrary value here and it is reflected in the response.
4242
*
4343
*/
4444
Aws::Crt::Optional<Aws::Crt::String> ClientToken;

jobs/include/aws/iotjobs/GetPendingJobExecutionsSubscriptionRequest.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ namespace Aws
3131
void SerializeToObject(Crt::JsonObject &doc) const;
3232

3333
/**
34-
* Name of the IoT Thing that you want to subscribe to GetPendingJobExecutions response events for.
34+
* Name of the IoT Thing that you want to subscribe to GetPendingJobExecutions
35+
* response events for.
3536
*
3637
*/
3738
Aws::Crt::Optional<Aws::Crt::String> ThingName;

jobs/include/aws/iotjobs/IotJobsClient.h

Lines changed: 127 additions & 79 deletions
Large diffs are not rendered by default.

jobs/include/aws/iotjobs/IotJobsClientV2.h

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ namespace Aws
9595
using UpdateJobExecutionResultHandler = std::function<void(UpdateJobExecutionResult &&)>;
9696

9797
/**
98-
* The AWS IoT jobs service can be used to define a set of remote operations that are sent to and executed on
99-
* one or more devices connected to AWS IoT.
98+
* The AWS IoT jobs service can be used to define a set of remote operations
99+
* that are sent to and executed on one or more devices connected to AWS IoT.
100100
*
101101
* https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#jobs-mqtt-api
102102
*
@@ -139,7 +139,8 @@ namespace Aws
139139
const GetPendingJobExecutionsResultHandler &handler) = 0;
140140

141141
/**
142-
* Gets and starts the next pending job execution for a thing (status IN_PROGRESS or QUEUED).
142+
* Gets and starts the next pending job execution for a thing (status
143+
* IN_PROGRESS or QUEUED).
143144
*
144145
*
145146
* AWS documentation:
@@ -155,9 +156,10 @@ namespace Aws
155156
const StartNextPendingJobExecutionResultHandler &handler) = 0;
156157

157158
/**
158-
* Updates the status of a job execution. You can optionally create a step timer by setting a value for the
159-
* stepTimeoutInMinutes property. If you don't update the value of this property by running
160-
* UpdateJobExecution again, the job execution times out when the step timer expires.
159+
* Updates the status of a job execution. You can optionally create a step
160+
* timer by setting a value for the stepTimeoutInMinutes property. If you
161+
* don't update the value of this property by running UpdateJobExecution
162+
* again, the job execution times out when the step timer expires.
161163
*
162164
*
163165
* AWS documentation:
@@ -173,17 +175,18 @@ namespace Aws
173175
const UpdateJobExecutionResultHandler &handler) = 0;
174176

175177
/**
176-
* Creates a stream of JobExecutionsChanged notifications for a given IoT thing.
178+
* Creates a stream of JobExecutionsChanged notifications for a given IoT
179+
* thing.
177180
*
178181
*
179182
* AWS documentation:
180183
* https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-jobexecutionschanged
181184
*
182-
* @param request Modeled streaming operation subscription configuration.
183-
* @param options Configuration options for the streaming operation.
185+
* @param request modeled streaming operation subscription configuration
186+
* @param options
184187
*
185-
* @return A streaming operation which will emit a modeled event every time a message is received on the
186-
* associated MQTT topic.
188+
* @return a streaming operation which will emit a modeled event every time a
189+
* message is received on the associated MQTT topic
187190
*/
188191
virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> CreateJobExecutionsChangedStream(
189192
const JobExecutionsChangedSubscriptionRequest &request,
@@ -196,11 +199,11 @@ namespace Aws
196199
* AWS documentation:
197200
* https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-nextjobexecutionchanged
198201
*
199-
* @param request Modeled streaming operation subscription configuration.
200-
* @param options Configuration options for the streaming operation.
202+
* @param request modeled streaming operation subscription configuration
203+
* @param options
201204
*
202-
* @return A streaming operation which will emit a modeled event every time a message is received on the
203-
* associated MQTT topic.
205+
* @return a streaming operation which will emit a modeled event every time a
206+
* message is received on the associated MQTT topic
204207
*/
205208
virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> CreateNextJobExecutionChangedStream(
206209
const NextJobExecutionChangedSubscriptionRequest &request,

jobs/include/aws/iotjobs/JobExecutionData.h

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,15 @@ namespace Aws
5353
Aws::Crt::Optional<Aws::Crt::JsonObject> JobDocument;
5454

5555
/**
56-
* The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED,
57-
* TIMED_OUT, REJECTED, or REMOVED.
56+
* The status of the job execution. Can be one of: QUEUED, IN_PROGRESS,
57+
* FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.
5858
*
5959
*/
6060
Aws::Crt::Optional<Aws::Iotjobs::JobStatus> Status;
6161

6262
/**
63-
* A collection of name-value pairs that describe the status of the job execution.
63+
* A collection of name-value pairs that describe the status of the job
64+
* execution.
6465
*
6566
*/
6667
Aws::Crt::Optional<Aws::Crt::Map<Aws::Crt::String, Aws::Crt::String>> StatusDetails;
@@ -84,15 +85,15 @@ namespace Aws
8485
Aws::Crt::Optional<Aws::Crt::DateTime> LastUpdatedAt;
8586

8687
/**
87-
* The version of the job execution. Job execution versions are incremented each time they are updated by a
88-
* device.
88+
* The version of the job execution. Job execution versions are incremented
89+
* each time they are updated by a device.
8990
*
9091
*/
9192
Aws::Crt::Optional<int32_t> VersionNumber;
9293

9394
/**
94-
* A number that identifies a job execution on a device. It can be used later in commands that return or
95-
* update job execution information.
95+
* A number that identifies a job execution on a device. It can be used later
96+
* in commands that return or update job execution information.
9697
*
9798
*/
9899
Aws::Crt::Optional<int64_t> ExecutionNumber;

jobs/include/aws/iotjobs/JobExecutionState.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,22 @@ namespace Aws
3333
void SerializeToObject(Crt::JsonObject &doc) const;
3434

3535
/**
36-
* The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED,
37-
* TIMED_OUT, REJECTED, or REMOVED.
36+
* The status of the job execution. Can be one of: QUEUED, IN_PROGRESS,
37+
* FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.
3838
*
3939
*/
4040
Aws::Crt::Optional<Aws::Iotjobs::JobStatus> Status;
4141

4242
/**
43-
* A collection of name-value pairs that describe the status of the job execution.
43+
* A collection of name-value pairs that describe the status of the job
44+
* execution.
4445
*
4546
*/
4647
Aws::Crt::Optional<Aws::Crt::Map<Aws::Crt::String, Aws::Crt::String>> StatusDetails;
4748

4849
/**
49-
* The version of the job execution. Job execution versions are incremented each time they are updated by a
50-
* device.
50+
* The version of the job execution. Job execution versions are incremented
51+
* each time they are updated by a device.
5152
*
5253
*/
5354
Aws::Crt::Optional<int32_t> VersionNumber;

jobs/include/aws/iotjobs/JobExecutionSummary.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ namespace Aws
4545
Aws::Crt::Optional<int64_t> ExecutionNumber;
4646

4747
/**
48-
* The version of the job execution. Job execution versions are incremented each time the AWS IoT Jobs
49-
* service receives an update from a device.
48+
* The version of the job execution. Job execution versions are incremented
49+
* each time the AWS IoT Jobs service receives an update from a device.
5050
*
5151
*/
5252
Aws::Crt::Optional<int32_t> VersionNumber;

0 commit comments

Comments
 (0)