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:

ToCopyableBuilder<CreateQualificationTypeRequest.Builder,CreateQualificationTypeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateQualificationTypeRequest.Builder

Method Summary

Modifier and Type	Method and 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)
<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()
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.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

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

name

public 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 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 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 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 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 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 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 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 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 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 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()

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

Specified by:

toBuilder in class MTurkRequest

Returns:

a builder for type T

builder

public static CreateQualificationTypeRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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