Class CreateQualificationTypeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateQualificationTypeRequest.Builder,
CreateQualificationTypeRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.final Boolean
Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.final Integer
The Qualification value to use for automatically granted Qualifications.builder()
final String
A long description for the Qualification type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
keywords()
One or more words or phrases that describe the Qualification type, separated by commas.final String
name()
The name you give to the Qualification type.final QualificationTypeStatus
The initial status of the Qualification type.final String
The initial status of the Qualification type.final Long
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> final String
test()
The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type.final Long
The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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 returnQualificationTypeStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromqualificationTypeStatusAsString()
.- Returns:
- The initial status of the Qualification type.
Constraints: Valid values are: Active | Inactive
- See Also:
-
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 returnQualificationTypeStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromqualificationTypeStatusAsString()
.- Returns:
- The initial status of the Qualification type.
Constraints: Valid values are: Active | Inactive
- See Also:
-
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
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
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
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
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
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
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 interfaceToCopyableBuilder<CreateQualificationTypeRequest.Builder,
CreateQualificationTypeRequest> - Specified by:
toBuilder
in classMTurkRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFields
-