Interface SendBonusRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SendBonusRequest.Builder,
,SendBonusRequest> MTurkRequest.Builder
,SdkBuilder<SendBonusRequest.Builder,
,SendBonusRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SendBonusRequest
-
Method Summary
Modifier and TypeMethodDescriptionassignmentId
(String assignmentId) The ID of the assignment for which this bonus is paid.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).overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.A message that explains the reason for the bonus payment.uniqueRequestToken
(String uniqueRequestToken) A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses.The ID of the Worker being paid the bonus.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.mturk.model.MTurkRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
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.
-
overrideConfiguration
SendBonusRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SendBonusRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-