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("software.amazon.awssdk:codegen") public final class CreateHitTypeRequest extends MTurkRequest implements ToCopyableBuilder<CreateHitTypeRequest.Builder,CreateHitTypeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateHitTypeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description LongassignmentDurationInSeconds()The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.LongautoApprovalDelayInSeconds()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.Builderbuilder()Stringdescription()A general description of the HIT.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasQualificationRequirements()For responses, this returns true if the service returned a value for the QualificationRequirements property.Stringkeywords()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.Stringreward()The amount of money the Requester will pay a Worker for successfully completing the HIT.List<SdkField<?>>sdkFields()static Class<? extends CreateHitTypeRequest.Builder>serializableBuilderClass()Stringtitle()The title of the HIT.CreateHitTypeRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, 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()
For responses, this returns true if the service returned a value for the QualificationRequirements property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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
ActionsGuardedfield on eachQualificationRequirementstructure.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasQualificationRequirements()method.- 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
ActionsGuardedfield on eachQualificationRequirementstructure.
-
toBuilder
public CreateHitTypeRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateHitTypeRequest.Builder,CreateHitTypeRequest>- Specified by:
toBuilderin classMTurkRequest
-
builder
public static CreateHitTypeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateHitTypeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-