File Coverage

blib/lib/Paws/MTurk/QualificationType.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::MTurk::QualificationType;
2 1     1   634 use Moose;
  1         4  
  1         12  
3             has AnswerKey => (is => 'ro', isa => 'Str');
4             has AutoGranted => (is => 'ro', isa => 'Bool');
5             has AutoGrantedValue => (is => 'ro', isa => 'Int');
6             has CreationTime => (is => 'ro', isa => 'Str');
7             has Description => (is => 'ro', isa => 'Str');
8             has IsRequestable => (is => 'ro', isa => 'Bool');
9             has Keywords => (is => 'ro', isa => 'Str');
10             has Name => (is => 'ro', isa => 'Str');
11             has QualificationTypeId => (is => 'ro', isa => 'Str');
12             has QualificationTypeStatus => (is => 'ro', isa => 'Str');
13             has RetryDelayInSeconds => (is => 'ro', isa => 'Int');
14             has Test => (is => 'ro', isa => 'Str');
15             has TestDurationInSeconds => (is => 'ro', isa => 'Int');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::MTurk::QualificationType
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::MTurk::QualificationType object:
34              
35             $service_obj->Method(Att1 => { AnswerKey => $value, ..., TestDurationInSeconds => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::MTurk::QualificationType object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->AnswerKey
43              
44             =head1 DESCRIPTION
45              
46             The QualificationType data structure represents a Qualification type, a
47             description of a property of a Worker that must match the requirements
48             of a HIT for the Worker to be able to accept the HIT. The type also
49             describes how a Worker can obtain a Qualification of that type, such as
50             through a Qualification test.
51              
52             =head1 ATTRIBUTES
53              
54              
55             =head2 AnswerKey => Str
56              
57             The answers to the Qualification test specified in the Test parameter.
58              
59              
60             =head2 AutoGranted => Bool
61              
62             Specifies that requests for the Qualification type are granted
63             immediately, without prompting the Worker with a Qualification test.
64             Valid values are True | False.
65              
66              
67             =head2 AutoGrantedValue => Int
68              
69             The Qualification integer value to use for automatically granted
70             Qualifications, if AutoGranted is true. This is 1 by default.
71              
72              
73             =head2 CreationTime => Str
74              
75             The date and time the Qualification type was created.
76              
77              
78             =head2 Description => Str
79              
80             A long description for the Qualification type.
81              
82              
83             =head2 IsRequestable => Bool
84              
85             Specifies whether the Qualification type is one that a user can request
86             through the Amazon Mechanical Turk web site, such as by taking a
87             Qualification test. This value is False for Qualifications assigned
88             automatically by the system. Valid values are True | False.
89              
90              
91             =head2 Keywords => Str
92              
93             One or more words or phrases that describe theQualification type,
94             separated by commas. The Keywords make the type easier to find using a
95             search.
96              
97              
98             =head2 Name => Str
99              
100             The name of the Qualification type. The type name is used to identify
101             the type, and to find the type using a Qualification type search.
102              
103              
104             =head2 QualificationTypeId => Str
105              
106             A unique identifier for the Qualification type. A Qualification type is
107             given a Qualification type ID when you call the CreateQualificationType
108             operation.
109              
110              
111             =head2 QualificationTypeStatus => Str
112              
113             The status of the Qualification type. A Qualification type's status
114             determines if users can apply to receive a Qualification of this type,
115             and if HITs can be created with requirements based on this type. Valid
116             values are Active | Inactive.
117              
118              
119             =head2 RetryDelayInSeconds => Int
120              
121             The amount of time, in seconds, Workers must wait after taking the
122             Qualification test before they can take it again. Workers can take a
123             Qualification test multiple times if they were not granted the
124             Qualification from a previous attempt, or if the test offers a gradient
125             score and they want a better score. If not specified, retries are
126             disabled and Workers can request a Qualification only once.
127              
128              
129             =head2 Test => Str
130              
131             The questions for a Qualification test associated with this
132             Qualification type that a user can take to obtain a Qualification of
133             this type. This parameter must be specified if AnswerKey is present. A
134             Qualification type cannot have both a specified Test parameter and an
135             AutoGranted value of true.
136              
137              
138             =head2 TestDurationInSeconds => Int
139              
140             The amount of time, in seconds, given to a Worker to complete the
141             Qualification test, beginning from the time the Worker requests the
142             Qualification.
143              
144              
145              
146             =head1 SEE ALSO
147              
148             This class forms part of L<Paws>, describing an object used in L<Paws::MTurk>
149              
150             =head1 BUGS and CONTRIBUTIONS
151              
152             The source code is located here: https://github.com/pplu/aws-sdk-perl
153              
154             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
155              
156             =cut
157