File Coverage

blib/lib/Paws/SimpleWorkflow/PollForDecisionTask.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SimpleWorkflow::PollForDecisionTask;
3 1     1   470 use Moose;
  1         3  
  1         9  
4             has Domain => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domain' , required => 1);
5             has Identity => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'identity' );
6             has MaximumPageSize => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maximumPageSize' );
7             has NextPageToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextPageToken' );
8             has ReverseOrder => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'reverseOrder' );
9             has TaskList => (is => 'ro', isa => 'Paws::SimpleWorkflow::TaskList', traits => ['NameInRequest'], request_name => 'taskList' , required => 1);
10              
11 1     1   6171 use MooseX::ClassAttribute;
  1         2  
  1         12  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PollForDecisionTask');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SimpleWorkflow::DecisionTask');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::SimpleWorkflow::PollForDecisionTask - Arguments for method PollForDecisionTask on Paws::SimpleWorkflow
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method PollForDecisionTask on the
27             Amazon Simple Workflow Service service. Use the attributes of this class
28             as arguments to method PollForDecisionTask.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PollForDecisionTask.
31              
32             As an example:
33              
34             $service_obj->PollForDecisionTask(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> Domain => Str
42              
43             The name of the domain containing the task lists to poll.
44              
45              
46              
47             =head2 Identity => Str
48              
49             Identity of the decider making the request, which is recorded in the
50             DecisionTaskStarted event in the workflow history. This enables
51             diagnostic tracing when problems arise. The form of this identity is
52             user defined.
53              
54              
55              
56             =head2 MaximumPageSize => Int
57              
58             The maximum number of results that are returned per call.
59             C<nextPageToken> can be used to obtain futher pages of results. The
60             default is 1000, which is the maximum allowed page size. You can,
61             however, specify a page size I<smaller> than the maximum.
62              
63             This is an upper limit only; the actual number of results returned per
64             call may be fewer than the specified maximum.
65              
66              
67              
68             =head2 NextPageToken => Str
69              
70             If a C<NextPageToken> was returned by a previous call, there are more
71             results available. To retrieve the next page of results, make the call
72             again using the returned token in C<nextPageToken>. Keep all other
73             arguments unchanged.
74              
75             The configured C<maximumPageSize> determines how many results can be
76             returned in a single call.
77              
78             The C<nextPageToken> returned by this action cannot be used with
79             GetWorkflowExecutionHistory to get the next page. You must call
80             PollForDecisionTask again (with the C<nextPageToken>) to retrieve the
81             next page of history records. Calling PollForDecisionTask with a
82             C<nextPageToken> doesn't return a new decision task.
83              
84              
85              
86             =head2 ReverseOrder => Bool
87              
88             When set to C<true>, returns the events in reverse order. By default
89             the results are returned in ascending order of the C<eventTimestamp> of
90             the events.
91              
92              
93              
94             =head2 B<REQUIRED> TaskList => L<Paws::SimpleWorkflow::TaskList>
95              
96             Specifies the task list to poll for decision tasks.
97              
98             The specified string must not start or end with whitespace. It must not
99             contain a C<:> (colon), C</> (slash), C<|> (vertical bar), or any
100             control characters (C<\u0000-\u001f> | C<\u007f-\u009f>). Also, it must
101             not contain the literal string C<arn>.
102              
103              
104              
105              
106             =head1 SEE ALSO
107              
108             This class forms part of L<Paws>, documenting arguments for method PollForDecisionTask in L<Paws::SimpleWorkflow>
109              
110             =head1 BUGS and CONTRIBUTIONS
111              
112             The source code is located here: https://github.com/pplu/aws-sdk-perl
113              
114             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
115              
116             =cut
117