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

Interface CreateQualificationTypeRequest.Builder

    • Method Detail

      • name

        CreateQualificationTypeRequest.Builder name​(String 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • keywords

        CreateQualificationTypeRequest.Builder keywords​(String 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateQualificationTypeRequest.Builder description​(String 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • qualificationTypeStatus

        CreateQualificationTypeRequest.Builder qualificationTypeStatus​(String qualificationTypeStatus)

        The initial status of the Qualification type.

        Constraints: Valid values are: Active | Inactive

        Parameters:
        qualificationTypeStatus - The initial status of the Qualification type.

        Constraints: Valid values are: Active | Inactive

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QualificationTypeStatus, QualificationTypeStatus

      • retryDelayInSeconds

        CreateQualificationTypeRequest.Builder retryDelayInSeconds​(Long 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • test

        CreateQualificationTypeRequest.Builder test​(String 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • answerKey

        CreateQualificationTypeRequest.Builder answerKey​(String 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • testDurationInSeconds

        CreateQualificationTypeRequest.Builder testDurationInSeconds​(Long testDurationInSeconds)

        The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

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

      • autoGranted

        CreateQualificationTypeRequest.Builder autoGranted​(Boolean 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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • autoGrantedValue

        CreateQualificationTypeRequest.Builder autoGrantedValue​(Integer autoGrantedValue)

        The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

        Parameters:
        autoGrantedValue - The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.
        Returns:
        Returns a reference to this object so that method calls can be chained together.