Class: Aws::MTurk::Types::QualificationRequirement
- Inherits:
-
Struct
- Object
- Struct
- Aws::MTurk::Types::QualificationRequirement
- Defined in:
- gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb
Overview
The QualificationRequirement data structure describes a Qualification that a Worker must have before the Worker is allowed to accept a HIT. A requirement may optionally state that a Worker must have the Qualification in order to preview the HIT, or see the HIT in search results.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#actions_guarded ⇒ String
Setting this attribute prevents Workers whose Qualifications do not meet this QualificationRequirement from taking the specified action.
-
#comparator ⇒ String
The kind of comparison to make against a Qualification's value.
-
#integer_values ⇒ Array<Integer>
The integer value to compare against the Qualification's value.
-
#locale_values ⇒ Array<Types::Locale>
The locale value to compare against the Qualification's value.
-
#qualification_type_id ⇒ String
The ID of the Qualification type for the requirement.
-
#required_to_preview ⇒ Boolean
DEPRECATED: Use the
ActionsGuarded
field instead.
Instance Attribute Details
#actions_guarded ⇒ String
Setting this attribute prevents Workers whose Qualifications do not
meet this QualificationRequirement from taking the specified action.
Valid arguments include "Accept" (Worker cannot accept the HIT,
but can preview the HIT and see it in their search results),
"PreviewAndAccept" (Worker cannot accept or preview the HIT, but
can see the HIT in their search results), and
"DiscoverPreviewAndAccept" (Worker cannot accept, preview, or see
the HIT in their search results). It's possible for you to create a
HIT with multiple QualificationRequirements (which can have
different values for the ActionGuarded attribute). In this case, the
Worker is only permitted to perform an action when they have met all
QualificationRequirements guarding the action. The actions in the
order of least restrictive to most restrictive are Discover, Preview
and Accept. For example, if a Worker meets all
QualificationRequirements that are set to DiscoverPreviewAndAccept,
but do not meet all requirements that are set with PreviewAndAccept,
then the Worker will be able to Discover, i.e. see the HIT in their
search result, but will not be able to Preview or Accept the HIT.
ActionsGuarded should not be used in combination with the
RequiredToPreview
field.
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2084 class QualificationRequirement < Struct.new( :qualification_type_id, :comparator, :integer_values, :locale_values, :required_to_preview, :actions_guarded) SENSITIVE = [] include Aws::Structure end |
#comparator ⇒ String
The kind of comparison to make against a Qualification's value. You can compare a Qualification's value to an IntegerValue to see if it is LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or NotEqualTo the IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue. You can check to see if the value is In or NotIn a set of IntegerValue or LocaleValue values. Lastly, a Qualification requirement can also test if a Qualification Exists or DoesNotExist in the user's profile, regardless of its value.
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2084 class QualificationRequirement < Struct.new( :qualification_type_id, :comparator, :integer_values, :locale_values, :required_to_preview, :actions_guarded) SENSITIVE = [] include Aws::Structure end |
#integer_values ⇒ Array<Integer>
The integer value to compare against the Qualification's value. IntegerValue must not be present if Comparator is Exists or DoesNotExist. IntegerValue can only be used if the Qualification type has an integer value; it cannot be used with the Worker_Locale QualificationType ID. When performing a set comparison by using the In or the NotIn comparator, you can use up to 15 IntegerValue elements in a QualificationRequirement data structure.
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2084 class QualificationRequirement < Struct.new( :qualification_type_id, :comparator, :integer_values, :locale_values, :required_to_preview, :actions_guarded) SENSITIVE = [] include Aws::Structure end |
#locale_values ⇒ Array<Types::Locale>
The locale value to compare against the Qualification's value. The local value must be a valid ISO 3166 country code or supports ISO 3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale QualificationType ID. LocaleValue can only be used with the EqualTo, NotEqualTo, In, and NotIn comparators. You must only use a single LocaleValue element when using the EqualTo or NotEqualTo comparators. When performing a set comparison by using the In or the NotIn comparator, you can use up to 30 LocaleValue elements in a QualificationRequirement data structure.
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2084 class QualificationRequirement < Struct.new( :qualification_type_id, :comparator, :integer_values, :locale_values, :required_to_preview, :actions_guarded) SENSITIVE = [] include Aws::Structure end |
#qualification_type_id ⇒ String
The ID of the Qualification type for the requirement.
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2084 class QualificationRequirement < Struct.new( :qualification_type_id, :comparator, :integer_values, :locale_values, :required_to_preview, :actions_guarded) SENSITIVE = [] include Aws::Structure end |
#required_to_preview ⇒ Boolean
DEPRECATED: Use the ActionsGuarded
field instead. If
RequiredToPreview is true, the question data for the HIT will not be
shown when a Worker whose Qualifications do not meet this
requirement tries to preview the HIT. That is, a Worker's
Qualifications must meet all of the requirements for which
RequiredToPreview is true in order to preview the HIT. If a Worker
meets all of the requirements where RequiredToPreview is true (or if
there are no such requirements), but does not meet all of the
requirements for the HIT, the Worker will be allowed to preview the
HIT's question data, but will not be allowed to accept and complete
the HIT. The default is false. This should not be used in
combination with the ActionsGuarded
field.
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 |
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2084 class QualificationRequirement < Struct.new( :qualification_type_id, :comparator, :integer_values, :locale_values, :required_to_preview, :actions_guarded) SENSITIVE = [] include Aws::Structure end |