File Coverage

blib/lib/Paws/SimpleWorkflow/StartChildWorkflowExecutionInitiatedEventAttributes.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::StartChildWorkflowExecutionInitiatedEventAttributes;
2 1     1   689 use Moose;
  1         4  
  1         11  
3             has ChildPolicy => (is => 'ro', isa => 'Str', request_name => 'childPolicy', traits => ['NameInRequest'], required => 1);
4             has Control => (is => 'ro', isa => 'Str', request_name => 'control', traits => ['NameInRequest']);
5             has DecisionTaskCompletedEventId => (is => 'ro', isa => 'Int', request_name => 'decisionTaskCompletedEventId', traits => ['NameInRequest'], required => 1);
6             has ExecutionStartToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'executionStartToCloseTimeout', traits => ['NameInRequest']);
7             has Input => (is => 'ro', isa => 'Str', request_name => 'input', traits => ['NameInRequest']);
8             has LambdaRole => (is => 'ro', isa => 'Str', request_name => 'lambdaRole', traits => ['NameInRequest']);
9             has TagList => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'tagList', traits => ['NameInRequest']);
10             has TaskList => (is => 'ro', isa => 'Paws::SimpleWorkflow::TaskList', request_name => 'taskList', traits => ['NameInRequest'], required => 1);
11             has TaskPriority => (is => 'ro', isa => 'Str', request_name => 'taskPriority', traits => ['NameInRequest']);
12             has TaskStartToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'taskStartToCloseTimeout', traits => ['NameInRequest']);
13             has WorkflowId => (is => 'ro', isa => 'Str', request_name => 'workflowId', traits => ['NameInRequest'], required => 1);
14             has WorkflowType => (is => 'ro', isa => 'Paws::SimpleWorkflow::WorkflowType', request_name => 'workflowType', traits => ['NameInRequest'], required => 1);
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::SimpleWorkflow::StartChildWorkflowExecutionInitiatedEventAttributes
22              
23             =head1 USAGE
24              
25             This class represents one of two things:
26              
27             =head3 Arguments in a call to a service
28              
29             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30             Each attribute should be used as a named argument in the calls that expect this type of object.
31              
32             As an example, if Att1 is expected to be a Paws::SimpleWorkflow::StartChildWorkflowExecutionInitiatedEventAttributes object:
33              
34             $service_obj->Method(Att1 => { ChildPolicy => $value, ..., WorkflowType => $value });
35              
36             =head3 Results returned from an API call
37              
38             Use accessors for each attribute. If Att1 is expected to be an Paws::SimpleWorkflow::StartChildWorkflowExecutionInitiatedEventAttributes object:
39              
40             $result = $service_obj->Method(...);
41             $result->Att1->ChildPolicy
42              
43             =head1 DESCRIPTION
44              
45             Provides the details of the C<StartChildWorkflowExecutionInitiated>
46             event.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 B<REQUIRED> ChildPolicy => Str
52              
53             The policy to use for the child workflow executions if this execution
54             gets terminated by explicitly calling the TerminateWorkflowExecution
55             action or due to an expired timeout.
56              
57             The supported child policies are:
58              
59             =over
60              
61             =item *
62              
63             C<TERMINATE> E<ndash> The child executions are terminated.
64              
65             =item *
66              
67             C<REQUEST_CANCEL> E<ndash> A request to cancel is attempted for each
68             child execution by recording a C<WorkflowExecutionCancelRequested>
69             event in its history. It is up to the decider to take appropriate
70             actions when it receives an execution history with this event.
71              
72             =item *
73              
74             C<ABANDON> E<ndash> No action is taken. The child executions continue
75             to run.
76              
77             =back
78              
79              
80              
81             =head2 Control => Str
82              
83             Data attached to the event that can be used by the decider in
84             subsequent decision tasks. This data isn't sent to the activity.
85              
86              
87             =head2 B<REQUIRED> DecisionTaskCompletedEventId => Int
88              
89             The ID of the C<DecisionTaskCompleted> event corresponding to the
90             decision task that resulted in the C<StartChildWorkflowExecution>
91             Decision to request this child workflow execution. This information can
92             be useful for diagnosing problems by tracing back the cause of events.
93              
94              
95             =head2 ExecutionStartToCloseTimeout => Str
96              
97             The maximum duration for the child workflow execution. If the workflow
98             execution isn't closed within this duration, it is timed out and
99             force-terminated.
100              
101             The duration is specified in seconds, an integer greater than or equal
102             to C<0>. You can use C<NONE> to specify unlimited duration.
103              
104              
105             =head2 Input => Str
106              
107             The inputs provided to the child workflow execution.
108              
109              
110             =head2 LambdaRole => Str
111              
112             The IAM role to attach to the child workflow execution.
113              
114              
115             =head2 TagList => ArrayRef[Str|Undef]
116              
117             The list of tags to associated with the child workflow execution.
118              
119              
120             =head2 B<REQUIRED> TaskList => L<Paws::SimpleWorkflow::TaskList>
121              
122             The name of the task list used for the decision tasks of the child
123             workflow execution.
124              
125              
126             =head2 TaskPriority => Str
127              
128             The priority assigned for the decision tasks for this workflow
129             execution. Valid values are integers that range from Java's
130             C<Integer.MIN_VALUE> (-2147483648) to C<Integer.MAX_VALUE>
131             (2147483647). Higher numbers indicate higher priority.
132              
133             For more information about setting task priority, see Setting Task
134             Priority in the I<Amazon SWF Developer Guide>.
135              
136              
137             =head2 TaskStartToCloseTimeout => Str
138              
139             The maximum duration allowed for the decision tasks for this workflow
140             execution.
141              
142             The duration is specified in seconds, an integer greater than or equal
143             to C<0>. You can use C<NONE> to specify unlimited duration.
144              
145              
146             =head2 B<REQUIRED> WorkflowId => Str
147              
148             The C<workflowId> of the child workflow execution.
149              
150              
151             =head2 B<REQUIRED> WorkflowType => L<Paws::SimpleWorkflow::WorkflowType>
152              
153             The type of the child workflow execution.
154              
155              
156              
157             =head1 SEE ALSO
158              
159             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
160              
161             =head1 BUGS and CONTRIBUTIONS
162              
163             The source code is located here: https://github.com/pplu/aws-sdk-perl
164              
165             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
166              
167             =cut
168