File Coverage

blib/lib/Paws/SimpleWorkflow/WorkflowExecutionConfiguration.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::WorkflowExecutionConfiguration;
2 1     1   658 use Moose;
  1         3  
  1         10  
3             has ChildPolicy => (is => 'ro', isa => 'Str', request_name => 'childPolicy', traits => ['NameInRequest'], required => 1);
4             has ExecutionStartToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'executionStartToCloseTimeout', traits => ['NameInRequest'], required => 1);
5             has LambdaRole => (is => 'ro', isa => 'Str', request_name => 'lambdaRole', traits => ['NameInRequest']);
6             has TaskList => (is => 'ro', isa => 'Paws::SimpleWorkflow::TaskList', request_name => 'taskList', traits => ['NameInRequest'], required => 1);
7             has TaskPriority => (is => 'ro', isa => 'Str', request_name => 'taskPriority', traits => ['NameInRequest']);
8             has TaskStartToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'taskStartToCloseTimeout', traits => ['NameInRequest'], required => 1);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::SimpleWorkflow::WorkflowExecutionConfiguration
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::SimpleWorkflow::WorkflowExecutionConfiguration object:
27              
28             $service_obj->Method(Att1 => { ChildPolicy => $value, ..., TaskStartToCloseTimeout => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::SimpleWorkflow::WorkflowExecutionConfiguration object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->ChildPolicy
36              
37             =head1 DESCRIPTION
38              
39             The configuration settings for a workflow execution including timeout
40             values, tasklist etc. These configuration settings are determined from
41             the defaults specified when registering the workflow type and those
42             specified when starting the workflow execution.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 B<REQUIRED> ChildPolicy => Str
48              
49             The policy to use for the child workflow executions if this workflow
50             execution is terminated, by calling the TerminateWorkflowExecution
51             action explicitly or due to an expired timeout.
52              
53             The supported child policies are:
54              
55             =over
56              
57             =item * B<TERMINATE:> the child executions will be terminated.
58              
59             =item * B<REQUEST_CANCEL:> a request to cancel will be attempted for
60             each child execution by recording a C<WorkflowExecutionCancelRequested>
61             event in its history. It is up to the decider to take appropriate
62             actions when it receives an execution history with this event.
63              
64             =item * B<ABANDON:> no action will be taken. The child executions will
65             continue to run.
66              
67             =back
68              
69              
70              
71             =head2 B<REQUIRED> ExecutionStartToCloseTimeout => Str
72              
73             The total duration for this workflow execution.
74              
75             The duration is specified in seconds; an integer greater than or equal
76             to 0. The value "NONE" can be used to specify unlimited duration.
77              
78              
79             =head2 LambdaRole => Str
80              
81             The IAM role used by this workflow execution when invoking AWS Lambda
82             functions.
83              
84              
85             =head2 B<REQUIRED> TaskList => L<Paws::SimpleWorkflow::TaskList>
86              
87             The task list used for the decision tasks generated for this workflow
88             execution.
89              
90              
91             =head2 TaskPriority => Str
92              
93             The priority assigned to decision tasks for this workflow execution.
94             Valid values are integers that range from Java's C<Integer.MIN_VALUE>
95             (-2147483648) to C<Integer.MAX_VALUE> (2147483647). Higher numbers
96             indicate higher priority.
97              
98             For more information about setting task priority, see Setting Task
99             Priority in the I<Amazon Simple Workflow Developer Guide>.
100              
101              
102             =head2 B<REQUIRED> TaskStartToCloseTimeout => Str
103              
104             The maximum duration allowed for decision tasks for this workflow
105             execution.
106              
107             The duration is specified in seconds; an integer greater than or equal
108             to 0. The value "NONE" can be used to specify unlimited duration.
109              
110              
111              
112             =head1 SEE ALSO
113              
114             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
115              
116             =head1 BUGS and CONTRIBUTIONS
117              
118             The source code is located here: https://github.com/pplu/aws-sdk-perl
119              
120             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
121              
122             =cut
123