software.amazon.awssdk.services.mturk.model

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(value="software.amazon.awssdk:codegen")
public final class SendBonusRequest
extends MTurkRequest
implements ToCopyableBuilder<SendBonusRequest.Builder,SendBonusRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SendBonusRequest.Builder

Method Summary

Modifier and Type	Method and 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	reason() A message that explains the reason for the bonus payment.
List<SdkField<?>>	sdkFields()
static Class<? extends SendBonusRequest.Builder>	serializableBuilderClass()
SendBonusRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<SendBonusRequest.Builder,SendBonusRequest>

Specified by:

toBuilder in class MTurkRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo