Class QualificationType
- java.lang.Object
-
- software.amazon.awssdk.services.mturk.model.QualificationType
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<QualificationType.Builder,QualificationType>
@Generated("software.amazon.awssdk:codegen") public final class QualificationType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QualificationType.Builder,QualificationType>
The QualificationType data structure represents a Qualification type, a description of a property of a Worker that must match the requirements of a HIT for the Worker to be able to accept the HIT. The type also describes how a Worker can obtain a Qualification of that type, such as through a Qualification test.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceQualificationType.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringanswerKey()The answers to the Qualification test specified in the Test parameter.BooleanautoGranted()Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.IntegerautoGrantedValue()The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true.static QualificationType.Builderbuilder()InstantcreationTime()The date and time the Qualification type was created.Stringdescription()A long description for the Qualification type.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()BooleanisRequestable()Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test.Stringkeywords()One or more words or phrases that describe theQualification type, separated by commas.Stringname()The name of the Qualification type.StringqualificationTypeId()A unique identifier for the Qualification type.QualificationTypeStatusqualificationTypeStatus()The status of the Qualification type.StringqualificationTypeStatusAsString()The status of the Qualification type.LongretryDelayInSeconds()The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again.List<SdkField<?>>sdkFields()static Class<? extends QualificationType.Builder>serializableBuilderClass()Stringtest()The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type.LongtestDurationInSeconds()The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.QualificationType.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
qualificationTypeId
public final String qualificationTypeId()
A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.
- Returns:
- A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.
-
creationTime
public final Instant creationTime()
The date and time the Qualification type was created.
- Returns:
- The date and time the Qualification type was created.
-
name
public final String name()
The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.
- Returns:
- The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.
-
description
public final String description()
A long description for the Qualification type.
- Returns:
- A long description for the Qualification type.
-
keywords
public final String keywords()
One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.
- Returns:
- One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.
-
qualificationTypeStatus
public final QualificationTypeStatus qualificationTypeStatus()
The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.
If the service returns an enum value that is not available in the current SDK version,
qualificationTypeStatuswill returnQualificationTypeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromqualificationTypeStatusAsString().- Returns:
- The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.
- See Also:
QualificationTypeStatus
-
qualificationTypeStatusAsString
public final String qualificationTypeStatusAsString()
The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.
If the service returns an enum value that is not available in the current SDK version,
qualificationTypeStatuswill returnQualificationTypeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromqualificationTypeStatusAsString().- Returns:
- The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.
- See Also:
QualificationTypeStatus
-
test
public final String test()
The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.
- Returns:
- The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.
-
testDurationInSeconds
public final Long testDurationInSeconds()
The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.
- Returns:
- The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.
-
answerKey
public final String answerKey()
The answers to the Qualification test specified in the Test parameter.
- Returns:
- The answers to the Qualification test specified in the Test parameter.
-
retryDelayInSeconds
public final Long retryDelayInSeconds()
The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once.
- Returns:
- The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once.
-
isRequestable
public final Boolean isRequestable()
Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False.
- Returns:
- Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False.
-
autoGranted
public final Boolean autoGranted()
Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.
- Returns:
- Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.
-
autoGrantedValue
public final Integer autoGrantedValue()
The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.
- Returns:
- The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.
-
toBuilder
public QualificationType.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<QualificationType.Builder,QualificationType>
-
builder
public static QualificationType.Builder builder()
-
serializableBuilderClass
public static Class<? extends QualificationType.Builder> serializableBuilderClass()
-
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.
-
-