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