/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the mturk-requester-2017-01-17.normal.json service model. */ using System; using System.Collections.Generic; using System.Xml.Serialization; using System.Text; using System.IO; using System.Net; using Amazon.Runtime; using Amazon.Runtime.Internal; namespace Amazon.MTurk.Model { /// /// The HIT data structure represents a single HIT, including all the information necessary /// for a Worker to accept and complete the HIT. /// public partial class HIT { private long? _assignmentDurationInSeconds; private long? _autoApprovalDelayInSeconds; private DateTime? _creationTime; private string _description; private DateTime? _expiration; private string _hitGroupId; private string _hitId; private string _hitLayoutId; private HITReviewStatus _hitReviewStatus; private HITStatus _hitStatus; private string _hitTypeId; private string _keywords; private int? _maxAssignments; private int? _numberOfAssignmentsAvailable; private int? _numberOfAssignmentsCompleted; private int? _numberOfAssignmentsPending; private List _qualificationRequirements = new List(); private string _question; private string _requesterAnnotation; private string _reward; private string _title; /// /// Gets and sets the property AssignmentDurationInSeconds. /// /// The length of time, in seconds, that a Worker has to complete the HIT after accepting /// it. /// /// public long AssignmentDurationInSeconds { get { return this._assignmentDurationInSeconds.GetValueOrDefault(); } set { this._assignmentDurationInSeconds = value; } } // Check to see if AssignmentDurationInSeconds property is set internal bool IsSetAssignmentDurationInSeconds() { return this._assignmentDurationInSeconds.HasValue; } /// /// Gets and sets the property AutoApprovalDelayInSeconds. /// /// The amount of time, in seconds, after the Worker submits an assignment for the HIT /// that the results are automatically approved by Amazon Mechanical Turk. This is the /// amount of time the Requester has to reject an assignment submitted by a Worker before /// the assignment is auto-approved and the Worker is paid. /// /// public long AutoApprovalDelayInSeconds { get { return this._autoApprovalDelayInSeconds.GetValueOrDefault(); } set { this._autoApprovalDelayInSeconds = value; } } // Check to see if AutoApprovalDelayInSeconds property is set internal bool IsSetAutoApprovalDelayInSeconds() { return this._autoApprovalDelayInSeconds.HasValue; } /// /// Gets and sets the property CreationTime. /// /// The date and time the HIT was created. /// /// public DateTime CreationTime { get { return this._creationTime.GetValueOrDefault(); } set { this._creationTime = value; } } // Check to see if CreationTime property is set internal bool IsSetCreationTime() { return this._creationTime.HasValue; } /// /// Gets and sets the property Description. /// /// A general description of the HIT. /// /// public string Description { get { return this._description; } set { this._description = value; } } // Check to see if Description property is set internal bool IsSetDescription() { return this._description != null; } /// /// Gets and sets the property Expiration. /// /// The date and time the HIT expires. /// /// public DateTime Expiration { get { return this._expiration.GetValueOrDefault(); } set { this._expiration = value; } } // Check to see if Expiration property is set internal bool IsSetExpiration() { return this._expiration.HasValue; } /// /// Gets and sets the property HITGroupId. /// /// The ID of the HIT Group of this HIT. /// /// [AWSProperty(Min=1, Max=64)] public string HITGroupId { get { return this._hitGroupId; } set { this._hitGroupId = value; } } // Check to see if HITGroupId property is set internal bool IsSetHITGroupId() { return this._hitGroupId != null; } /// /// Gets and sets the property HITId. /// /// A unique identifier for the HIT. /// /// [AWSProperty(Min=1, Max=64)] public string HITId { get { return this._hitId; } set { this._hitId = value; } } // Check to see if HITId property is set internal bool IsSetHITId() { return this._hitId != null; } /// /// Gets and sets the property HITLayoutId. /// /// The ID of the HIT Layout of this HIT. /// /// [AWSProperty(Min=1, Max=64)] public string HITLayoutId { get { return this._hitLayoutId; } set { this._hitLayoutId = value; } } // Check to see if HITLayoutId property is set internal bool IsSetHITLayoutId() { return this._hitLayoutId != null; } /// /// Gets and sets the property HITReviewStatus. /// /// Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview /// | ReviewedAppropriate | ReviewedInappropriate. /// /// public HITReviewStatus HITReviewStatus { get { return this._hitReviewStatus; } set { this._hitReviewStatus = value; } } // Check to see if HITReviewStatus property is set internal bool IsSetHITReviewStatus() { return this._hitReviewStatus != null; } /// /// Gets and sets the property HITStatus. /// /// The status of the HIT and its assignments. Valid Values are Assignable | Unassignable /// | Reviewable | Reviewing | Disposed. /// /// public HITStatus HITStatus { get { return this._hitStatus; } set { this._hitStatus = value; } } // Check to see if HITStatus property is set internal bool IsSetHITStatus() { return this._hitStatus != null; } /// /// Gets and sets the property HITTypeId. /// /// The ID of the HIT type of this HIT /// /// [AWSProperty(Min=1, Max=64)] public string HITTypeId { get { return this._hitTypeId; } set { this._hitTypeId = value; } } // Check to see if HITTypeId property is set internal bool IsSetHITTypeId() { return this._hitTypeId != null; } /// /// Gets and sets the property Keywords. /// /// One or more words or phrases that describe the HIT, separated by commas. Search terms /// similar to the keywords of a HIT are more likely to have the HIT in the search results. /// /// public string Keywords { get { return this._keywords; } set { this._keywords = value; } } // Check to see if Keywords property is set internal bool IsSetKeywords() { return this._keywords != null; } /// /// Gets and sets the property MaxAssignments. /// /// The number of times the HIT can be accepted and completed before the HIT becomes unavailable. /// /// /// public int MaxAssignments { get { return this._maxAssignments.GetValueOrDefault(); } set { this._maxAssignments = value; } } // Check to see if MaxAssignments property is set internal bool IsSetMaxAssignments() { return this._maxAssignments.HasValue; } /// /// Gets and sets the property NumberOfAssignmentsAvailable. /// /// The number of assignments for this HIT that are available for Workers to accept. /// /// public int NumberOfAssignmentsAvailable { get { return this._numberOfAssignmentsAvailable.GetValueOrDefault(); } set { this._numberOfAssignmentsAvailable = value; } } // Check to see if NumberOfAssignmentsAvailable property is set internal bool IsSetNumberOfAssignmentsAvailable() { return this._numberOfAssignmentsAvailable.HasValue; } /// /// Gets and sets the property NumberOfAssignmentsCompleted. /// /// The number of assignments for this HIT that have been approved or rejected. /// /// public int NumberOfAssignmentsCompleted { get { return this._numberOfAssignmentsCompleted.GetValueOrDefault(); } set { this._numberOfAssignmentsCompleted = value; } } // Check to see if NumberOfAssignmentsCompleted property is set internal bool IsSetNumberOfAssignmentsCompleted() { return this._numberOfAssignmentsCompleted.HasValue; } /// /// Gets and sets the property NumberOfAssignmentsPending. /// /// The number of assignments for this HIT that are being previewed or have been accepted /// by Workers, but have not yet been submitted, returned, or abandoned. /// /// public int NumberOfAssignmentsPending { get { return this._numberOfAssignmentsPending.GetValueOrDefault(); } set { this._numberOfAssignmentsPending = value; } } // Check to see if NumberOfAssignmentsPending property is set internal bool IsSetNumberOfAssignmentsPending() { return this._numberOfAssignmentsPending.HasValue; } /// /// Gets and sets the property QualificationRequirements. /// /// Conditions that a Worker's Qualifications must meet in order to accept the HIT. A /// HIT can have between zero and ten Qualification requirements. All requirements must /// be met in order for a Worker to accept the HIT. Additionally, other actions can be /// restricted using the ActionsGuarded field on each QualificationRequirement /// structure. /// /// public List QualificationRequirements { get { return this._qualificationRequirements; } set { this._qualificationRequirements = value; } } // Check to see if QualificationRequirements property is set internal bool IsSetQualificationRequirements() { return this._qualificationRequirements != null && this._qualificationRequirements.Count > 0; } /// /// Gets and sets the property Question. /// /// The data the Worker completing the HIT uses produce the results. This is either either /// a QuestionForm, HTMLQuestion or an ExternalQuestion data structure. /// /// public string Question { get { return this._question; } set { this._question = value; } } // Check to see if Question property is set internal bool IsSetQuestion() { return this._question != null; } /// /// Gets and sets the property RequesterAnnotation. /// /// An arbitrary data field the Requester who created the HIT can use. This field is /// visible only to the creator of the HIT. /// /// public string RequesterAnnotation { get { return this._requesterAnnotation; } set { this._requesterAnnotation = value; } } // Check to see if RequesterAnnotation property is set internal bool IsSetRequesterAnnotation() { return this._requesterAnnotation != null; } /// /// Gets and sets the property Reward. /// public string Reward { get { return this._reward; } set { this._reward = value; } } // Check to see if Reward property is set internal bool IsSetReward() { return this._reward != null; } /// /// Gets and sets the property Title. /// /// The title of the HIT. /// /// public string Title { get { return this._title; } set { this._title = value; } } // Check to see if Title property is set internal bool IsSetTitle() { return this._title != null; } } }