software.amazon.awssdk.services.mturk.MTurkAsyncClient Maven / Gradle / Ivy
Show all versions of mturk Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.mturk;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.mturk.model.AcceptQualificationRequestRequest;
import software.amazon.awssdk.services.mturk.model.AcceptQualificationRequestResponse;
import software.amazon.awssdk.services.mturk.model.ApproveAssignmentRequest;
import software.amazon.awssdk.services.mturk.model.ApproveAssignmentResponse;
import software.amazon.awssdk.services.mturk.model.AssociateQualificationWithWorkerRequest;
import software.amazon.awssdk.services.mturk.model.AssociateQualificationWithWorkerResponse;
import software.amazon.awssdk.services.mturk.model.CreateAdditionalAssignmentsForHitRequest;
import software.amazon.awssdk.services.mturk.model.CreateAdditionalAssignmentsForHitResponse;
import software.amazon.awssdk.services.mturk.model.CreateHitRequest;
import software.amazon.awssdk.services.mturk.model.CreateHitResponse;
import software.amazon.awssdk.services.mturk.model.CreateHitTypeRequest;
import software.amazon.awssdk.services.mturk.model.CreateHitTypeResponse;
import software.amazon.awssdk.services.mturk.model.CreateHitWithHitTypeRequest;
import software.amazon.awssdk.services.mturk.model.CreateHitWithHitTypeResponse;
import software.amazon.awssdk.services.mturk.model.CreateQualificationTypeRequest;
import software.amazon.awssdk.services.mturk.model.CreateQualificationTypeResponse;
import software.amazon.awssdk.services.mturk.model.CreateWorkerBlockRequest;
import software.amazon.awssdk.services.mturk.model.CreateWorkerBlockResponse;
import software.amazon.awssdk.services.mturk.model.DeleteHitRequest;
import software.amazon.awssdk.services.mturk.model.DeleteHitResponse;
import software.amazon.awssdk.services.mturk.model.DeleteQualificationTypeRequest;
import software.amazon.awssdk.services.mturk.model.DeleteQualificationTypeResponse;
import software.amazon.awssdk.services.mturk.model.DeleteWorkerBlockRequest;
import software.amazon.awssdk.services.mturk.model.DeleteWorkerBlockResponse;
import software.amazon.awssdk.services.mturk.model.DisassociateQualificationFromWorkerRequest;
import software.amazon.awssdk.services.mturk.model.DisassociateQualificationFromWorkerResponse;
import software.amazon.awssdk.services.mturk.model.GetAccountBalanceRequest;
import software.amazon.awssdk.services.mturk.model.GetAccountBalanceResponse;
import software.amazon.awssdk.services.mturk.model.GetAssignmentRequest;
import software.amazon.awssdk.services.mturk.model.GetAssignmentResponse;
import software.amazon.awssdk.services.mturk.model.GetFileUploadUrlRequest;
import software.amazon.awssdk.services.mturk.model.GetFileUploadUrlResponse;
import software.amazon.awssdk.services.mturk.model.GetHitRequest;
import software.amazon.awssdk.services.mturk.model.GetHitResponse;
import software.amazon.awssdk.services.mturk.model.GetQualificationScoreRequest;
import software.amazon.awssdk.services.mturk.model.GetQualificationScoreResponse;
import software.amazon.awssdk.services.mturk.model.GetQualificationTypeRequest;
import software.amazon.awssdk.services.mturk.model.GetQualificationTypeResponse;
import software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest;
import software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse;
import software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest;
import software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse;
import software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest;
import software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse;
import software.amazon.awssdk.services.mturk.model.ListHiTsRequest;
import software.amazon.awssdk.services.mturk.model.ListHiTsResponse;
import software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest;
import software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse;
import software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest;
import software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse;
import software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest;
import software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse;
import software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest;
import software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse;
import software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest;
import software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse;
import software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest;
import software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse;
import software.amazon.awssdk.services.mturk.model.NotifyWorkersRequest;
import software.amazon.awssdk.services.mturk.model.NotifyWorkersResponse;
import software.amazon.awssdk.services.mturk.model.RejectAssignmentRequest;
import software.amazon.awssdk.services.mturk.model.RejectAssignmentResponse;
import software.amazon.awssdk.services.mturk.model.RejectQualificationRequestRequest;
import software.amazon.awssdk.services.mturk.model.RejectQualificationRequestResponse;
import software.amazon.awssdk.services.mturk.model.SendBonusRequest;
import software.amazon.awssdk.services.mturk.model.SendBonusResponse;
import software.amazon.awssdk.services.mturk.model.SendTestEventNotificationRequest;
import software.amazon.awssdk.services.mturk.model.SendTestEventNotificationResponse;
import software.amazon.awssdk.services.mturk.model.UpdateExpirationForHitRequest;
import software.amazon.awssdk.services.mturk.model.UpdateExpirationForHitResponse;
import software.amazon.awssdk.services.mturk.model.UpdateHitReviewStatusRequest;
import software.amazon.awssdk.services.mturk.model.UpdateHitReviewStatusResponse;
import software.amazon.awssdk.services.mturk.model.UpdateHitTypeOfHitRequest;
import software.amazon.awssdk.services.mturk.model.UpdateHitTypeOfHitResponse;
import software.amazon.awssdk.services.mturk.model.UpdateNotificationSettingsRequest;
import software.amazon.awssdk.services.mturk.model.UpdateNotificationSettingsResponse;
import software.amazon.awssdk.services.mturk.model.UpdateQualificationTypeRequest;
import software.amazon.awssdk.services.mturk.model.UpdateQualificationTypeResponse;
import software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher;
import software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher;
import software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher;
import software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher;
import software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher;
import software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher;
import software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher;
import software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher;
import software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher;
import software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher;
/**
* Service client for accessing Amazon MTurk asynchronously. This can be created using the static {@link #builder()}
* method.
*
* Amazon Mechanical Turk API Reference
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface MTurkAsyncClient extends SdkClient {
String SERVICE_NAME = "mturk-requester";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "mturk-requester";
/**
* Create a {@link MTurkAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static MTurkAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link MTurkAsyncClient}.
*/
static MTurkAsyncClientBuilder builder() {
return new DefaultMTurkAsyncClientBuilder();
}
/**
*
* The AcceptQualificationRequest operation approves a Worker's request for a Qualification.
*
*
* Only the owner of the Qualification type can grant a Qualification request for that type.
*
*
* A successful request for the AcceptQualificationRequest operation returns with no errors and an
* empty body.
*
*
* @param acceptQualificationRequestRequest
* @return A Java Future containing the result of the AcceptQualificationRequest operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.AcceptQualificationRequest
* @see AWS API Documentation
*/
default CompletableFuture acceptQualificationRequest(
AcceptQualificationRequestRequest acceptQualificationRequestRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The AcceptQualificationRequest operation approves a Worker's request for a Qualification.
*
*
* Only the owner of the Qualification type can grant a Qualification request for that type.
*
*
* A successful request for the AcceptQualificationRequest operation returns with no errors and an
* empty body.
*
*
*
* This is a convenience which creates an instance of the {@link AcceptQualificationRequestRequest.Builder} avoiding
* the need to create one manually via {@link AcceptQualificationRequestRequest#builder()}
*
*
* @param acceptQualificationRequestRequest
* A {@link Consumer} that will call methods on {@link AcceptQualificationRequestRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the AcceptQualificationRequest operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.AcceptQualificationRequest
* @see AWS API Documentation
*/
default CompletableFuture acceptQualificationRequest(
Consumer acceptQualificationRequestRequest) {
return acceptQualificationRequest(AcceptQualificationRequestRequest.builder()
.applyMutation(acceptQualificationRequestRequest).build());
}
/**
*
* The ApproveAssignment operation approves the results of a completed assignment.
*
*
* Approving an assignment initiates two payments from the Requester's Amazon.com account
*
*
* -
*
* The Worker who submitted the results is paid the reward specified in the HIT.
*
*
* -
*
* Amazon Mechanical Turk fees are debited.
*
*
*
*
* If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns
* an exception, and the approval is not processed. You can include an optional feedback message with the approval,
* which the Worker can see in the Status section of the web site.
*
*
* You can also call this operation for assignments that were previous rejected and approve them by explicitly
* overriding the previous rejection. This only works on rejected assignments that were submitted within the
* previous 30 days and only if the assignment's related HIT has not been deleted.
*
*
* @param approveAssignmentRequest
* @return A Java Future containing the result of the ApproveAssignment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ApproveAssignment
* @see AWS API Documentation
*/
default CompletableFuture approveAssignment(ApproveAssignmentRequest approveAssignmentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ApproveAssignment operation approves the results of a completed assignment.
*
*
* Approving an assignment initiates two payments from the Requester's Amazon.com account
*
*
* -
*
* The Worker who submitted the results is paid the reward specified in the HIT.
*
*
* -
*
* Amazon Mechanical Turk fees are debited.
*
*
*
*
* If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns
* an exception, and the approval is not processed. You can include an optional feedback message with the approval,
* which the Worker can see in the Status section of the web site.
*
*
* You can also call this operation for assignments that were previous rejected and approve them by explicitly
* overriding the previous rejection. This only works on rejected assignments that were submitted within the
* previous 30 days and only if the assignment's related HIT has not been deleted.
*
*
*
* This is a convenience which creates an instance of the {@link ApproveAssignmentRequest.Builder} avoiding the need
* to create one manually via {@link ApproveAssignmentRequest#builder()}
*
*
* @param approveAssignmentRequest
* A {@link Consumer} that will call methods on {@link ApproveAssignmentRequest.Builder} to create a request.
* @return A Java Future containing the result of the ApproveAssignment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ApproveAssignment
* @see AWS API Documentation
*/
default CompletableFuture approveAssignment(
Consumer approveAssignmentRequest) {
return approveAssignment(ApproveAssignmentRequest.builder().applyMutation(approveAssignmentRequest).build());
}
/**
*
* The AssociateQualificationWithWorker operation gives a Worker a Qualification.
* AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It
* gives the Qualification directly to the Worker.
*
*
* You can only assign a Qualification of a Qualification type that you created (using the
* CreateQualificationType operation).
*
*
*
* Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the
* Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request
* made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending
* Qualification request without affecting the Qualification the Worker already has, reject the request with the
* RejectQualificationRequest operation.
*
*
*
* @param associateQualificationWithWorkerRequest
* @return A Java Future containing the result of the AssociateQualificationWithWorker operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.AssociateQualificationWithWorker
* @see AWS API Documentation
*/
default CompletableFuture associateQualificationWithWorker(
AssociateQualificationWithWorkerRequest associateQualificationWithWorkerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The AssociateQualificationWithWorker operation gives a Worker a Qualification.
* AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It
* gives the Qualification directly to the Worker.
*
*
* You can only assign a Qualification of a Qualification type that you created (using the
* CreateQualificationType operation).
*
*
*
* Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the
* Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request
* made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending
* Qualification request without affecting the Qualification the Worker already has, reject the request with the
* RejectQualificationRequest operation.
*
*
*
* This is a convenience which creates an instance of the {@link AssociateQualificationWithWorkerRequest.Builder}
* avoiding the need to create one manually via {@link AssociateQualificationWithWorkerRequest#builder()}
*
*
* @param associateQualificationWithWorkerRequest
* A {@link Consumer} that will call methods on {@link AssociateQualificationWithWorkerRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the AssociateQualificationWithWorker operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.AssociateQualificationWithWorker
* @see AWS API Documentation
*/
default CompletableFuture associateQualificationWithWorker(
Consumer associateQualificationWithWorkerRequest) {
return associateQualificationWithWorker(AssociateQualificationWithWorkerRequest.builder()
.applyMutation(associateQualificationWithWorkerRequest).build());
}
/**
*
* The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an
* existing HIT.
*
*
* To extend the maximum number of assignments, specify the number of additional assignments.
*
*
*
* -
*
* HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add
* assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10
* or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease
* exception.
*
*
* -
*
* HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created
* before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception.
*
*
*
*
*
* @param createAdditionalAssignmentsForHitRequest
* @return A Java Future containing the result of the CreateAdditionalAssignmentsForHIT operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateAdditionalAssignmentsForHIT
* @see AWS API Documentation
*/
default CompletableFuture createAdditionalAssignmentsForHIT(
CreateAdditionalAssignmentsForHitRequest createAdditionalAssignmentsForHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an
* existing HIT.
*
*
* To extend the maximum number of assignments, specify the number of additional assignments.
*
*
*
* -
*
* HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add
* assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10
* or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease
* exception.
*
*
* -
*
* HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created
* before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateAdditionalAssignmentsForHitRequest.Builder}
* avoiding the need to create one manually via {@link CreateAdditionalAssignmentsForHitRequest#builder()}
*
*
* @param createAdditionalAssignmentsForHitRequest
* A {@link Consumer} that will call methods on {@link CreateAdditionalAssignmentsForHITRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the CreateAdditionalAssignmentsForHIT operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateAdditionalAssignmentsForHIT
* @see AWS API Documentation
*/
default CompletableFuture createAdditionalAssignmentsForHIT(
Consumer createAdditionalAssignmentsForHitRequest) {
return createAdditionalAssignmentsForHIT(CreateAdditionalAssignmentsForHitRequest.builder()
.applyMutation(createAdditionalAssignmentsForHitRequest).build());
}
/**
*
* The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available
* for Workers to find and accept on the Amazon Mechanical Turk website.
*
*
* This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its
* title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT
* is created for you, with a new HITTypeID. The HITTypeID can be used to create additional HITs in the
* future without needing to specify common parameters such as the title, description and reward amount each time.
*
*
* An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType operation
* and then call the CreateHITWithHITType operation. This is the recommended best practice for
* Requesters who are creating large numbers of HITs.
*
*
* CreateHIT also supports several ways to provide question data: by providing a value for the Question
* parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated
* HitLayoutParameters.
*
*
*
* If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
*
*
*
* @param createHitRequest
* @return A Java Future containing the result of the CreateHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateHIT
* @see AWS API
* Documentation
*/
default CompletableFuture createHIT(CreateHitRequest createHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available
* for Workers to find and accept on the Amazon Mechanical Turk website.
*
*
* This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its
* title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT
* is created for you, with a new HITTypeID. The HITTypeID can be used to create additional HITs in the
* future without needing to specify common parameters such as the title, description and reward amount each time.
*
*
* An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType operation
* and then call the CreateHITWithHITType operation. This is the recommended best practice for
* Requesters who are creating large numbers of HITs.
*
*
* CreateHIT also supports several ways to provide question data: by providing a value for the Question
* parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated
* HitLayoutParameters.
*
*
*
* If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
*
*
*
* This is a convenience which creates an instance of the {@link CreateHitRequest.Builder} avoiding the need to
* create one manually via {@link CreateHitRequest#builder()}
*
*
* @param createHitRequest
* A {@link Consumer} that will call methods on {@link CreateHITRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateHIT
* @see AWS API
* Documentation
*/
default CompletableFuture createHIT(Consumer createHitRequest) {
return createHIT(CreateHitRequest.builder().applyMutation(createHitRequest).build());
}
/**
*
* The CreateHITType operation creates a new HIT type. This operation allows you to define a standard
* set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing
* HIT type, the HIT type ID of the existing type will be returned.
*
*
* @param createHitTypeRequest
* @return A Java Future containing the result of the CreateHITType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateHITType
* @see AWS
* API Documentation
*/
default CompletableFuture createHITType(CreateHitTypeRequest createHitTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The CreateHITType operation creates a new HIT type. This operation allows you to define a standard
* set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing
* HIT type, the HIT type ID of the existing type will be returned.
*
*
*
* This is a convenience which creates an instance of the {@link CreateHitTypeRequest.Builder} avoiding the need to
* create one manually via {@link CreateHitTypeRequest#builder()}
*
*
* @param createHitTypeRequest
* A {@link Consumer} that will call methods on {@link CreateHITTypeRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateHITType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateHITType
* @see AWS
* API Documentation
*/
default CompletableFuture createHITType(Consumer createHitTypeRequest) {
return createHITType(CreateHitTypeRequest.builder().applyMutation(createHitTypeRequest).build());
}
/**
*
* The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing
* HITTypeID generated by the CreateHITType operation.
*
*
* This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best
* practice for Requesters who are creating large numbers of HITs.
*
*
* CreateHITWithHITType also supports several ways to provide question data: by providing a value for the
* Question parameter that fully specifies the contents of the HIT, or by providing a
* HitLayoutId and associated HitLayoutParameters.
*
*
*
* If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
*
*
*
* @param createHitWithHitTypeRequest
* @return A Java Future containing the result of the CreateHITWithHITType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateHITWithHITType
* @see AWS API Documentation
*/
default CompletableFuture createHITWithHITType(
CreateHitWithHitTypeRequest createHitWithHitTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing
* HITTypeID generated by the CreateHITType operation.
*
*
* This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best
* practice for Requesters who are creating large numbers of HITs.
*
*
* CreateHITWithHITType also supports several ways to provide question data: by providing a value for the
* Question parameter that fully specifies the contents of the HIT, or by providing a
* HitLayoutId and associated HitLayoutParameters.
*
*
*
* If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.
*
*
*
* This is a convenience which creates an instance of the {@link CreateHitWithHitTypeRequest.Builder} avoiding the
* need to create one manually via {@link CreateHitWithHitTypeRequest#builder()}
*
*
* @param createHitWithHitTypeRequest
* A {@link Consumer} that will call methods on {@link CreateHITWithHITTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateHITWithHITType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateHITWithHITType
* @see AWS API Documentation
*/
default CompletableFuture createHITWithHITType(
Consumer createHitWithHitTypeRequest) {
return createHITWithHITType(CreateHitWithHitTypeRequest.builder().applyMutation(createHitWithHitTypeRequest).build());
}
/**
*
* The CreateQualificationType operation creates a new Qualification type, which is represented by a
* QualificationType data structure.
*
*
* @param createQualificationTypeRequest
* @return A Java Future containing the result of the CreateQualificationType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateQualificationType
* @see AWS API Documentation
*/
default CompletableFuture createQualificationType(
CreateQualificationTypeRequest createQualificationTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The CreateQualificationType operation creates a new Qualification type, which is represented by a
* QualificationType data structure.
*
*
*
* This is a convenience which creates an instance of the {@link CreateQualificationTypeRequest.Builder} avoiding
* the need to create one manually via {@link CreateQualificationTypeRequest#builder()}
*
*
* @param createQualificationTypeRequest
* A {@link Consumer} that will call methods on {@link CreateQualificationTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateQualificationType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateQualificationType
* @see AWS API Documentation
*/
default CompletableFuture createQualificationType(
Consumer createQualificationTypeRequest) {
return createQualificationType(CreateQualificationTypeRequest.builder().applyMutation(createQualificationTypeRequest)
.build());
}
/**
*
* The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For
* example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.
*
*
* @param createWorkerBlockRequest
* @return A Java Future containing the result of the CreateWorkerBlock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateWorkerBlock
* @see AWS API Documentation
*/
default CompletableFuture createWorkerBlock(CreateWorkerBlockRequest createWorkerBlockRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For
* example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.
*
*
*
* This is a convenience which creates an instance of the {@link CreateWorkerBlockRequest.Builder} avoiding the need
* to create one manually via {@link CreateWorkerBlockRequest#builder()}
*
*
* @param createWorkerBlockRequest
* A {@link Consumer} that will call methods on {@link CreateWorkerBlockRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateWorkerBlock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.CreateWorkerBlock
* @see AWS API Documentation
*/
default CompletableFuture createWorkerBlock(
Consumer createWorkerBlockRequest) {
return createWorkerBlock(CreateWorkerBlockRequest.builder().applyMutation(createWorkerBlockRequest).build());
}
/**
*
* The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who
* created the HIT can delete it.
*
*
* You can only dispose of HITs that are in the Reviewable state, with all of their submitted
* assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in the
* Reviewable state (for example, that has not expired, or still has active assignments), or on a HIT
* that is Reviewable but without all of its submitted assignments already approved or rejected, the service will
* return an error.
*
*
*
* -
*
* HITs are automatically disposed of after 120 days.
*
*
* -
*
* After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
*
*
* -
*
* Disposed HITs are not returned in results for the ListHITs operation.
*
*
* -
*
* Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs.
*
*
*
*
*
* @param deleteHitRequest
* @return A Java Future containing the result of the DeleteHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.DeleteHIT
* @see AWS API
* Documentation
*/
default CompletableFuture deleteHIT(DeleteHitRequest deleteHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who
* created the HIT can delete it.
*
*
* You can only dispose of HITs that are in the Reviewable state, with all of their submitted
* assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in the
* Reviewable state (for example, that has not expired, or still has active assignments), or on a HIT
* that is Reviewable but without all of its submitted assignments already approved or rejected, the service will
* return an error.
*
*
*
* -
*
* HITs are automatically disposed of after 120 days.
*
*
* -
*
* After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.
*
*
* -
*
* Disposed HITs are not returned in results for the ListHITs operation.
*
*
* -
*
* Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteHitRequest.Builder} avoiding the need to
* create one manually via {@link DeleteHitRequest#builder()}
*
*
* @param deleteHitRequest
* A {@link Consumer} that will call methods on {@link DeleteHITRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.DeleteHIT
* @see AWS API
* Documentation
*/
default CompletableFuture deleteHIT(Consumer deleteHitRequest) {
return deleteHIT(DeleteHitRequest.builder().applyMutation(deleteHitRequest).build());
}
/**
*
* The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are
* associated with the Qualification type.
*
*
* This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be
* needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk
* rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT
* types.
*
*
*
* DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before
* completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the
* Qualification type is available for reuse with CreateQualificationType.
*
*
*
* @param deleteQualificationTypeRequest
* @return A Java Future containing the result of the DeleteQualificationType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.DeleteQualificationType
* @see AWS API Documentation
*/
default CompletableFuture deleteQualificationType(
DeleteQualificationTypeRequest deleteQualificationTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are
* associated with the Qualification type.
*
*
* This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be
* needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk
* rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT
* types.
*
*
*
* DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before
* completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the
* Qualification type is available for reuse with CreateQualificationType.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteQualificationTypeRequest.Builder} avoiding
* the need to create one manually via {@link DeleteQualificationTypeRequest#builder()}
*
*
* @param deleteQualificationTypeRequest
* A {@link Consumer} that will call methods on {@link DeleteQualificationTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteQualificationType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.DeleteQualificationType
* @see AWS API Documentation
*/
default CompletableFuture deleteQualificationType(
Consumer deleteQualificationTypeRequest) {
return deleteQualificationType(DeleteQualificationTypeRequest.builder().applyMutation(deleteQualificationTypeRequest)
.build());
}
/**
*
* The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This
* operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation.
* If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If
* the specified Worker is not blocked, this operation returns successfully.
*
*
* @param deleteWorkerBlockRequest
* @return A Java Future containing the result of the DeleteWorkerBlock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.DeleteWorkerBlock
* @see AWS API Documentation
*/
default CompletableFuture deleteWorkerBlock(DeleteWorkerBlockRequest deleteWorkerBlockRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This
* operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation.
* If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If
* the specified Worker is not blocked, this operation returns successfully.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteWorkerBlockRequest.Builder} avoiding the need
* to create one manually via {@link DeleteWorkerBlockRequest#builder()}
*
*
* @param deleteWorkerBlockRequest
* A {@link Consumer} that will call methods on {@link DeleteWorkerBlockRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteWorkerBlock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.DeleteWorkerBlock
* @see AWS API Documentation
*/
default CompletableFuture deleteWorkerBlock(
Consumer deleteWorkerBlockRequest) {
return deleteWorkerBlock(DeleteWorkerBlockRequest.builder().applyMutation(deleteWorkerBlockRequest).build());
}
/**
*
* The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user.
*
*
* You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification
* can see this message.
*
*
* @param disassociateQualificationFromWorkerRequest
* @return A Java Future containing the result of the DisassociateQualificationFromWorker operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.DisassociateQualificationFromWorker
* @see AWS API Documentation
*/
default CompletableFuture disassociateQualificationFromWorker(
DisassociateQualificationFromWorkerRequest disassociateQualificationFromWorkerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user.
*
*
* You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification
* can see this message.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateQualificationFromWorkerRequest.Builder}
* avoiding the need to create one manually via {@link DisassociateQualificationFromWorkerRequest#builder()}
*
*
* @param disassociateQualificationFromWorkerRequest
* A {@link Consumer} that will call methods on {@link DisassociateQualificationFromWorkerRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DisassociateQualificationFromWorker operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.DisassociateQualificationFromWorker
* @see AWS API Documentation
*/
default CompletableFuture disassociateQualificationFromWorker(
Consumer disassociateQualificationFromWorkerRequest) {
return disassociateQualificationFromWorker(DisassociateQualificationFromWorkerRequest.builder()
.applyMutation(disassociateQualificationFromWorkerRequest).build());
}
/**
*
* The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk
* account if you are a Prepaid Requester. Alternatively, this operation will retrieve the remaining available AWS
* Billing usage if you have enabled AWS Billing. Note: If you have enabled AWS Billing and still have a remaining
* Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console.
*
*
* @param getAccountBalanceRequest
* @return A Java Future containing the result of the GetAccountBalance operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetAccountBalance
* @see AWS API Documentation
*/
default CompletableFuture getAccountBalance(GetAccountBalanceRequest getAccountBalanceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk
* account if you are a Prepaid Requester. Alternatively, this operation will retrieve the remaining available AWS
* Billing usage if you have enabled AWS Billing. Note: If you have enabled AWS Billing and still have a remaining
* Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console.
*
*
*
* This is a convenience which creates an instance of the {@link GetAccountBalanceRequest.Builder} avoiding the need
* to create one manually via {@link GetAccountBalanceRequest#builder()}
*
*
* @param getAccountBalanceRequest
* A {@link Consumer} that will call methods on {@link GetAccountBalanceRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetAccountBalance operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetAccountBalance
* @see AWS API Documentation
*/
default CompletableFuture getAccountBalance(
Consumer getAccountBalanceRequest) {
return getAccountBalance(GetAccountBalanceRequest.builder().applyMutation(getAccountBalanceRequest).build());
}
/**
*
* The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk
* account if you are a Prepaid Requester. Alternatively, this operation will retrieve the remaining available AWS
* Billing usage if you have enabled AWS Billing. Note: If you have enabled AWS Billing and still have a remaining
* Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console.
*
*
* @return A Java Future containing the result of the GetAccountBalance operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetAccountBalance
* @see AWS API Documentation
*/
default CompletableFuture getAccountBalance() {
return getAccountBalance(GetAccountBalanceRequest.builder().build());
}
/**
*
* The GetAssignment operation retrieves the details of the specified Assignment.
*
*
* @param getAssignmentRequest
* @return A Java Future containing the result of the GetAssignment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetAssignment
* @see AWS
* API Documentation
*/
default CompletableFuture getAssignment(GetAssignmentRequest getAssignmentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The GetAssignment operation retrieves the details of the specified Assignment.
*
*
*
* This is a convenience which creates an instance of the {@link GetAssignmentRequest.Builder} avoiding the need to
* create one manually via {@link GetAssignmentRequest#builder()}
*
*
* @param getAssignmentRequest
* A {@link Consumer} that will call methods on {@link GetAssignmentRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetAssignment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetAssignment
* @see AWS
* API Documentation
*/
default CompletableFuture getAssignment(Consumer getAssignmentRequest) {
return getAssignment(GetAssignmentRequest.builder().applyMutation(getAssignmentRequest).build());
}
/**
*
* The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to
* retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is
* generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a
* temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are
* deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure
* will no longer support the FileUploadAnswer element to be used for the QuestionForm data structure.
* Instead, we recommend that Requesters who want to create HITs asking Workers to upload files to use Amazon S3.
*
*
* @param getFileUploadUrlRequest
* @return A Java Future containing the result of the GetFileUploadURL operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetFileUploadURL
* @see AWS API Documentation
*/
default CompletableFuture getFileUploadURL(GetFileUploadUrlRequest getFileUploadUrlRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to
* retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is
* generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a
* temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are
* deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure
* will no longer support the FileUploadAnswer element to be used for the QuestionForm data structure.
* Instead, we recommend that Requesters who want to create HITs asking Workers to upload files to use Amazon S3.
*
*
*
* This is a convenience which creates an instance of the {@link GetFileUploadUrlRequest.Builder} avoiding the need
* to create one manually via {@link GetFileUploadUrlRequest#builder()}
*
*
* @param getFileUploadUrlRequest
* A {@link Consumer} that will call methods on {@link GetFileUploadURLRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetFileUploadURL operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetFileUploadURL
* @see AWS API Documentation
*/
default CompletableFuture getFileUploadURL(
Consumer getFileUploadUrlRequest) {
return getFileUploadURL(GetFileUploadUrlRequest.builder().applyMutation(getFileUploadUrlRequest).build());
}
/**
*
* The GetHIT operation retrieves the details of the specified HIT.
*
*
* @param getHitRequest
* @return A Java Future containing the result of the GetHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetHIT
* @see AWS API
* Documentation
*/
default CompletableFuture getHIT(GetHitRequest getHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The GetHIT operation retrieves the details of the specified HIT.
*
*
*
* This is a convenience which creates an instance of the {@link GetHitRequest.Builder} avoiding the need to create
* one manually via {@link GetHitRequest#builder()}
*
*
* @param getHitRequest
* A {@link Consumer} that will call methods on {@link GetHITRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetHIT
* @see AWS API
* Documentation
*/
default CompletableFuture getHIT(Consumer getHitRequest) {
return getHIT(GetHitRequest.builder().applyMutation(getHitRequest).build());
}
/**
*
* The GetQualificationScore operation returns the value of a Worker's Qualification for a given
* Qualification type.
*
*
* To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment
* data returned by the ListAssignmentsForHIT operation.
*
*
* Only the owner of a Qualification type can query the value of a Worker's Qualification of that type.
*
*
* @param getQualificationScoreRequest
* @return A Java Future containing the result of the GetQualificationScore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetQualificationScore
* @see AWS API Documentation
*/
default CompletableFuture getQualificationScore(
GetQualificationScoreRequest getQualificationScoreRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The GetQualificationScore operation returns the value of a Worker's Qualification for a given
* Qualification type.
*
*
* To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment
* data returned by the ListAssignmentsForHIT operation.
*
*
* Only the owner of a Qualification type can query the value of a Worker's Qualification of that type.
*
*
*
* This is a convenience which creates an instance of the {@link GetQualificationScoreRequest.Builder} avoiding the
* need to create one manually via {@link GetQualificationScoreRequest#builder()}
*
*
* @param getQualificationScoreRequest
* A {@link Consumer} that will call methods on {@link GetQualificationScoreRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetQualificationScore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetQualificationScore
* @see AWS API Documentation
*/
default CompletableFuture getQualificationScore(
Consumer getQualificationScoreRequest) {
return getQualificationScore(GetQualificationScoreRequest.builder().applyMutation(getQualificationScoreRequest).build());
}
/**
*
* The GetQualificationTypeoperation retrieves information about a Qualification type using its ID.
*
*
* @param getQualificationTypeRequest
* @return A Java Future containing the result of the GetQualificationType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetQualificationType
* @see AWS API Documentation
*/
default CompletableFuture getQualificationType(
GetQualificationTypeRequest getQualificationTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The GetQualificationTypeoperation retrieves information about a Qualification type using its ID.
*
*
*
* This is a convenience which creates an instance of the {@link GetQualificationTypeRequest.Builder} avoiding the
* need to create one manually via {@link GetQualificationTypeRequest#builder()}
*
*
* @param getQualificationTypeRequest
* A {@link Consumer} that will call methods on {@link GetQualificationTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetQualificationType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.GetQualificationType
* @see AWS API Documentation
*/
default CompletableFuture getQualificationType(
Consumer getQualificationTypeRequest) {
return getQualificationType(GetQualificationTypeRequest.builder().applyMutation(getQualificationTypeRequest).build());
}
/**
*
* The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this
* operation to retrieve the results for a HIT.
*
*
* You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple
* assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial
* results with this operation.
*
*
* Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The
* ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments
* that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments
* that have already been approved and rejected together in one result set.
*
*
* Only the Requester who created the HIT can retrieve the assignments for that HIT.
*
*
* Results are sorted and divided into numbered pages and the operation returns a single page of results. You can
* use the parameters of the operation to control sorting and pagination.
*
*
* @param listAssignmentsForHitRequest
* @return A Java Future containing the result of the ListAssignmentsForHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListAssignmentsForHIT
* @see AWS API Documentation
*/
default CompletableFuture listAssignmentsForHIT(
ListAssignmentsForHitRequest listAssignmentsForHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this
* operation to retrieve the results for a HIT.
*
*
* You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple
* assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial
* results with this operation.
*
*
* Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The
* ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments
* that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments
* that have already been approved and rejected together in one result set.
*
*
* Only the Requester who created the HIT can retrieve the assignments for that HIT.
*
*
* Results are sorted and divided into numbered pages and the operation returns a single page of results. You can
* use the parameters of the operation to control sorting and pagination.
*
*
*
* This is a convenience which creates an instance of the {@link ListAssignmentsForHitRequest.Builder} avoiding the
* need to create one manually via {@link ListAssignmentsForHitRequest#builder()}
*
*
* @param listAssignmentsForHitRequest
* A {@link Consumer} that will call methods on {@link ListAssignmentsForHITRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListAssignmentsForHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListAssignmentsForHIT
* @see AWS API Documentation
*/
default CompletableFuture listAssignmentsForHIT(
Consumer listAssignmentsForHitRequest) {
return listAssignmentsForHIT(ListAssignmentsForHitRequest.builder().applyMutation(listAssignmentsForHitRequest).build());
}
/**
*
* The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this
* operation to retrieve the results for a HIT.
*
*
* You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple
* assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial
* results with this operation.
*
*
* Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The
* ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments
* that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments
* that have already been approved and rejected together in one result set.
*
*
* Only the Requester who created the HIT can retrieve the assignments for that HIT.
*
*
* Results are sorted and divided into numbered pages and the operation returns a single page of results. You can
* use the parameters of the operation to control sorting and pagination.
*
*
*
* This is a variant of
* {@link #listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher publisher = client.listAssignmentsForHITPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher publisher = client.listAssignmentsForHITPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)}
* operation.
*
*
* @param listAssignmentsForHitRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListAssignmentsForHIT
* @see AWS API Documentation
*/
default ListAssignmentsForHITPublisher listAssignmentsForHITPaginator(
ListAssignmentsForHitRequest listAssignmentsForHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this
* operation to retrieve the results for a HIT.
*
*
* You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple
* assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial
* results with this operation.
*
*
* Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The
* ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments
* that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments
* that have already been approved and rejected together in one result set.
*
*
* Only the Requester who created the HIT can retrieve the assignments for that HIT.
*
*
* Results are sorted and divided into numbered pages and the operation returns a single page of results. You can
* use the parameters of the operation to control sorting and pagination.
*
*
*
* This is a variant of
* {@link #listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher publisher = client.listAssignmentsForHITPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListAssignmentsForHITPublisher publisher = client.listAssignmentsForHITPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listAssignmentsForHIT(software.amazon.awssdk.services.mturk.model.ListAssignmentsForHitRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListAssignmentsForHitRequest.Builder} avoiding the
* need to create one manually via {@link ListAssignmentsForHitRequest#builder()}
*
*
* @param listAssignmentsForHitRequest
* A {@link Consumer} that will call methods on {@link ListAssignmentsForHITRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListAssignmentsForHIT
* @see AWS API Documentation
*/
default ListAssignmentsForHITPublisher listAssignmentsForHITPaginator(
Consumer listAssignmentsForHitRequest) {
return listAssignmentsForHITPaginator(ListAssignmentsForHitRequest.builder().applyMutation(listAssignmentsForHitRequest)
.build());
}
/**
*
* The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a
* given HIT or assignment.
*
*
* @param listBonusPaymentsRequest
* @return A Java Future containing the result of the ListBonusPayments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListBonusPayments
* @see AWS API Documentation
*/
default CompletableFuture listBonusPayments(ListBonusPaymentsRequest listBonusPaymentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a
* given HIT or assignment.
*
*
*
* This is a convenience which creates an instance of the {@link ListBonusPaymentsRequest.Builder} avoiding the need
* to create one manually via {@link ListBonusPaymentsRequest#builder()}
*
*
* @param listBonusPaymentsRequest
* A {@link Consumer} that will call methods on {@link ListBonusPaymentsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListBonusPayments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListBonusPayments
* @see AWS API Documentation
*/
default CompletableFuture listBonusPayments(
Consumer listBonusPaymentsRequest) {
return listBonusPayments(ListBonusPaymentsRequest.builder().applyMutation(listBonusPaymentsRequest).build());
}
/**
*
* The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a
* given HIT or assignment.
*
*
*
* This is a variant of
* {@link #listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher publisher = client.listBonusPaymentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher publisher = client.listBonusPaymentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)} operation.
*
*
* @param listBonusPaymentsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListBonusPayments
* @see AWS API Documentation
*/
default ListBonusPaymentsPublisher listBonusPaymentsPaginator(ListBonusPaymentsRequest listBonusPaymentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a
* given HIT or assignment.
*
*
*
* This is a variant of
* {@link #listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher publisher = client.listBonusPaymentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListBonusPaymentsPublisher publisher = client.listBonusPaymentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listBonusPayments(software.amazon.awssdk.services.mturk.model.ListBonusPaymentsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListBonusPaymentsRequest.Builder} avoiding the need
* to create one manually via {@link ListBonusPaymentsRequest#builder()}
*
*
* @param listBonusPaymentsRequest
* A {@link Consumer} that will call methods on {@link ListBonusPaymentsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListBonusPayments
* @see AWS API Documentation
*/
default ListBonusPaymentsPublisher listBonusPaymentsPaginator(
Consumer listBonusPaymentsRequest) {
return listBonusPaymentsPaginator(ListBonusPaymentsRequest.builder().applyMutation(listBonusPaymentsRequest).build());
}
/**
*
* The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status,
* except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.
*
*
* @param listHiTsRequest
* @return A Java Future containing the result of the ListHITs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITs
* @see AWS API
* Documentation
*/
default CompletableFuture listHITs(ListHiTsRequest listHiTsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status,
* except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.
*
*
*
* This is a convenience which creates an instance of the {@link ListHiTsRequest.Builder} avoiding the need to
* create one manually via {@link ListHiTsRequest#builder()}
*
*
* @param listHiTsRequest
* A {@link Consumer} that will call methods on {@link ListHITsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListHITs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITs
* @see AWS API
* Documentation
*/
default CompletableFuture listHITs(Consumer listHiTsRequest) {
return listHITs(ListHiTsRequest.builder().applyMutation(listHiTsRequest).build());
}
/**
*
* The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status,
* except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.
*
*
* @return A Java Future containing the result of the ListHITs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITs
* @see AWS API
* Documentation
*/
default CompletableFuture listHITs() {
return listHITs(ListHiTsRequest.builder().build());
}
/**
*
* The ListHITsForQualificationType operation returns the HITs that use the given Qualification type
* for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted
* with the DeleteHIT operation or that have been auto-deleted.
*
*
* @param listHiTsForQualificationTypeRequest
* @return A Java Future containing the result of the ListHITsForQualificationType operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITsForQualificationType
* @see AWS API Documentation
*/
default CompletableFuture listHITsForQualificationType(
ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListHITsForQualificationType operation returns the HITs that use the given Qualification type
* for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted
* with the DeleteHIT operation or that have been auto-deleted.
*
*
*
* This is a convenience which creates an instance of the {@link ListHiTsForQualificationTypeRequest.Builder}
* avoiding the need to create one manually via {@link ListHiTsForQualificationTypeRequest#builder()}
*
*
* @param listHiTsForQualificationTypeRequest
* A {@link Consumer} that will call methods on {@link ListHITsForQualificationTypeRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the ListHITsForQualificationType operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITsForQualificationType
* @see AWS API Documentation
*/
default CompletableFuture listHITsForQualificationType(
Consumer listHiTsForQualificationTypeRequest) {
return listHITsForQualificationType(ListHiTsForQualificationTypeRequest.builder()
.applyMutation(listHiTsForQualificationTypeRequest).build());
}
/**
*
* The ListHITsForQualificationType operation returns the HITs that use the given Qualification type
* for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted
* with the DeleteHIT operation or that have been auto-deleted.
*
*
*
* This is a variant of
* {@link #listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher publisher = client.listHITsForQualificationTypePaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher publisher = client.listHITsForQualificationTypePaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)}
* operation.
*
*
* @param listHiTsForQualificationTypeRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITsForQualificationType
* @see AWS API Documentation
*/
default ListHITsForQualificationTypePublisher listHITsForQualificationTypePaginator(
ListHiTsForQualificationTypeRequest listHiTsForQualificationTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListHITsForQualificationType operation returns the HITs that use the given Qualification type
* for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted
* with the DeleteHIT operation or that have been auto-deleted.
*
*
*
* This is a variant of
* {@link #listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher publisher = client.listHITsForQualificationTypePaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsForQualificationTypePublisher publisher = client.listHITsForQualificationTypePaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listHITsForQualificationType(software.amazon.awssdk.services.mturk.model.ListHiTsForQualificationTypeRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListHiTsForQualificationTypeRequest.Builder}
* avoiding the need to create one manually via {@link ListHiTsForQualificationTypeRequest#builder()}
*
*
* @param listHiTsForQualificationTypeRequest
* A {@link Consumer} that will call methods on {@link ListHITsForQualificationTypeRequest.Builder} to create
* a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITsForQualificationType
* @see AWS API Documentation
*/
default ListHITsForQualificationTypePublisher listHITsForQualificationTypePaginator(
Consumer listHiTsForQualificationTypeRequest) {
return listHITsForQualificationTypePaginator(ListHiTsForQualificationTypeRequest.builder()
.applyMutation(listHiTsForQualificationTypeRequest).build());
}
/**
*
* The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status,
* except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.
*
*
*
* This is a variant of {@link #listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITs
* @see AWS API
* Documentation
*/
default ListHITsPublisher listHITsPaginator() {
return listHITsPaginator(ListHiTsRequest.builder().build());
}
/**
*
* The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status,
* except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.
*
*
*
* This is a variant of {@link #listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)} operation.
*
*
* @param listHiTsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITs
* @see AWS API
* Documentation
*/
default ListHITsPublisher listHITsPaginator(ListHiTsRequest listHiTsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status,
* except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.
*
*
*
* This is a variant of {@link #listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListHITsPublisher publisher = client.listHITsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListHiTsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listHITs(software.amazon.awssdk.services.mturk.model.ListHiTsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListHiTsRequest.Builder} avoiding the need to
* create one manually via {@link ListHiTsRequest#builder()}
*
*
* @param listHiTsRequest
* A {@link Consumer} that will call methods on {@link ListHITsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListHITs
* @see AWS API
* Documentation
*/
default ListHITsPublisher listHITsPaginator(Consumer listHiTsRequest) {
return listHITsPaginator(ListHiTsRequest.builder().applyMutation(listHiTsRequest).build());
}
/**
*
* The ListQualificationRequests operation retrieves requests for Qualifications of a particular
* Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and
* accepts them using the AcceptQualification operation.
*
*
* @param listQualificationRequestsRequest
* @return A Java Future containing the result of the ListQualificationRequests operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationRequests
* @see AWS API Documentation
*/
default CompletableFuture listQualificationRequests(
ListQualificationRequestsRequest listQualificationRequestsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListQualificationRequests operation retrieves requests for Qualifications of a particular
* Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and
* accepts them using the AcceptQualification operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListQualificationRequestsRequest.Builder} avoiding
* the need to create one manually via {@link ListQualificationRequestsRequest#builder()}
*
*
* @param listQualificationRequestsRequest
* A {@link Consumer} that will call methods on {@link ListQualificationRequestsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListQualificationRequests operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationRequests
* @see AWS API Documentation
*/
default CompletableFuture listQualificationRequests(
Consumer listQualificationRequestsRequest) {
return listQualificationRequests(ListQualificationRequestsRequest.builder()
.applyMutation(listQualificationRequestsRequest).build());
}
/**
*
* The ListQualificationRequests operation retrieves requests for Qualifications of a particular
* Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and
* accepts them using the AcceptQualification operation.
*
*
* @return A Java Future containing the result of the ListQualificationRequests operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationRequests
* @see AWS API Documentation
*/
default CompletableFuture listQualificationRequests() {
return listQualificationRequests(ListQualificationRequestsRequest.builder().build());
}
/**
*
* The ListQualificationRequests operation retrieves requests for Qualifications of a particular
* Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and
* accepts them using the AcceptQualification operation.
*
*
*
* This is a variant of
* {@link #listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationRequests
* @see AWS API Documentation
*/
default ListQualificationRequestsPublisher listQualificationRequestsPaginator() {
return listQualificationRequestsPaginator(ListQualificationRequestsRequest.builder().build());
}
/**
*
* The ListQualificationRequests operation retrieves requests for Qualifications of a particular
* Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and
* accepts them using the AcceptQualification operation.
*
*
*
* This is a variant of
* {@link #listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)}
* operation.
*
*
* @param listQualificationRequestsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationRequests
* @see AWS API Documentation
*/
default ListQualificationRequestsPublisher listQualificationRequestsPaginator(
ListQualificationRequestsRequest listQualificationRequestsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListQualificationRequests operation retrieves requests for Qualifications of a particular
* Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and
* accepts them using the AcceptQualification operation.
*
*
*
* This is a variant of
* {@link #listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationRequestsPublisher publisher = client.listQualificationRequestsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listQualificationRequests(software.amazon.awssdk.services.mturk.model.ListQualificationRequestsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListQualificationRequestsRequest.Builder} avoiding
* the need to create one manually via {@link ListQualificationRequestsRequest#builder()}
*
*
* @param listQualificationRequestsRequest
* A {@link Consumer} that will call methods on {@link ListQualificationRequestsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationRequests
* @see AWS API Documentation
*/
default ListQualificationRequestsPublisher listQualificationRequestsPaginator(
Consumer listQualificationRequestsRequest) {
return listQualificationRequestsPaginator(ListQualificationRequestsRequest.builder()
.applyMutation(listQualificationRequestsRequest).build());
}
/**
*
* The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional
* search term.
*
*
* @param listQualificationTypesRequest
* @return A Java Future containing the result of the ListQualificationTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationTypes
* @see AWS API Documentation
*/
default CompletableFuture listQualificationTypes(
ListQualificationTypesRequest listQualificationTypesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional
* search term.
*
*
*
* This is a convenience which creates an instance of the {@link ListQualificationTypesRequest.Builder} avoiding the
* need to create one manually via {@link ListQualificationTypesRequest#builder()}
*
*
* @param listQualificationTypesRequest
* A {@link Consumer} that will call methods on {@link ListQualificationTypesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListQualificationTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationTypes
* @see AWS API Documentation
*/
default CompletableFuture listQualificationTypes(
Consumer listQualificationTypesRequest) {
return listQualificationTypes(ListQualificationTypesRequest.builder().applyMutation(listQualificationTypesRequest)
.build());
}
/**
*
* The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional
* search term.
*
*
*
* This is a variant of
* {@link #listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher publisher = client.listQualificationTypesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher publisher = client.listQualificationTypesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)}
* operation.
*
*
* @param listQualificationTypesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationTypes
* @see AWS API Documentation
*/
default ListQualificationTypesPublisher listQualificationTypesPaginator(
ListQualificationTypesRequest listQualificationTypesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional
* search term.
*
*
*
* This is a variant of
* {@link #listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher publisher = client.listQualificationTypesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListQualificationTypesPublisher publisher = client.listQualificationTypesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListQualificationTypesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listQualificationTypes(software.amazon.awssdk.services.mturk.model.ListQualificationTypesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListQualificationTypesRequest.Builder} avoiding the
* need to create one manually via {@link ListQualificationTypesRequest#builder()}
*
*
* @param listQualificationTypesRequest
* A {@link Consumer} that will call methods on {@link ListQualificationTypesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListQualificationTypes
* @see AWS API Documentation
*/
default ListQualificationTypesPublisher listQualificationTypesPaginator(
Consumer listQualificationTypesRequest) {
return listQualificationTypesPaginator(ListQualificationTypesRequest.builder()
.applyMutation(listQualificationTypesRequest).build());
}
/**
*
* The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in
* the course of executing your Review Policies for a given HIT. For information about how to specify Review
* Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return
* results for both Assignment-level and HIT-level review results.
*
*
* @param listReviewPolicyResultsForHitRequest
* @return A Java Future containing the result of the ListReviewPolicyResultsForHIT operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewPolicyResultsForHIT
* @see AWS API Documentation
*/
default CompletableFuture listReviewPolicyResultsForHIT(
ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in
* the course of executing your Review Policies for a given HIT. For information about how to specify Review
* Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return
* results for both Assignment-level and HIT-level review results.
*
*
*
* This is a convenience which creates an instance of the {@link ListReviewPolicyResultsForHitRequest.Builder}
* avoiding the need to create one manually via {@link ListReviewPolicyResultsForHitRequest#builder()}
*
*
* @param listReviewPolicyResultsForHitRequest
* A {@link Consumer} that will call methods on {@link ListReviewPolicyResultsForHITRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListReviewPolicyResultsForHIT operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewPolicyResultsForHIT
* @see AWS API Documentation
*/
default CompletableFuture listReviewPolicyResultsForHIT(
Consumer listReviewPolicyResultsForHitRequest) {
return listReviewPolicyResultsForHIT(ListReviewPolicyResultsForHitRequest.builder()
.applyMutation(listReviewPolicyResultsForHitRequest).build());
}
/**
*
* The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in
* the course of executing your Review Policies for a given HIT. For information about how to specify Review
* Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return
* results for both Assignment-level and HIT-level review results.
*
*
*
* This is a variant of
* {@link #listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher publisher = client.listReviewPolicyResultsForHITPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher publisher = client.listReviewPolicyResultsForHITPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)}
* operation.
*
*
* @param listReviewPolicyResultsForHitRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewPolicyResultsForHIT
* @see AWS API Documentation
*/
default ListReviewPolicyResultsForHITPublisher listReviewPolicyResultsForHITPaginator(
ListReviewPolicyResultsForHitRequest listReviewPolicyResultsForHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in
* the course of executing your Review Policies for a given HIT. For information about how to specify Review
* Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return
* results for both Assignment-level and HIT-level review results.
*
*
*
* This is a variant of
* {@link #listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher publisher = client.listReviewPolicyResultsForHITPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewPolicyResultsForHITPublisher publisher = client.listReviewPolicyResultsForHITPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listReviewPolicyResultsForHIT(software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListReviewPolicyResultsForHitRequest.Builder}
* avoiding the need to create one manually via {@link ListReviewPolicyResultsForHitRequest#builder()}
*
*
* @param listReviewPolicyResultsForHitRequest
* A {@link Consumer} that will call methods on {@link ListReviewPolicyResultsForHITRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewPolicyResultsForHIT
* @see AWS API Documentation
*/
default ListReviewPolicyResultsForHITPublisher listReviewPolicyResultsForHITPaginator(
Consumer listReviewPolicyResultsForHitRequest) {
return listReviewPolicyResultsForHITPaginator(ListReviewPolicyResultsForHitRequest.builder()
.applyMutation(listReviewPolicyResultsForHitRequest).build());
}
/**
*
* The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
* to Reviewing that belong to the Requester calling the operation.
*
*
* @param listReviewableHiTsRequest
* @return A Java Future containing the result of the ListReviewableHITs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewableHITs
* @see AWS API Documentation
*/
default CompletableFuture listReviewableHITs(ListReviewableHiTsRequest listReviewableHiTsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
* to Reviewing that belong to the Requester calling the operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListReviewableHiTsRequest.Builder} avoiding the
* need to create one manually via {@link ListReviewableHiTsRequest#builder()}
*
*
* @param listReviewableHiTsRequest
* A {@link Consumer} that will call methods on {@link ListReviewableHITsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListReviewableHITs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewableHITs
* @see AWS API Documentation
*/
default CompletableFuture listReviewableHITs(
Consumer listReviewableHiTsRequest) {
return listReviewableHITs(ListReviewableHiTsRequest.builder().applyMutation(listReviewableHiTsRequest).build());
}
/**
*
* The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
* to Reviewing that belong to the Requester calling the operation.
*
*
* @return A Java Future containing the result of the ListReviewableHITs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewableHITs
* @see AWS API Documentation
*/
default CompletableFuture listReviewableHITs() {
return listReviewableHITs(ListReviewableHiTsRequest.builder().build());
}
/**
*
* The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
* to Reviewing that belong to the Requester calling the operation.
*
*
*
* This is a variant of
* {@link #listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewableHITs
* @see AWS API Documentation
*/
default ListReviewableHITsPublisher listReviewableHITsPaginator() {
return listReviewableHITsPaginator(ListReviewableHiTsRequest.builder().build());
}
/**
*
* The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
* to Reviewing that belong to the Requester calling the operation.
*
*
*
* This is a variant of
* {@link #listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)} operation.
*
*
* @param listReviewableHiTsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewableHITs
* @see AWS API Documentation
*/
default ListReviewableHITsPublisher listReviewableHITsPaginator(ListReviewableHiTsRequest listReviewableHiTsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal
* to Reviewing that belong to the Requester calling the operation.
*
*
*
* This is a variant of
* {@link #listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListReviewableHITsPublisher publisher = client.listReviewableHITsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listReviewableHITs(software.amazon.awssdk.services.mturk.model.ListReviewableHiTsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListReviewableHiTsRequest.Builder} avoiding the
* need to create one manually via {@link ListReviewableHiTsRequest#builder()}
*
*
* @param listReviewableHiTsRequest
* A {@link Consumer} that will call methods on {@link ListReviewableHITsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListReviewableHITs
* @see AWS API Documentation
*/
default ListReviewableHITsPublisher listReviewableHITsPaginator(
Consumer listReviewableHiTsRequest) {
return listReviewableHITsPaginator(ListReviewableHiTsRequest.builder().applyMutation(listReviewableHiTsRequest).build());
}
/**
*
* The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
* HITs.
*
*
* @param listWorkerBlocksRequest
* @return A Java Future containing the result of the ListWorkerBlocks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkerBlocks
* @see AWS API Documentation
*/
default CompletableFuture listWorkerBlocks(ListWorkerBlocksRequest listWorkerBlocksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
* HITs.
*
*
*
* This is a convenience which creates an instance of the {@link ListWorkerBlocksRequest.Builder} avoiding the need
* to create one manually via {@link ListWorkerBlocksRequest#builder()}
*
*
* @param listWorkerBlocksRequest
* A {@link Consumer} that will call methods on {@link ListWorkerBlocksRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListWorkerBlocks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkerBlocks
* @see AWS API Documentation
*/
default CompletableFuture listWorkerBlocks(
Consumer listWorkerBlocksRequest) {
return listWorkerBlocks(ListWorkerBlocksRequest.builder().applyMutation(listWorkerBlocksRequest).build());
}
/**
*
* The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
* HITs.
*
*
* @return A Java Future containing the result of the ListWorkerBlocks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkerBlocks
* @see AWS API Documentation
*/
default CompletableFuture listWorkerBlocks() {
return listWorkerBlocks(ListWorkerBlocksRequest.builder().build());
}
/**
*
* The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
* HITs.
*
*
*
* This is a variant of
* {@link #listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkerBlocks
* @see AWS API Documentation
*/
default ListWorkerBlocksPublisher listWorkerBlocksPaginator() {
return listWorkerBlocksPaginator(ListWorkerBlocksRequest.builder().build());
}
/**
*
* The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
* HITs.
*
*
*
* This is a variant of
* {@link #listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)} operation.
*
*
* @param listWorkerBlocksRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkerBlocks
* @see AWS API Documentation
*/
default ListWorkerBlocksPublisher listWorkerBlocksPaginator(ListWorkerBlocksRequest listWorkerBlocksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your
* HITs.
*
*
*
* This is a variant of
* {@link #listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkerBlocksPublisher publisher = client.listWorkerBlocksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listWorkerBlocks(software.amazon.awssdk.services.mturk.model.ListWorkerBlocksRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListWorkerBlocksRequest.Builder} avoiding the need
* to create one manually via {@link ListWorkerBlocksRequest#builder()}
*
*
* @param listWorkerBlocksRequest
* A {@link Consumer} that will call methods on {@link ListWorkerBlocksRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkerBlocks
* @see AWS API Documentation
*/
default ListWorkerBlocksPublisher listWorkerBlocksPaginator(Consumer listWorkerBlocksRequest) {
return listWorkerBlocksPaginator(ListWorkerBlocksRequest.builder().applyMutation(listWorkerBlocksRequest).build());
}
/**
*
* The ListWorkersWithQualificationType operation returns all of the Workers that have been associated
* with a given Qualification type.
*
*
* @param listWorkersWithQualificationTypeRequest
* @return A Java Future containing the result of the ListWorkersWithQualificationType operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkersWithQualificationType
* @see AWS API Documentation
*/
default CompletableFuture listWorkersWithQualificationType(
ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListWorkersWithQualificationType operation returns all of the Workers that have been associated
* with a given Qualification type.
*
*
*
* This is a convenience which creates an instance of the {@link ListWorkersWithQualificationTypeRequest.Builder}
* avoiding the need to create one manually via {@link ListWorkersWithQualificationTypeRequest#builder()}
*
*
* @param listWorkersWithQualificationTypeRequest
* A {@link Consumer} that will call methods on {@link ListWorkersWithQualificationTypeRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListWorkersWithQualificationType operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkersWithQualificationType
* @see AWS API Documentation
*/
default CompletableFuture listWorkersWithQualificationType(
Consumer listWorkersWithQualificationTypeRequest) {
return listWorkersWithQualificationType(ListWorkersWithQualificationTypeRequest.builder()
.applyMutation(listWorkersWithQualificationTypeRequest).build());
}
/**
*
* The ListWorkersWithQualificationType operation returns all of the Workers that have been associated
* with a given Qualification type.
*
*
*
* This is a variant of
* {@link #listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher publisher = client.listWorkersWithQualificationTypePaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher publisher = client.listWorkersWithQualificationTypePaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)}
* operation.
*
*
* @param listWorkersWithQualificationTypeRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkersWithQualificationType
* @see AWS API Documentation
*/
default ListWorkersWithQualificationTypePublisher listWorkersWithQualificationTypePaginator(
ListWorkersWithQualificationTypeRequest listWorkersWithQualificationTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The ListWorkersWithQualificationType operation returns all of the Workers that have been associated
* with a given Qualification type.
*
*
*
* This is a variant of
* {@link #listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher publisher = client.listWorkersWithQualificationTypePaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mturk.paginators.ListWorkersWithQualificationTypePublisher publisher = client.listWorkersWithQualificationTypePaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listWorkersWithQualificationType(software.amazon.awssdk.services.mturk.model.ListWorkersWithQualificationTypeRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListWorkersWithQualificationTypeRequest.Builder}
* avoiding the need to create one manually via {@link ListWorkersWithQualificationTypeRequest#builder()}
*
*
* @param listWorkersWithQualificationTypeRequest
* A {@link Consumer} that will call methods on {@link ListWorkersWithQualificationTypeRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.ListWorkersWithQualificationType
* @see AWS API Documentation
*/
default ListWorkersWithQualificationTypePublisher listWorkersWithQualificationTypePaginator(
Consumer listWorkersWithQualificationTypeRequest) {
return listWorkersWithQualificationTypePaginator(ListWorkersWithQualificationTypeRequest.builder()
.applyMutation(listWorkersWithQualificationTypeRequest).build());
}
/**
*
* The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker
* ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers
* operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously
* approved or rejected work from the Worker.
*
*
* @param notifyWorkersRequest
* @return A Java Future containing the result of the NotifyWorkers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.NotifyWorkers
* @see AWS
* API Documentation
*/
default CompletableFuture notifyWorkers(NotifyWorkersRequest notifyWorkersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker
* ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers
* operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously
* approved or rejected work from the Worker.
*
*
*
* This is a convenience which creates an instance of the {@link NotifyWorkersRequest.Builder} avoiding the need to
* create one manually via {@link NotifyWorkersRequest#builder()}
*
*
* @param notifyWorkersRequest
* A {@link Consumer} that will call methods on {@link NotifyWorkersRequest.Builder} to create a request.
* @return A Java Future containing the result of the NotifyWorkers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.NotifyWorkers
* @see AWS
* API Documentation
*/
default CompletableFuture notifyWorkers(Consumer notifyWorkersRequest) {
return notifyWorkers(NotifyWorkersRequest.builder().applyMutation(notifyWorkersRequest).build());
}
/**
*
* The RejectAssignment operation rejects the results of a completed assignment.
*
*
* You can include an optional feedback message with the rejection, which the Worker can see in the Status section
* of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the
* assignment was rejected, and can improve the quality of the results the Worker submits in the future.
*
*
* Only the Requester who created the HIT can reject an assignment for the HIT.
*
*
* @param rejectAssignmentRequest
* @return A Java Future containing the result of the RejectAssignment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.RejectAssignment
* @see AWS API Documentation
*/
default CompletableFuture rejectAssignment(RejectAssignmentRequest rejectAssignmentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The RejectAssignment operation rejects the results of a completed assignment.
*
*
* You can include an optional feedback message with the rejection, which the Worker can see in the Status section
* of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the
* assignment was rejected, and can improve the quality of the results the Worker submits in the future.
*
*
* Only the Requester who created the HIT can reject an assignment for the HIT.
*
*
*
* This is a convenience which creates an instance of the {@link RejectAssignmentRequest.Builder} avoiding the need
* to create one manually via {@link RejectAssignmentRequest#builder()}
*
*
* @param rejectAssignmentRequest
* A {@link Consumer} that will call methods on {@link RejectAssignmentRequest.Builder} to create a request.
* @return A Java Future containing the result of the RejectAssignment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.RejectAssignment
* @see AWS API Documentation
*/
default CompletableFuture rejectAssignment(
Consumer rejectAssignmentRequest) {
return rejectAssignment(RejectAssignmentRequest.builder().applyMutation(rejectAssignmentRequest).build());
}
/**
*
* The RejectQualificationRequest operation rejects a user's request for a Qualification.
*
*
* You can provide a text message explaining why the request was rejected. The Worker who made the request can see
* this message.
*
*
* @param rejectQualificationRequestRequest
* @return A Java Future containing the result of the RejectQualificationRequest operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.RejectQualificationRequest
* @see AWS API Documentation
*/
default CompletableFuture rejectQualificationRequest(
RejectQualificationRequestRequest rejectQualificationRequestRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The RejectQualificationRequest operation rejects a user's request for a Qualification.
*
*
* You can provide a text message explaining why the request was rejected. The Worker who made the request can see
* this message.
*
*
*
* This is a convenience which creates an instance of the {@link RejectQualificationRequestRequest.Builder} avoiding
* the need to create one manually via {@link RejectQualificationRequestRequest#builder()}
*
*
* @param rejectQualificationRequestRequest
* A {@link Consumer} that will call methods on {@link RejectQualificationRequestRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RejectQualificationRequest operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.RejectQualificationRequest
* @see AWS API Documentation
*/
default CompletableFuture rejectQualificationRequest(
Consumer rejectQualificationRequestRequest) {
return rejectQualificationRequest(RejectQualificationRequestRequest.builder()
.applyMutation(rejectQualificationRequestRequest).build());
}
/**
*
* The SendBonus operation issues a payment of money from your account to a Worker. This payment
* happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus
* operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must
* include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment.
* Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if
* your account does not have enough funds to pay for both the bonus and the fees.
*
*
* @param sendBonusRequest
* @return A Java Future containing the result of the SendBonus operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.SendBonus
* @see AWS API
* Documentation
*/
default CompletableFuture sendBonus(SendBonusRequest sendBonusRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The SendBonus operation issues a payment of money from your account to a Worker. This payment
* happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus
* operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must
* include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment.
* Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if
* your account does not have enough funds to pay for both the bonus and the fees.
*
*
*
* This is a convenience which creates an instance of the {@link SendBonusRequest.Builder} avoiding the need to
* create one manually via {@link SendBonusRequest#builder()}
*
*
* @param sendBonusRequest
* A {@link Consumer} that will call methods on {@link SendBonusRequest.Builder} to create a request.
* @return A Java Future containing the result of the SendBonus operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.SendBonus
* @see AWS API
* Documentation
*/
default CompletableFuture sendBonus(Consumer sendBonusRequest) {
return sendBonus(SendBonusRequest.builder().applyMutation(sendBonusRequest).build());
}
/**
*
* The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message
* as if a HIT event occurred, according to the provided notification specification. This allows you to test
* notifications without setting up notifications for a real HIT type and trying to trigger them using the website.
* When you call this operation, the service attempts to send the test notification immediately.
*
*
* @param sendTestEventNotificationRequest
* @return A Java Future containing the result of the SendTestEventNotification operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.SendTestEventNotification
* @see AWS API Documentation
*/
default CompletableFuture sendTestEventNotification(
SendTestEventNotificationRequest sendTestEventNotificationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message
* as if a HIT event occurred, according to the provided notification specification. This allows you to test
* notifications without setting up notifications for a real HIT type and trying to trigger them using the website.
* When you call this operation, the service attempts to send the test notification immediately.
*
*
*
* This is a convenience which creates an instance of the {@link SendTestEventNotificationRequest.Builder} avoiding
* the need to create one manually via {@link SendTestEventNotificationRequest#builder()}
*
*
* @param sendTestEventNotificationRequest
* A {@link Consumer} that will call methods on {@link SendTestEventNotificationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the SendTestEventNotification operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.SendTestEventNotification
* @see AWS API Documentation
*/
default CompletableFuture sendTestEventNotification(
Consumer sendTestEventNotificationRequest) {
return sendTestEventNotification(SendTestEventNotificationRequest.builder()
.applyMutation(sendTestEventNotificationRequest).build());
}
/**
*
* The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update
* it to a time in the past, the HIT will be immediately expired.
*
*
* @param updateExpirationForHitRequest
* @return A Java Future containing the result of the UpdateExpirationForHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateExpirationForHIT
* @see AWS API Documentation
*/
default CompletableFuture updateExpirationForHIT(
UpdateExpirationForHitRequest updateExpirationForHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update
* it to a time in the past, the HIT will be immediately expired.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateExpirationForHitRequest.Builder} avoiding the
* need to create one manually via {@link UpdateExpirationForHitRequest#builder()}
*
*
* @param updateExpirationForHitRequest
* A {@link Consumer} that will call methods on {@link UpdateExpirationForHITRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateExpirationForHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateExpirationForHIT
* @see AWS API Documentation
*/
default CompletableFuture updateExpirationForHIT(
Consumer updateExpirationForHitRequest) {
return updateExpirationForHIT(UpdateExpirationForHitRequest.builder().applyMutation(updateExpirationForHitRequest)
.build());
}
/**
*
* The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this
* operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status.
*
*
* @param updateHitReviewStatusRequest
* @return A Java Future containing the result of the UpdateHITReviewStatus operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateHITReviewStatus
* @see AWS API Documentation
*/
default CompletableFuture updateHITReviewStatus(
UpdateHitReviewStatusRequest updateHitReviewStatusRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this
* operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateHitReviewStatusRequest.Builder} avoiding the
* need to create one manually via {@link UpdateHitReviewStatusRequest#builder()}
*
*
* @param updateHitReviewStatusRequest
* A {@link Consumer} that will call methods on {@link UpdateHITReviewStatusRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateHITReviewStatus operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateHITReviewStatus
* @see AWS API Documentation
*/
default CompletableFuture updateHITReviewStatus(
Consumer updateHitReviewStatusRequest) {
return updateHITReviewStatus(UpdateHitReviewStatusRequest.builder().applyMutation(updateHitReviewStatusRequest).build());
}
/**
*
* The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This
* operation disassociates the HIT from its old HITType properties and associates it with the new HITType
* properties. The HIT takes on the properties of the new HITType in place of the old ones.
*
*
* @param updateHitTypeOfHitRequest
* @return A Java Future containing the result of the UpdateHITTypeOfHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateHITTypeOfHIT
* @see AWS API Documentation
*/
default CompletableFuture updateHITTypeOfHIT(UpdateHitTypeOfHitRequest updateHitTypeOfHitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This
* operation disassociates the HIT from its old HITType properties and associates it with the new HITType
* properties. The HIT takes on the properties of the new HITType in place of the old ones.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateHitTypeOfHitRequest.Builder} avoiding the
* need to create one manually via {@link UpdateHitTypeOfHitRequest#builder()}
*
*
* @param updateHitTypeOfHitRequest
* A {@link Consumer} that will call methods on {@link UpdateHITTypeOfHITRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateHITTypeOfHIT operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateHITTypeOfHIT
* @see AWS API Documentation
*/
default CompletableFuture updateHITTypeOfHIT(
Consumer updateHitTypeOfHitRequest) {
return updateHITTypeOfHIT(UpdateHitTypeOfHitRequest.builder().applyMutation(updateHitTypeOfHitRequest).build());
}
/**
*
* The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for
* a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification
* specification, the operation replaces the old specification with a new one. You can call the
* UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to
* modify the notification specification itself by providing updates to the Active status without specifying a new
* notification specification. To change the Active status of a HIT type's notifications, the HIT type must already
* have a notification specification, or one must be provided in the same call to
* UpdateNotificationSettings.
*
*
* @param updateNotificationSettingsRequest
* @return A Java Future containing the result of the UpdateNotificationSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateNotificationSettings
* @see AWS API Documentation
*/
default CompletableFuture updateNotificationSettings(
UpdateNotificationSettingsRequest updateNotificationSettingsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for
* a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification
* specification, the operation replaces the old specification with a new one. You can call the
* UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to
* modify the notification specification itself by providing updates to the Active status without specifying a new
* notification specification. To change the Active status of a HIT type's notifications, the HIT type must already
* have a notification specification, or one must be provided in the same call to
* UpdateNotificationSettings.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateNotificationSettingsRequest.Builder} avoiding
* the need to create one manually via {@link UpdateNotificationSettingsRequest#builder()}
*
*
* @param updateNotificationSettingsRequest
* A {@link Consumer} that will call methods on {@link UpdateNotificationSettingsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateNotificationSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateNotificationSettings
* @see AWS API Documentation
*/
default CompletableFuture updateNotificationSettings(
Consumer updateNotificationSettingsRequest) {
return updateNotificationSettings(UpdateNotificationSettingsRequest.builder()
.applyMutation(updateNotificationSettingsRequest).build());
}
/**
*
* The UpdateQualificationType operation modifies the attributes of an existing Qualification type,
* which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its
* attributes.
*
*
* Most attributes of a Qualification type can be changed after the type has been created. However, the Name and
* Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the
* delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.
*
*
* You can use this operation to update the test for a Qualification type. The test is updated based on the values
* specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated
* test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters.
* The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.
*
*
* If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a
* test from a Qualification type that has one. If the type already has a test, you cannot update it to be
* AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will
* henceforth have a test.
*
*
* If you want to update the test duration or answer key for an existing test without changing the questions, you
* must specify a Test parameter with the original questions, along with the updated values.
*
*
* If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such
* Qualifications must be granted manually.
*
*
* You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.
*
*
* @param updateQualificationTypeRequest
* @return A Java Future containing the result of the UpdateQualificationType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateQualificationType
* @see AWS API Documentation
*/
default CompletableFuture updateQualificationType(
UpdateQualificationTypeRequest updateQualificationTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The UpdateQualificationType operation modifies the attributes of an existing Qualification type,
* which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its
* attributes.
*
*
* Most attributes of a Qualification type can be changed after the type has been created. However, the Name and
* Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the
* delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.
*
*
* You can use this operation to update the test for a Qualification type. The test is updated based on the values
* specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated
* test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters.
* The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.
*
*
* If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a
* test from a Qualification type that has one. If the type already has a test, you cannot update it to be
* AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will
* henceforth have a test.
*
*
* If you want to update the test duration or answer key for an existing test without changing the questions, you
* must specify a Test parameter with the original questions, along with the updated values.
*
*
* If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such
* Qualifications must be granted manually.
*
*
* You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateQualificationTypeRequest.Builder} avoiding
* the need to create one manually via {@link UpdateQualificationTypeRequest#builder()}
*
*
* @param updateQualificationTypeRequest
* A {@link Consumer} that will call methods on {@link UpdateQualificationTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateQualificationType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ServiceException Amazon Mechanical Turk is temporarily unable to process your request. Try your call
* again.
* - RequestErrorException Your request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - MTurkException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample MTurkAsyncClient.UpdateQualificationType
* @see AWS API Documentation
*/
default CompletableFuture updateQualificationType(
Consumer updateQualificationTypeRequest) {
return updateQualificationType(UpdateQualificationTypeRequest.builder().applyMutation(updateQualificationTypeRequest)
.build());
}
}