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

Interface SendBonusRequest.Builder

    • Method Detail

      • workerId

        SendBonusRequest.Builder workerId​(String workerId)

        The ID of the Worker being paid the bonus.

        Parameters:
        workerId - The ID of the Worker being paid the bonus.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • bonusAmount

        SendBonusRequest.Builder bonusAmount​(String bonusAmount)

        The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.

        Parameters:
        bonusAmount - The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assignmentId

        SendBonusRequest.Builder assignmentId​(String assignmentId)

        The ID of the assignment for which this bonus is paid.

        Parameters:
        assignmentId - The ID of the assignment for which this bonus is paid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reason

        SendBonusRequest.Builder reason​(String reason)

        A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.

        Parameters:
        reason - A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • uniqueRequestToken

        SendBonusRequest.Builder uniqueRequestToken​(String uniqueRequestToken)

        A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.

        Parameters:
        uniqueRequestToken - A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.