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

Class SendBonusRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.mturk.model.SendBonusRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SendBonusRequest.Builder,SendBonusRequest>

@Generated("software.amazon.awssdk:codegen")
public class SendBonusRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<SendBonusRequest.Builder,SendBonusRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SendBonusRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	assignmentId()	The ID of the assignment for which this bonus is paid.
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).
static SendBonusRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	reason()	A message that explains the reason for the bonus payment.
static Class<? extends SendBonusRequest.Builder>	serializableBuilderClass()
SendBonusRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	uniqueRequestToken()	A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses.
String	workerId()	The ID of the Worker being paid the bonus.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

workerId

public String workerId()

The ID of the Worker being paid the bonus.

Returns:

The ID of the Worker being paid the bonus.

bonusAmount

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

Returns:

a builder for type T

builder

public static SendBonusRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object