You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MTurk::Types::QualificationRequirement

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing QualificationRequirement as input to an Aws::Client method, you can use a vanilla Hash:

{
  qualification_type_id: "String", # required
  comparator: "LessThan", # required, accepts LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, NotEqualTo, Exists, DoesNotExist, In, NotIn
  integer_values: [1],
  locale_values: [
    {
      country: "CountryParameters", # required
      subdivision: "CountryParameters",
    },
  ],
  required_to_preview: false,
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#comparatorString

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.

Possible values:

  • LessThan
  • LessThanOrEqualTo
  • GreaterThan
  • GreaterThanOrEqualTo
  • EqualTo
  • NotEqualTo
  • Exists
  • DoesNotExist
  • In
  • NotIn

Returns:

  • (String)

    The kind of comparison to make against a Qualification\'s value.

#integer_valuesArray<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.

Returns:

  • (Array<Integer>)

    The integer value to compare against the Qualification\'s value.

#locale_valuesArray<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.

Returns:

  • (Array<Types::Locale>)

    The locale value to compare against the Qualification\'s value.

#qualification_type_idString

The ID of the Qualification type for the requirement.

Returns:

  • (String)

    The ID of the Qualification type for the requirement.

#required_to_previewBoolean

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

Returns:

  • (Boolean)

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