Package software.amazon.awssdk.services.mturk.model

Class CreateQualificationTypeRequest

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.CreateQualificationTypeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateQualificationTypeRequest.Builder,CreateQualificationTypeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateQualificationTypeRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	answerKey()	The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.
Boolean	autoGranted()	Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.
Integer	autoGrantedValue()	The Qualification value to use for automatically granted Qualifications.
static CreateQualificationTypeRequest.Builder	builder()
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()
String	keywords()	One or more words or phrases that describe the Qualification type, separated by commas.
String	name()	The name you give to the Qualification type.
QualificationTypeStatus	qualificationTypeStatus()	The initial status of the Qualification type.
String	qualificationTypeStatusAsString()	The initial status of the Qualification type.
Long	retryDelayInSeconds()	The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateQualificationTypeRequest.Builder>	serializableBuilderClass()
String	test()	The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type.
Long	testDurationInSeconds()	The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.
CreateQualificationTypeRequest.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types.

Returns:

The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types.

keywords

public final String keywords()

One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search.

Returns:

One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search.

description

public final String description()

A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type.

Returns:

A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type.

qualificationTypeStatus

public final QualificationTypeStatus qualificationTypeStatus()

The initial status of the Qualification type.

Constraints: 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 initial status of the Qualification type.

Constraints: Valid values are: Active | Inactive

See Also:

QualificationTypeStatus

qualificationTypeStatusAsString

public final String qualificationTypeStatusAsString()

The initial status of the Qualification type.

Constraints: 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 initial status of the Qualification type.

Constraints: Valid values are: Active | Inactive

See Also:

QualificationTypeStatus

retryDelayInSeconds

public final Long retryDelayInSeconds()

The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.

Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled.

Returns:

The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.

Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled.

test

public final String test()

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

Returns:

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

answerKey

public final String answerKey()

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

Constraints: Must not be longer than 65535 bytes.

Constraints: None. If not specified, you must process Qualification requests manually.

Returns:

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

Constraints: Must not be longer than 65535 bytes.

Constraints: None. If not specified, you must process Qualification requests manually.

testDurationInSeconds

public final Long testDurationInSeconds()

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

Returns:

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

autoGranted

public final Boolean autoGranted()

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Constraints: If the Test parameter is specified, this parameter cannot be true.

Returns:

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Constraints: If the Test parameter is specified, this parameter cannot be true.

autoGrantedValue

public final Integer autoGrantedValue()

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

Returns:

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

toBuilder

public CreateQualificationTypeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateQualificationTypeRequest.Builder,CreateQualificationTypeRequest>

Specified by:

toBuilder in class MTurkRequest

builder

public static CreateQualificationTypeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateQualificationTypeRequest.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)

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo