Struct aws_sdk_mturk::model::Hit

#[non_exhaustive]
pub struct Hit {

    pub hit_id: Option<String>,
    pub hit_type_id: Option<String>,
    pub hit_group_id: Option<String>,
    pub hit_layout_id: Option<String>,
    pub creation_time: Option<DateTime>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub question: Option<String>,
    pub keywords: Option<String>,
    pub hit_status: Option<HitStatus>,
    pub max_assignments: Option<i32>,
    pub reward: Option<String>,
    pub auto_approval_delay_in_seconds: Option<i64>,
    pub expiration: Option<DateTime>,
    pub assignment_duration_in_seconds: Option<i64>,
    pub requester_annotation: Option<String>,
    pub qualification_requirements: Option<Vec<QualificationRequirement>>,
    pub hit_review_status: Option<HitReviewStatus>,
    pub number_of_assignments_pending: Option<i32>,
    pub number_of_assignments_available: Option<i32>,
    pub number_of_assignments_completed: Option<i32>,
}

The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hit_id: Option<String>

A unique identifier for the HIT.

hit_type_id: Option<String>

The ID of the HIT type of this HIT

hit_group_id: Option<String>

The ID of the HIT Group of this HIT.

hit_layout_id: Option<String>

The ID of the HIT Layout of this HIT.

creation_time: Option<DateTime>

The date and time the HIT was created.

title: Option<String>

The title of the HIT.

description: Option<String>

A general description of the HIT.

question: Option<String>

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

keywords: Option<String>

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.

hit_status: Option<HitStatus>

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

max_assignments: Option<i32>

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

reward: Option<String>

A string representing a currency amount.

auto_approval_delay_in_seconds: Option<i64>

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.

expiration: Option<DateTime>

The date and time the HIT expires.

assignment_duration_in_seconds: Option<i64>

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

requester_annotation: Option<String>

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

qualification_requirements: Option<Vec<QualificationRequirement>>

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.

hit_review_status: Option<HitReviewStatus>

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

number_of_assignments_pending: Option<i32>

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.

number_of_assignments_available: Option<i32>

The number of assignments for this HIT that are available for Workers to accept.

number_of_assignments_completed: Option<i32>

The number of assignments for this HIT that have been approved or rejected.

Implementations

impl Hit

pub fn hit_id(&self) -> Option<&str>

A unique identifier for the HIT.

pub fn hit_type_id(&self) -> Option<&str>

The ID of the HIT type of this HIT

pub fn hit_group_id(&self) -> Option<&str>

The ID of the HIT Group of this HIT.

pub fn hit_layout_id(&self) -> Option<&str>

The ID of the HIT Layout of this HIT.

pub fn creation_time(&self) -> Option<&DateTime>

The date and time the HIT was created.

pub fn title(&self) -> Option<&str>

The title of the HIT.

pub fn description(&self) -> Option<&str>

A general description of the HIT.

pub fn question(&self) -> Option<&str>

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

pub fn keywords(&self) -> Option<&str>

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.

pub fn hit_status(&self) -> Option<&HitStatus>

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

pub fn max_assignments(&self) -> Option<i32>

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

pub fn reward(&self) -> Option<&str>

A string representing a currency amount.

pub fn auto_approval_delay_in_seconds(&self) -> Option<i64>

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.

pub fn expiration(&self) -> Option<&DateTime>

The date and time the HIT expires.

pub fn assignment_duration_in_seconds(&self) -> Option<i64>

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

pub fn requester_annotation(&self) -> Option<&str>

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

pub fn qualification_requirements(&self) -> Option<&[QualificationRequirement]>

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.

pub fn hit_review_status(&self) -> Option<&HitReviewStatus>

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

pub fn number_of_assignments_pending(&self) -> Option<i32>

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.

pub fn number_of_assignments_available(&self) -> Option<i32>

The number of assignments for this HIT that are available for Workers to accept.

pub fn number_of_assignments_completed(&self) -> Option<i32>

The number of assignments for this HIT that have been approved or rejected.

impl Hit

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Hit

Trait Implementations

impl Clone for Hit

fn clone(&self) -> Hit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Hit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Hit> for Hit

fn eq(&self, other: &Hit) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Hit) -> bool

This method tests for !=.

impl StructuralPartialEq for Hit