File Coverage

blib/lib/Paws/SimpleWorkflow/WorkflowExecutionInfo.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::WorkflowExecutionInfo;
2 1     1   546 use Moose;
  1         4  
  1         8  
3             has CancelRequested => (is => 'ro', isa => 'Bool', request_name => 'cancelRequested', traits => ['NameInRequest']);
4             has CloseStatus => (is => 'ro', isa => 'Str', request_name => 'closeStatus', traits => ['NameInRequest']);
5             has CloseTimestamp => (is => 'ro', isa => 'Str', request_name => 'closeTimestamp', traits => ['NameInRequest']);
6             has Execution => (is => 'ro', isa => 'Paws::SimpleWorkflow::WorkflowExecution', request_name => 'execution', traits => ['NameInRequest'], required => 1);
7             has ExecutionStatus => (is => 'ro', isa => 'Str', request_name => 'executionStatus', traits => ['NameInRequest'], required => 1);
8             has Parent => (is => 'ro', isa => 'Paws::SimpleWorkflow::WorkflowExecution', request_name => 'parent', traits => ['NameInRequest']);
9             has StartTimestamp => (is => 'ro', isa => 'Str', request_name => 'startTimestamp', traits => ['NameInRequest'], required => 1);
10             has TagList => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'tagList', traits => ['NameInRequest']);
11             has WorkflowType => (is => 'ro', isa => 'Paws::SimpleWorkflow::WorkflowType', request_name => 'workflowType', traits => ['NameInRequest'], required => 1);
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::SimpleWorkflow::WorkflowExecutionInfo
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::SimpleWorkflow::WorkflowExecutionInfo object:
30              
31             $service_obj->Method(Att1 => { CancelRequested => $value, ..., WorkflowType => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::SimpleWorkflow::WorkflowExecutionInfo object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->CancelRequested
39              
40             =head1 DESCRIPTION
41              
42             Contains information about a workflow execution.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 CancelRequested => Bool
48              
49             Set to true if a cancellation is requested for this workflow execution.
50              
51              
52             =head2 CloseStatus => Str
53              
54             If the execution status is closed then this specifies how the execution
55             was closed:
56              
57             =over
58              
59             =item *
60              
61             C<COMPLETED> E<ndash> the execution was successfully completed.
62              
63             =item *
64              
65             C<CANCELED> E<ndash> the execution was canceled.Cancellation allows the
66             implementation to gracefully clean up before the execution is closed.
67              
68             =item *
69              
70             C<TERMINATED> E<ndash> the execution was force terminated.
71              
72             =item *
73              
74             C<FAILED> E<ndash> the execution failed to complete.
75              
76             =item *
77              
78             C<TIMED_OUT> E<ndash> the execution did not complete in the alloted
79             time and was automatically timed out.
80              
81             =item *
82              
83             C<CONTINUED_AS_NEW> E<ndash> the execution is logically continued. This
84             means the current execution was completed and a new execution was
85             started to carry on the workflow.
86              
87             =back
88              
89              
90              
91             =head2 CloseTimestamp => Str
92              
93             The time when the workflow execution was closed. Set only if the
94             execution status is CLOSED.
95              
96              
97             =head2 B<REQUIRED> Execution => L<Paws::SimpleWorkflow::WorkflowExecution>
98              
99             The workflow execution this information is about.
100              
101              
102             =head2 B<REQUIRED> ExecutionStatus => Str
103              
104             The current status of the execution.
105              
106              
107             =head2 Parent => L<Paws::SimpleWorkflow::WorkflowExecution>
108              
109             If this workflow execution is a child of another execution then
110             contains the workflow execution that started this execution.
111              
112              
113             =head2 B<REQUIRED> StartTimestamp => Str
114              
115             The time when the execution was started.
116              
117              
118             =head2 TagList => ArrayRef[Str|Undef]
119              
120             The list of tags associated with the workflow execution. Tags can be
121             used to identify and list workflow executions of interest through the
122             visibility APIs. A workflow execution can have a maximum of 5 tags.
123              
124              
125             =head2 B<REQUIRED> WorkflowType => L<Paws::SimpleWorkflow::WorkflowType>
126              
127             The type of the workflow execution.
128              
129              
130              
131             =head1 SEE ALSO
132              
133             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
134              
135             =head1 BUGS and CONTRIBUTIONS
136              
137             The source code is located here: https://github.com/pplu/aws-sdk-perl
138              
139             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
140              
141             =cut
142