software.amazon.awssdk.services.mturk.model

Class UpdateQualificationTypeRequest

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

All Implemented Interfaces:

ToCopyableBuilder<UpdateQualificationTypeRequest.Builder,UpdateQualificationTypeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateQualificationTypeRequest.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 UpdateQualificationTypeRequest.Builder	builder()
String	description() The new description of 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	qualificationTypeId() The ID of the Qualification type to update.
QualificationTypeStatus	qualificationTypeStatus() The new status of the Qualification type - Active | Inactive
String	qualificationTypeStatusAsString() The new status of the Qualification type - Active | Inactive
Long	retryDelayInSeconds() The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request.
static Class<? extends UpdateQualificationTypeRequest.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.
UpdateQualificationTypeRequest.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

qualificationTypeId

public String qualificationTypeId()

The ID of the Qualification type to update.

Returns:

The ID of the Qualification type to update.

description

public String description()

The new description of the Qualification type.

Returns:

The new description of the Qualification type.

qualificationTypeStatus

public QualificationTypeStatus qualificationTypeStatus()

The new status of the Qualification type - 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 new status of the Qualification type - Active | Inactive

See Also:

QualificationTypeStatus

qualificationTypeStatusAsString

public String qualificationTypeStatusAsString()

The new status of the Qualification type - 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 new status of the Qualification type - Active | Inactive

See Also:

QualificationTypeStatus

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.

Returns:

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

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.

retryDelayInSeconds

public Long retryDelayInSeconds()

The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. 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 dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.

Returns:

The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. 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 dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.

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

Specified by:

toBuilder in class MTurkRequest

Returns:

a builder for type T

builder

public static UpdateQualificationTypeRequest.Builder builder()

serializableBuilderClass

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