Class SendBonusRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mturk.model.MTurkRequest
software.amazon.awssdk.services.mturk.model.SendBonusRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SendBonusRequest.Builder,SendBonusRequest>
@Generated("software.amazon.awssdk:codegen") public final class SendBonusRequest extends MTurkRequest implements ToCopyableBuilder<SendBonusRequest.Builder,SendBonusRequest>

  • Method Details

    • workerId

      public final String workerId()

      The ID of the Worker being paid the bonus.

      Returns:
      The ID of the Worker being paid the bonus.

    • bonusAmount

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

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

    • assignmentId

      public final String assignmentId()

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

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

    • reason

      public final String reason()

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

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

    • uniqueRequestToken

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

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

    • toBuilder

      public SendBonusRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SendBonusRequest.Builder,SendBonusRequest>
      Specified by:
      toBuilder in class MTurkRequest
      Returns:
      a builder for type T

    • builder

      public static SendBonusRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SendBonusRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.