Class UpdateQualificationTypeRequest

    • Method Detail

      • qualificationTypeId

        public final String qualificationTypeId()

        The ID of the Qualification type to update.

        Returns:
        The ID of the Qualification type to update.
      • description

        public final String description()

        The new description of the Qualification type.

        Returns:
        The new description of the Qualification type.
      • test

        public final 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.

        Returns:
        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.

      • answerKey

        public final String answerKey()

        The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

        Returns:
        The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.
      • testDurationInSeconds

        public final Long testDurationInSeconds()

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

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

        public final Long retryDelayInSeconds()

        The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. 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 dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.

        Returns:
        The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. 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 dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.
      • autoGranted

        public final 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.

        Returns:
        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.

      • autoGrantedValue

        public final Integer autoGrantedValue()

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

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

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object