Package software.amazon.awssdk.services.mturk.model

Interface QualificationType.Builder

    • Method Detail

      • qualificationTypeId

        QualificationType.Builder qualificationTypeId​(String qualificationTypeId)

        A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

        Parameters:
        qualificationTypeId - A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

        QualificationType.Builder creationTime​(Instant creationTime)

        The date and time the Qualification type was created.

        Parameters:
        creationTime - The date and time the Qualification type was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        QualificationType.Builder name​(String name)

        The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.

        Parameters:
        name - The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        QualificationType.Builder description​(String description)

        A long description for the Qualification type.

        Parameters:
        description - A long description for the Qualification type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keywords

        QualificationType.Builder keywords​(String keywords)

        One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

        Parameters:
        keywords - One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • qualificationTypeStatus

        QualificationType.Builder qualificationTypeStatus​(String qualificationTypeStatus)

        The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.

        Parameters:
        qualificationTypeStatus - The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QualificationTypeStatus, QualificationTypeStatus

      • qualificationTypeStatus

        QualificationType.Builder qualificationTypeStatus​(QualificationTypeStatus qualificationTypeStatus)

        The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.

        Parameters:
        qualificationTypeStatus - The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QualificationTypeStatus, QualificationTypeStatus

      • test

        QualificationType.Builder test​(String test)

        The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.

        Parameters:
        test - The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • testDurationInSeconds

        QualificationType.Builder testDurationInSeconds​(Long testDurationInSeconds)

        The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

        Parameters:
        testDurationInSeconds - The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • answerKey

        QualificationType.Builder answerKey​(String answerKey)

        The answers to the Qualification test specified in the Test parameter.

        Parameters:
        answerKey - The answers to the Qualification test specified in the Test parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retryDelayInSeconds

        QualificationType.Builder retryDelayInSeconds​(Long retryDelayInSeconds)

        The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once.

        Parameters:
        retryDelayInSeconds - The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isRequestable

        QualificationType.Builder isRequestable​(Boolean isRequestable)

        Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False.

        Parameters:
        isRequestable - Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoGranted

        QualificationType.Builder autoGranted​(Boolean autoGranted)

        Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

        Parameters:
        autoGranted - Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoGrantedValue

        QualificationType.Builder autoGrantedValue​(Integer autoGrantedValue)

        The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

        Parameters:
        autoGrantedValue - The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.
        Returns:
        Returns a reference to this object so that method calls can be chained together.