blib/lib/Paws/IoTJobsData/UpdateJobExecution.pm untested

filter: Statementstmt 0.0% 0 / 28 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 30 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::IoTJobsData::UpdateJobExecution;
3 use Moose;
4 has ExecutionNumber => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'executionNumber');
5 has ExpectedVersion => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'expectedVersion');
6 has IncludeJobDocument => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeJobDocument');
7 has IncludeJobExecutionState => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeJobExecutionState');
8 has JobId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'jobId', required => 1);
9 has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status', required => 1);
10 has StatusDetails => (is => 'ro', isa => 'Paws::IoTJobsData::DetailsMap', traits => ['NameInRequest'], request_name => 'statusDetails');
11 has StepTimeoutInMinutes => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'stepTimeoutInMinutes');
12 has ThingName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'thingName', required => 1);
13  
14 use MooseX::ClassAttribute;
15  
16 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateJobExecution');
17 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/things/{thingName}/jobs/{jobId}');
18 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTJobsData::UpdateJobExecutionResponse');
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::IoTJobsData::UpdateJobExecution - Arguments for method UpdateJobExecution on L<Paws::IoTJobsData>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method UpdateJobExecution on the
31 L<AWS IoT Jobs Data Plane|Paws::IoTJobsData> service. Use the attributes of this class
32 as arguments to method UpdateJobExecution.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateJobExecution.
35  
36 =head1 SYNOPSIS
37  
38 my $data.jobs.iot = Paws->service('IoTJobsData');
39 my $UpdateJobExecutionResponse = $data . jobs . iot->UpdateJobExecution(
40 JobId => 'MyJobId',
41 Status => 'QUEUED',
42 ThingName => 'MyThingName',
43 ExecutionNumber => 1, # OPTIONAL
44 ExpectedVersion => 1, # OPTIONAL
45 IncludeJobDocument => 1, # OPTIONAL
46 IncludeJobExecutionState => 1, # OPTIONAL
47 StatusDetails => {
48 'MyDetailsKey' =>
49 'MyDetailsValue', # key: min: 1, max: 128, value: min: 1, max: 1024
50 }, # OPTIONAL
51 StepTimeoutInMinutes => 1, # OPTIONAL
52 );
53  
54 # Results:
55 my $ExecutionState = $UpdateJobExecutionResponse->ExecutionState;
56 my $JobDocument = $UpdateJobExecutionResponse->JobDocument;
57  
58 # Returns a L<Paws::IoTJobsData::UpdateJobExecutionResponse> object.
59  
60 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
61 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/data.jobs.iot/UpdateJobExecution>
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 ExecutionNumber => Int
67  
68 Optional. A number that identifies a particular job execution on a
69 particular device.
70  
71  
72  
73 =head2 ExpectedVersion => Int
74  
75 Optional. The expected current version of the job execution. Each time
76 you update the job execution, its version is incremented. If the
77 version of the job execution stored in Jobs does not match, the update
78 is rejected with a VersionMismatch error, and an ErrorResponse that
79 contains the current job execution status data is returned. (This makes
80 it unnecessary to perform a separate DescribeJobExecution request in
81 order to obtain the job execution status data.)
82  
83  
84  
85 =head2 IncludeJobDocument => Bool
86  
87 Optional. When set to true, the response contains the job document. The
88 default is false.
89  
90  
91  
92 =head2 IncludeJobExecutionState => Bool
93  
94 Optional. When included and set to true, the response contains the
95 JobExecutionState data. The default is false.
96  
97  
98  
99 =head2 B<REQUIRED> JobId => Str
100  
101 The unique identifier assigned to this job when it was created.
102  
103  
104  
105 =head2 B<REQUIRED> Status => Str
106  
107 The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or
108 REJECTED). This must be specified on every update.
109  
110 Valid values are: C<"QUEUED">, C<"IN_PROGRESS">, C<"SUCCEEDED">, C<"FAILED">, C<"TIMED_OUT">, C<"REJECTED">, C<"REMOVED">, C<"CANCELED">
111  
112 =head2 StatusDetails => L<Paws::IoTJobsData::DetailsMap>
113  
114 Optional. A collection of name/value pairs that describe the status of
115 the job execution. If not specified, the statusDetails are unchanged.
116  
117  
118  
119 =head2 StepTimeoutInMinutes => Int
120  
121 Specifies the amount of time this device has to finish execution of
122 this job. If the job execution status is not set to a terminal state
123 before this timer expires, or before the timer is reset (by again
124 calling C<UpdateJobExecution>, setting the status to C<IN_PROGRESS> and
125 specifying a new timeout value in this field) the job execution status
126 will be automatically set to C<TIMED_OUT>. Note that setting or
127 resetting this timeout has no effect on that job execution timeout
128 which may have been specified when the job was created (C<CreateJob>
129 using field C<timeoutConfig>).
130  
131  
132  
133 =head2 B<REQUIRED> ThingName => Str
134  
135 The name of the thing associated with the device.
136  
137  
138  
139  
140 =head1 SEE ALSO
141  
142 This class forms part of L<Paws>, documenting arguments for method UpdateJobExecution in L<Paws::IoTJobsData>
143  
144 =head1 BUGS and CONTRIBUTIONS
145  
146 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
147  
148 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
149  
150 =cut
151