software.amazon.awssdk.services.mturk.model

Class CreateHitTypeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mturk.model.MTurkRequest

software.amazon.awssdk.services.mturk.model.CreateHitTypeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateHitTypeRequest.Builder,CreateHitTypeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateHitTypeRequest
extends MTurkRequest
implements ToCopyableBuilder<CreateHitTypeRequest.Builder,CreateHitTypeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateHitTypeRequest.Builder

Method Summary

Modifier and Type	Method and Description
Long	assignmentDurationInSeconds() The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.
Long	autoApprovalDelayInSeconds() The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.
static CreateHitTypeRequest.Builder	builder()
String	description() A general description of the HIT.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasQualificationRequirements() Returns true if the QualificationRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	keywords() One or more words or phrases that describe the HIT, separated by commas.
List<QualificationRequirement>	qualificationRequirements() Conditions that a Worker's Qualifications must meet in order to accept the HIT.
String	reward() The amount of money the Requester will pay a Worker for successfully completing the HIT.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateHitTypeRequest.Builder>	serializableBuilderClass()
String	title() The title of the HIT.
CreateHitTypeRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

autoApprovalDelayInSeconds

public final Long autoApprovalDelayInSeconds()

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

Returns:

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

assignmentDurationInSeconds

public final Long assignmentDurationInSeconds()

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

Returns:

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

reward

public final String reward()

The amount of money the Requester will pay a Worker for successfully completing the HIT.

Returns:

The amount of money the Requester will pay a Worker for successfully completing the HIT.

title

public final String title()

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

Returns:

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

keywords

public final String keywords()

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

Returns:

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

description

public final String description()

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

Returns:

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

hasQualificationRequirements

public final boolean hasQualificationRequirements()

Returns true if the QualificationRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

qualificationRequirements

public final List<QualificationRequirement> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasQualificationRequirements() to see if a value was sent in this field.

Returns:

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.

toBuilder

public CreateHitTypeRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateHitTypeRequest.Builder,CreateHitTypeRequest>

Specified by:

toBuilder in class MTurkRequest

Returns:

a builder for type T

builder

public static CreateHitTypeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateHitTypeRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.