QualificationType (AWS Java SDK :: Services :: Amazon Mechanical Turk Requester 2.20.68 API)

java.lang.Object
- software.amazon.awssdk.services.mturk.model.QualificationType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QualificationType.Builder,QualificationType>
```
@Generated(value="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 and Description

static interface QualificationType.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`QualificationType.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`answerKey()` The answers to the Qualification test specified in the Test parameter.
`Boolean`	`autoGranted()` Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.
`Integer`	`autoGrantedValue()` The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true.
`static QualificationType.Builder`	`builder()`
`Instant`	`creationTime()` The date and time the Qualification type was created.
`String`	`description()` A long description for the Qualification type.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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.
`String`	`keywords()` One or more words or phrases that describe theQualification type, separated by commas.
`String`	`name()` The name of the Qualification type.
`String`	`qualificationTypeId()` A unique identifier for the Qualification type.
`QualificationTypeStatus`	`qualificationTypeStatus()` The status of the Qualification type.
`String`	`qualificationTypeStatusAsString()` The status of the Qualification type.
`Long`	`retryDelayInSeconds()` 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()`
`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.
`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.
`QualificationType.Builder`	`toBuilder()`
`String`	`toString()` 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, qualificationTypeStatus will return QualificationTypeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualificationTypeStatusAsString().
    
    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, qualificationTypeStatus will return QualificationTypeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from qualificationTypeStatusAsString().
    
    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:
    
    toBuilder in interface ToCopyableBuilder<QualificationType.Builder,QualificationType>
  - builder
```
public static QualificationType.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends QualificationType.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class QualificationType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

qualificationTypeId

creationTime

name

description

keywords

qualificationTypeStatus

qualificationTypeStatusAsString

test

testDurationInSeconds

answerKey

retryDelayInSeconds

isRequestable

autoGranted

autoGrantedValue

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields