File Coverage

blib/lib/Paws/SimpleWorkflow/ActivityTypeConfiguration.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	sub	time	code
1				package Paws::SimpleWorkflow::ActivityTypeConfiguration;
2	1	1	732	use Moose;
	1		5
	1		13
3				has DefaultTaskHeartbeatTimeout => (is => 'ro', isa => 'Str', request_name => 'defaultTaskHeartbeatTimeout', traits => ['NameInRequest']);
4				has DefaultTaskList => (is => 'ro', isa => 'Paws::SimpleWorkflow::TaskList', request_name => 'defaultTaskList', traits => ['NameInRequest']);
5				has DefaultTaskPriority => (is => 'ro', isa => 'Str', request_name => 'defaultTaskPriority', traits => ['NameInRequest']);
6				has DefaultTaskScheduleToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'defaultTaskScheduleToCloseTimeout', traits => ['NameInRequest']);
7				has DefaultTaskScheduleToStartTimeout => (is => 'ro', isa => 'Str', request_name => 'defaultTaskScheduleToStartTimeout', traits => ['NameInRequest']);
8				has DefaultTaskStartToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'defaultTaskStartToCloseTimeout', traits => ['NameInRequest']);
9				1;
10
11				### main pod documentation begin ###
12
13				=head1 NAME
14
15				Paws::SimpleWorkflow::ActivityTypeConfiguration
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::ActivityTypeConfiguration object:
27
28				$service_obj->Method(Att1 => { DefaultTaskHeartbeatTimeout => $value, ..., DefaultTaskStartToCloseTimeout => $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::ActivityTypeConfiguration object:
33
34				$result = $service_obj->Method(...);
35				$result->Att1->DefaultTaskHeartbeatTimeout
36
37				=head1 DESCRIPTION
38
39				Configuration settings registered with the activity type.
40
41				=head1 ATTRIBUTES
42
43
44				=head2 DefaultTaskHeartbeatTimeout => Str
45
46				The default maximum time, in seconds, before which a worker processing
47				a task must report progress by calling RecordActivityTaskHeartbeat.
48
49				You can specify this value only when I<registering> an activity type.
50				The registered default value can be overridden when you schedule a task
51				through the C<ScheduleActivityTask> Decision. If the activity worker
52				subsequently attempts to record a heartbeat or returns a result, the
53				activity worker receives an C<UnknownResource> fault. In this case,
54				Amazon SWF no longer considers the activity task to be valid; the
55				activity worker should clean up the activity task.
56
57				The duration is specified in seconds, an integer greater than or equal
58				to C<0>. You can use C<NONE> to specify unlimited duration.
59
60
61				=head2 DefaultTaskList => L<Paws::SimpleWorkflow::TaskList>
62
63				The default task list specified for this activity type at registration.
64				This default is used if a task list isn't provided when a task is
65				scheduled through the C<ScheduleActivityTask> Decision. You can
66				override the default registered task list when scheduling a task
67				through the C<ScheduleActivityTask> Decision.
68
69
70				=head2 DefaultTaskPriority => Str
71
72				The default task priority for tasks of this activity type, specified at
73				registration. If not set, then C<0> is used as the default priority.
74				This default can be overridden when scheduling an activity task.
75
76				Valid values are integers that range from Java's C<Integer.MIN_VALUE>
77				(-2147483648) to C<Integer.MAX_VALUE> (2147483647). Higher numbers
78				indicate higher priority.
79
80				For more information about setting task priority, see Setting Task
81				Priority in the I<Amazon SWF Developer Guide>.
82
83
84				=head2 DefaultTaskScheduleToCloseTimeout => Str
85
86				The default maximum duration, specified when registering the activity
87				type, for tasks of this activity type. You can override this default
88				when scheduling a task through the C<ScheduleActivityTask> Decision.
89
90				The duration is specified in seconds, an integer greater than or equal
91				to C<0>. You can use C<NONE> to specify unlimited duration.
92
93
94				=head2 DefaultTaskScheduleToStartTimeout => Str
95
96				The default maximum duration, specified when registering the activity
97				type, that a task of an activity type can wait before being assigned to
98				a worker. You can override this default when scheduling a task through
99				the C<ScheduleActivityTask> Decision.
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 DefaultTaskStartToCloseTimeout => Str
106
107				The default maximum duration for tasks of an activity type specified
108				when registering the activity type. You can override this default when
109				scheduling a task through the C<ScheduleActivityTask> Decision.
110
111				The duration is specified in seconds, an integer greater than or equal
112				to C<0>. You can use C<NONE> to specify unlimited duration.
113
114
115
116				=head1 SEE ALSO
117
118				This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
119
120				=head1 BUGS and CONTRIBUTIONS
121
122				The source code is located here: https://github.com/pplu/aws-sdk-perl
123
124				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
125
126				=cut
127