File Coverage

blib/lib/Paws/SimpleWorkflow/WorkflowExecutionTerminatedEventAttributes.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::WorkflowExecutionTerminatedEventAttributes;
2 1     1   702 use Moose;
  1         3  
  1         10  
3             has Cause => (is => 'ro', isa => 'Str', request_name => 'cause', traits => ['NameInRequest']);
4             has ChildPolicy => (is => 'ro', isa => 'Str', request_name => 'childPolicy', traits => ['NameInRequest'], required => 1);
5             has Details => (is => 'ro', isa => 'Str', request_name => 'details', traits => ['NameInRequest']);
6             has Reason => (is => 'ro', isa => 'Str', request_name => 'reason', traits => ['NameInRequest']);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::SimpleWorkflow::WorkflowExecutionTerminatedEventAttributes
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::SimpleWorkflow::WorkflowExecutionTerminatedEventAttributes object:
25              
26             $service_obj->Method(Att1 => { Cause => $value, ..., Reason => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::SimpleWorkflow::WorkflowExecutionTerminatedEventAttributes object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->Cause
34              
35             =head1 DESCRIPTION
36              
37             Provides details of the C<WorkflowExecutionTerminated> event.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 Cause => Str
43              
44             If set, indicates that the workflow execution was automatically
45             terminated, and specifies the cause. This happens if the parent
46             workflow execution times out or is terminated and the child policy is
47             set to terminate child executions.
48              
49              
50             =head2 B<REQUIRED> ChildPolicy => Str
51              
52             The policy used for the child workflow executions of this workflow
53             execution.
54              
55             The supported child policies are:
56              
57             =over
58              
59             =item * B<TERMINATE:> the child executions will be terminated.
60              
61             =item * B<REQUEST_CANCEL:> a request to cancel will be attempted for
62             each child execution by recording a C<WorkflowExecutionCancelRequested>
63             event in its history. It is up to the decider to take appropriate
64             actions when it receives an execution history with this event.
65              
66             =item * B<ABANDON:> no action will be taken. The child executions will
67             continue to run.
68              
69             =back
70              
71              
72              
73             =head2 Details => Str
74              
75             The details provided for the termination (if any).
76              
77              
78             =head2 Reason => Str
79              
80             The reason provided for the termination (if any).
81              
82              
83              
84             =head1 SEE ALSO
85              
86             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
87              
88             =head1 BUGS and CONTRIBUTIONS
89              
90             The source code is located here: https://github.com/pplu/aws-sdk-perl
91              
92             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
93              
94             =cut
95