File Coverage

blib/lib/Paws/SimpleWorkflow/GetWorkflowExecutionHistory.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::GetWorkflowExecutionHistory;
3 1     1   469 use Moose;
  1         3  
  1         8  
4             has Domain => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domain' , required => 1);
5             has Execution => (is => 'ro', isa => 'Paws::SimpleWorkflow::WorkflowExecution', traits => ['NameInRequest'], request_name => 'execution' , required => 1);
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              
10 1     1   6273 use MooseX::ClassAttribute;
  1         4  
  1         10  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetWorkflowExecutionHistory');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SimpleWorkflow::History');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::SimpleWorkflow::GetWorkflowExecutionHistory - Arguments for method GetWorkflowExecutionHistory on Paws::SimpleWorkflow
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method GetWorkflowExecutionHistory on the
26             Amazon Simple Workflow Service service. Use the attributes of this class
27             as arguments to method GetWorkflowExecutionHistory.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetWorkflowExecutionHistory.
30              
31             As an example:
32              
33             $service_obj->GetWorkflowExecutionHistory(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> Domain => Str
41              
42             The name of the domain containing the workflow execution.
43              
44              
45              
46             =head2 B<REQUIRED> Execution => L<Paws::SimpleWorkflow::WorkflowExecution>
47              
48             Specifies the workflow execution for which to return the history.
49              
50              
51              
52             =head2 MaximumPageSize => Int
53              
54             The maximum number of results that are returned per call.
55             C<nextPageToken> can be used to obtain futher pages of results. The
56             default is 1000, which is the maximum allowed page size. You can,
57             however, specify a page size I<smaller> than the maximum.
58              
59             This is an upper limit only; the actual number of results returned per
60             call may be fewer than the specified maximum.
61              
62              
63              
64             =head2 NextPageToken => Str
65              
66             If a C<NextPageToken> was returned by a previous call, there are more
67             results available. To retrieve the next page of results, make the call
68             again using the returned token in C<nextPageToken>. Keep all other
69             arguments unchanged.
70              
71             The configured C<maximumPageSize> determines how many results can be
72             returned in a single call.
73              
74              
75              
76             =head2 ReverseOrder => Bool
77              
78             When set to C<true>, returns the events in reverse order. By default
79             the results are returned in ascending order of the C<eventTimeStamp> of
80             the events.
81              
82              
83              
84              
85             =head1 SEE ALSO
86              
87             This class forms part of L<Paws>, documenting arguments for method GetWorkflowExecutionHistory in L<Paws::SimpleWorkflow>
88              
89             =head1 BUGS and CONTRIBUTIONS
90              
91             The source code is located here: https://github.com/pplu/aws-sdk-perl
92              
93             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
94              
95             =cut
96