File Coverage

blib/lib/Paws/SimpleWorkflow/ActivityTaskScheduledEventAttributes.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::SimpleWorkflow::ActivityTaskScheduledEventAttributes;
2 1     1   487 use Moose;
  1         3  
  1         10  
3             has ActivityId => (is => 'ro', isa => 'Str', request_name => 'activityId', traits => ['NameInRequest'], required => 1);
4             has ActivityType => (is => 'ro', isa => 'Paws::SimpleWorkflow::ActivityType', request_name => 'activityType', traits => ['NameInRequest'], required => 1);
5             has Control => (is => 'ro', isa => 'Str', request_name => 'control', traits => ['NameInRequest']);
6             has DecisionTaskCompletedEventId => (is => 'ro', isa => 'Int', request_name => 'decisionTaskCompletedEventId', traits => ['NameInRequest'], required => 1);
7             has HeartbeatTimeout => (is => 'ro', isa => 'Str', request_name => 'heartbeatTimeout', traits => ['NameInRequest']);
8             has Input => (is => 'ro', isa => 'Str', request_name => 'input', traits => ['NameInRequest']);
9             has ScheduleToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'scheduleToCloseTimeout', traits => ['NameInRequest']);
10             has ScheduleToStartTimeout => (is => 'ro', isa => 'Str', request_name => 'scheduleToStartTimeout', traits => ['NameInRequest']);
11             has StartToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'startToCloseTimeout', traits => ['NameInRequest']);
12             has TaskList => (is => 'ro', isa => 'Paws::SimpleWorkflow::TaskList', request_name => 'taskList', traits => ['NameInRequest'], required => 1);
13             has TaskPriority => (is => 'ro', isa => 'Str', request_name => 'taskPriority', traits => ['NameInRequest']);
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::SimpleWorkflow::ActivityTaskScheduledEventAttributes
21              
22             =head1 USAGE
23              
24             This class represents one of two things:
25              
26             =head3 Arguments in a call to a service
27              
28             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29             Each attribute should be used as a named argument in the calls that expect this type of object.
30              
31             As an example, if Att1 is expected to be a Paws::SimpleWorkflow::ActivityTaskScheduledEventAttributes object:
32              
33             $service_obj->Method(Att1 => { ActivityId => $value, ..., TaskPriority => $value });
34              
35             =head3 Results returned from an API call
36              
37             Use accessors for each attribute. If Att1 is expected to be an Paws::SimpleWorkflow::ActivityTaskScheduledEventAttributes object:
38              
39             $result = $service_obj->Method(...);
40             $result->Att1->ActivityId
41              
42             =head1 DESCRIPTION
43              
44             Provides the details of the C<ActivityTaskScheduled> event.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 B<REQUIRED> ActivityId => Str
50              
51             The unique ID of the activity task.
52              
53              
54             =head2 B<REQUIRED> ActivityType => L<Paws::SimpleWorkflow::ActivityType>
55              
56             The type of the activity task.
57              
58              
59             =head2 Control => Str
60              
61             Data attached to the event that can be used by the decider in
62             subsequent workflow tasks. This data isn't sent to the activity.
63              
64              
65             =head2 B<REQUIRED> DecisionTaskCompletedEventId => Int
66              
67             The ID of the C<DecisionTaskCompleted> event corresponding to the
68             decision that resulted in the scheduling of this activity task. This
69             information can be useful for diagnosing problems by tracing back the
70             chain of events leading up to this event.
71              
72              
73             =head2 HeartbeatTimeout => Str
74              
75             The maximum time before which the worker processing this task must
76             report progress by calling RecordActivityTaskHeartbeat. If the timeout
77             is exceeded, the activity task is automatically timed out. If the
78             worker subsequently attempts to record a heartbeat or return a result,
79             it is ignored.
80              
81              
82             =head2 Input => Str
83              
84             The input provided to the activity task.
85              
86              
87             =head2 ScheduleToCloseTimeout => Str
88              
89             The maximum amount of time for this activity task.
90              
91              
92             =head2 ScheduleToStartTimeout => Str
93              
94             The maximum amount of time the activity task can wait to be assigned to
95             a worker.
96              
97              
98             =head2 StartToCloseTimeout => Str
99              
100             The maximum amount of time a worker may take to process the activity
101             task.
102              
103              
104             =head2 B<REQUIRED> TaskList => L<Paws::SimpleWorkflow::TaskList>
105              
106             The task list in which the activity task has been scheduled.
107              
108              
109             =head2 TaskPriority => Str
110              
111             The priority to assign to the scheduled activity task. If set, this
112             overrides any default priority value that was assigned when the
113             activity type was registered.
114              
115             Valid values are integers that range from Java's C<Integer.MIN_VALUE>
116             (-2147483648) to C<Integer.MAX_VALUE> (2147483647). Higher numbers
117             indicate higher priority.
118              
119             For more information about setting task priority, see Setting Task
120             Priority in the I<Amazon SWF Developer Guide>.
121              
122              
123              
124             =head1 SEE ALSO
125              
126             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
127              
128             =head1 BUGS and CONTRIBUTIONS
129              
130             The source code is located here: https://github.com/pplu/aws-sdk-perl
131              
132             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
133              
134             =cut
135