« blib/lib/Paws/MTurk/GetQualificationTypeResponse.pm
↑ Summary
blib/lib/Paws/MTurk/HITLayoutParameter.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MTurk::HIT; | ||
| 3 | use Moose; | ||
| 4 | has AssignmentDurationInSeconds => (is => 'ro', isa => 'Int'); | ||
| 5 | has AutoApprovalDelayInSeconds => (is => 'ro', isa => 'Int'); | ||
| 6 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str'); | ||
| 8 | has Expiration => (is => 'ro', isa => 'Str'); | ||
| 9 | has HITGroupId => (is => 'ro', isa => 'Str'); | ||
| 10 | has HITId => (is => 'ro', isa => 'Str'); | ||
| 11 | has HITLayoutId => (is => 'ro', isa => 'Str'); | ||
| 12 | has HITReviewStatus => (is => 'ro', isa => 'Str'); | ||
| 13 | has HITStatus => (is => 'ro', isa => 'Str'); | ||
| 14 | has HITTypeId => (is => 'ro', isa => 'Str'); | ||
| 15 | has Keywords => (is => 'ro', isa => 'Str'); | ||
| 16 | has MaxAssignments => (is => 'ro', isa => 'Int'); | ||
| 17 | has NumberOfAssignmentsAvailable => (is => 'ro', isa => 'Int'); | ||
| 18 | has NumberOfAssignmentsCompleted => (is => 'ro', isa => 'Int'); | ||
| 19 | has NumberOfAssignmentsPending => (is => 'ro', isa => 'Int'); | ||
| 20 | has QualificationRequirements => (is => 'ro', isa => 'ArrayRef[Paws::MTurk::QualificationRequirement]'); | ||
| 21 | has Question => (is => 'ro', isa => 'Str'); | ||
| 22 | has RequesterAnnotation => (is => 'ro', isa => 'Str'); | ||
| 23 | has Reward => (is => 'ro', isa => 'Str'); | ||
| 24 | has Title => (is => 'ro', isa => 'Str'); | ||
| 25 | |||
| 26 | 1; | ||
| 27 | |||
| 28 | ### main pod documentation begin ### | ||
| 29 | |||
| 30 | =head1 NAME | ||
| 31 | |||
| 32 | Paws::MTurk::HIT | ||
| 33 | |||
| 34 | =head1 USAGE | ||
| 35 | |||
| 36 | This class represents one of two things: | ||
| 37 | |||
| 38 | =head3 Arguments in a call to a service | ||
| 39 | |||
| 40 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 41 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 42 | |||
| 43 | As an example, if Att1 is expected to be a Paws::MTurk::HIT object: | ||
| 44 | |||
| 45 | $service_obj->Method(Att1 => { AssignmentDurationInSeconds => $value, ..., Title => $value }); | ||
| 46 | |||
| 47 | =head3 Results returned from an API call | ||
| 48 | |||
| 49 | Use accessors for each attribute. If Att1 is expected to be an Paws::MTurk::HIT object: | ||
| 50 | |||
| 51 | $result = $service_obj->Method(...); | ||
| 52 | $result->Att1->AssignmentDurationInSeconds | ||
| 53 | |||
| 54 | =head1 DESCRIPTION | ||
| 55 | |||
| 56 | The HIT data structure represents a single HIT, including all the | ||
| 57 | information necessary for a Worker to accept and complete the HIT. | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 AssignmentDurationInSeconds => Int | ||
| 63 | |||
| 64 | The length of time, in seconds, that a Worker has to complete the HIT | ||
| 65 | after accepting it. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 AutoApprovalDelayInSeconds => Int | ||
| 69 | |||
| 70 | The amount of time, in seconds, after the Worker submits an assignment | ||
| 71 | for the HIT that the results are automatically approved by Amazon | ||
| 72 | Mechanical Turk. This is the amount of time the Requester has to reject | ||
| 73 | an assignment submitted by a Worker before the assignment is | ||
| 74 | auto-approved and the Worker is paid. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 CreationTime => Str | ||
| 78 | |||
| 79 | The date and time the HIT was created. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Description => Str | ||
| 83 | |||
| 84 | A general description of the HIT. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Expiration => Str | ||
| 88 | |||
| 89 | The date and time the HIT expires. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 HITGroupId => Str | ||
| 93 | |||
| 94 | The ID of the HIT Group of this HIT. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 HITId => Str | ||
| 98 | |||
| 99 | A unique identifier for the HIT. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 HITLayoutId => Str | ||
| 103 | |||
| 104 | The ID of the HIT Layout of this HIT. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 HITReviewStatus => Str | ||
| 108 | |||
| 109 | Indicates the review status of the HIT. Valid Values are NotReviewed | | ||
| 110 | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 HITStatus => Str | ||
| 114 | |||
| 115 | The status of the HIT and its assignments. Valid Values are Assignable | ||
| 116 | | Unassignable | Reviewable | Reviewing | Disposed. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 HITTypeId => Str | ||
| 120 | |||
| 121 | The ID of the HIT type of this HIT | ||
| 122 | |||
| 123 | |||
| 124 | =head2 Keywords => Str | ||
| 125 | |||
| 126 | One or more words or phrases that describe the HIT, separated by | ||
| 127 | commas. Search terms similar to the keywords of a HIT are more likely | ||
| 128 | to have the HIT in the search results. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 MaxAssignments => Int | ||
| 132 | |||
| 133 | The number of times the HIT can be accepted and completed before the | ||
| 134 | HIT becomes unavailable. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 NumberOfAssignmentsAvailable => Int | ||
| 138 | |||
| 139 | The number of assignments for this HIT that are available for Workers | ||
| 140 | to accept. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 NumberOfAssignmentsCompleted => Int | ||
| 144 | |||
| 145 | The number of assignments for this HIT that have been approved or | ||
| 146 | rejected. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 NumberOfAssignmentsPending => Int | ||
| 150 | |||
| 151 | The number of assignments for this HIT that are being previewed or have | ||
| 152 | been accepted by Workers, but have not yet been submitted, returned, or | ||
| 153 | abandoned. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 QualificationRequirements => ArrayRef[L<Paws::MTurk::QualificationRequirement>] | ||
| 157 | |||
| 158 | Conditions that a Worker's Qualifications must meet in order to accept | ||
| 159 | the HIT. A HIT can have between zero and ten Qualification | ||
| 160 | requirements. All requirements must be met in order for a Worker to | ||
| 161 | accept the HIT. Additionally, other actions can be restricted using the | ||
| 162 | C<ActionsGuarded> field on each C<QualificationRequirement> structure. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 Question => Str | ||
| 166 | |||
| 167 | The data the Worker completing the HIT uses produce the results. This | ||
| 168 | is either either a QuestionForm, HTMLQuestion or an ExternalQuestion | ||
| 169 | data structure. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 RequesterAnnotation => Str | ||
| 173 | |||
| 174 | An arbitrary data field the Requester who created the HIT can use. This | ||
| 175 | field is visible only to the creator of the HIT. | ||
| 176 | |||
| 177 | |||
| 178 | =head2 Reward => Str | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | |||
| 183 | =head2 Title => Str | ||
| 184 | |||
| 185 | The title of the HIT. | ||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | =head1 SEE ALSO | ||
| 190 | |||
| 191 | This class forms part of L<Paws>, describing an object used in L<Paws::MTurk> | ||
| 192 | |||
| 193 | =head1 BUGS and CONTRIBUTIONS | ||
| 194 | |||
| 195 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 196 | |||
| 197 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 198 | |||
| 199 | =cut | ||
| 200 |