/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace MTurk { namespace Model { /** *

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.

See Also:

AWS * API Reference

*/ class QualificationRequirement { public: AWS_MTURK_API QualificationRequirement(); AWS_MTURK_API QualificationRequirement(Aws::Utils::Json::JsonView jsonValue); AWS_MTURK_API QualificationRequirement& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_MTURK_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The ID of the Qualification type for the requirement.

*/ inline const Aws::String& GetQualificationTypeId() const{ return m_qualificationTypeId; } /** *

The ID of the Qualification type for the requirement.

*/ inline bool QualificationTypeIdHasBeenSet() const { return m_qualificationTypeIdHasBeenSet; } /** *

The ID of the Qualification type for the requirement.

*/ inline void SetQualificationTypeId(const Aws::String& value) { m_qualificationTypeIdHasBeenSet = true; m_qualificationTypeId = value; } /** *

The ID of the Qualification type for the requirement.

*/ inline void SetQualificationTypeId(Aws::String&& value) { m_qualificationTypeIdHasBeenSet = true; m_qualificationTypeId = std::move(value); } /** *

The ID of the Qualification type for the requirement.

*/ inline void SetQualificationTypeId(const char* value) { m_qualificationTypeIdHasBeenSet = true; m_qualificationTypeId.assign(value); } /** *

The ID of the Qualification type for the requirement.

*/ inline QualificationRequirement& WithQualificationTypeId(const Aws::String& value) { SetQualificationTypeId(value); return *this;} /** *

The ID of the Qualification type for the requirement.

*/ inline QualificationRequirement& WithQualificationTypeId(Aws::String&& value) { SetQualificationTypeId(std::move(value)); return *this;} /** *

The ID of the Qualification type for the requirement.

*/ inline QualificationRequirement& WithQualificationTypeId(const char* value) { SetQualificationTypeId(value); return *this;} /** *

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.

*/ inline const Comparator& GetComparator() const{ return m_comparator; } /** *

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.

*/ inline bool ComparatorHasBeenSet() const { return m_comparatorHasBeenSet; } /** *

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.

*/ inline void SetComparator(const Comparator& value) { m_comparatorHasBeenSet = true; m_comparator = value; } /** *

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.

*/ inline void SetComparator(Comparator&& value) { m_comparatorHasBeenSet = true; m_comparator = std::move(value); } /** *

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.

*/ inline QualificationRequirement& WithComparator(const Comparator& value) { SetComparator(value); return *this;} /** *

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.

*/ inline QualificationRequirement& WithComparator(Comparator&& value) { SetComparator(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Vector& GetIntegerValues() const{ return m_integerValues; } /** *

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.

*/ inline bool IntegerValuesHasBeenSet() const { return m_integerValuesHasBeenSet; } /** *

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.

*/ inline void SetIntegerValues(const Aws::Vector& value) { m_integerValuesHasBeenSet = true; m_integerValues = value; } /** *

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.

*/ inline void SetIntegerValues(Aws::Vector&& value) { m_integerValuesHasBeenSet = true; m_integerValues = std::move(value); } /** *

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.

*/ inline QualificationRequirement& WithIntegerValues(const Aws::Vector& value) { SetIntegerValues(value); return *this;} /** *

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.

*/ inline QualificationRequirement& WithIntegerValues(Aws::Vector&& value) { SetIntegerValues(std::move(value)); return *this;} /** *

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.

*/ inline QualificationRequirement& AddIntegerValues(int value) { m_integerValuesHasBeenSet = true; m_integerValues.push_back(value); return *this; } /** *

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.

*/ inline const Aws::Vector& GetLocaleValues() const{ return m_localeValues; } /** *

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.

*/ inline bool LocaleValuesHasBeenSet() const { return m_localeValuesHasBeenSet; } /** *

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.

*/ inline void SetLocaleValues(const Aws::Vector& value) { m_localeValuesHasBeenSet = true; m_localeValues = value; } /** *

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.

*/ inline void SetLocaleValues(Aws::Vector&& value) { m_localeValuesHasBeenSet = true; m_localeValues = std::move(value); } /** *

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.

*/ inline QualificationRequirement& WithLocaleValues(const Aws::Vector& value) { SetLocaleValues(value); return *this;} /** *

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.

*/ inline QualificationRequirement& WithLocaleValues(Aws::Vector&& value) { SetLocaleValues(std::move(value)); return *this;} /** *

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.

*/ inline QualificationRequirement& AddLocaleValues(const Locale& value) { m_localeValuesHasBeenSet = true; m_localeValues.push_back(value); return *this; } /** *

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.

*/ inline QualificationRequirement& AddLocaleValues(Locale&& value) { m_localeValuesHasBeenSet = true; m_localeValues.push_back(std::move(value)); return *this; } /** *

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.

*/ inline const HITAccessActions& GetActionsGuarded() const{ return m_actionsGuarded; } /** *

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.

*/ inline bool ActionsGuardedHasBeenSet() const { return m_actionsGuardedHasBeenSet; } /** *

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.

*/ inline void SetActionsGuarded(const HITAccessActions& value) { m_actionsGuardedHasBeenSet = true; m_actionsGuarded = value; } /** *

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.

*/ inline void SetActionsGuarded(HITAccessActions&& value) { m_actionsGuardedHasBeenSet = true; m_actionsGuarded = std::move(value); } /** *

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.

*/ inline QualificationRequirement& WithActionsGuarded(const HITAccessActions& value) { SetActionsGuarded(value); return *this;} /** *

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.

*/ inline QualificationRequirement& WithActionsGuarded(HITAccessActions&& value) { SetActionsGuarded(std::move(value)); return *this;} private: Aws::String m_qualificationTypeId; bool m_qualificationTypeIdHasBeenSet = false; Comparator m_comparator; bool m_comparatorHasBeenSet = false; Aws::Vector m_integerValues; bool m_integerValuesHasBeenSet = false; Aws::Vector m_localeValues; bool m_localeValuesHasBeenSet = false; HITAccessActions m_actionsGuarded; bool m_actionsGuardedHasBeenSet = false; }; } // namespace Model } // namespace MTurk } // namespace Aws