com.amazonaws.services.cloudsearchdomain

Class AmazonCloudSearchDomainAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomainClient

com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomainAsyncClient

All Implemented Interfaces:

AmazonCloudSearchDomain, AmazonCloudSearchDomainAsync

public class AmazonCloudSearchDomainAsyncClient
extends AmazonCloudSearchDomainClient
implements AmazonCloudSearchDomainAsync

Asynchronous client for accessing AmazonCloudSearchDomain. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread.

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

The endpoints for submitting UploadDocuments , Search , and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide .

Field Summary

Fields inherited from class com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomainClient

jsonErrorUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonCloudSearchDomainAsyncClient() Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain.
AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials.
AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials, executor service, and client configuration options.
AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials and executor service.
AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials provider.
AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials provider and client configuration options.
AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials provider, executor service, and client configuration options.
AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials provider and executor service.
AmazonCloudSearchDomainAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain.

Method Summary

Methods

Modifier and Type	Method and Description
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<SearchResult>	searchAsync(SearchRequest searchRequest) Retrieves a list of documents that match the specified search criteria.
Future<SearchResult>	searchAsync(SearchRequest searchRequest, AsyncHandler<SearchRequest,SearchResult> asyncHandler) Retrieves a list of documents that match the specified search criteria.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<SuggestResult>	suggestAsync(SuggestRequest suggestRequest) Retrieves autocomplete suggestions for a partial query string.
Future<SuggestResult>	suggestAsync(SuggestRequest suggestRequest, AsyncHandler<SuggestRequest,SuggestResult> asyncHandler) Retrieves autocomplete suggestions for a partial query string.
Future<UploadDocumentsResult>	uploadDocumentsAsync(UploadDocumentsRequest uploadDocumentsRequest) Posts a batch of documents to a search domain for indexing.
Future<UploadDocumentsResult>	uploadDocumentsAsync(UploadDocumentsRequest uploadDocumentsRequest, AsyncHandler<UploadDocumentsRequest,UploadDocumentsResult> asyncHandler) Posts a batch of documents to a search domain for indexing.

Methods inherited from class com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomainClient

getCachedResponseMetadata, search, setEndpoint, setEndpoint, suggest, uploadDocuments

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomain

getCachedResponseMetadata, search, setEndpoint, setRegion, suggest, uploadDocuments

Constructor Detail

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonCloudSearchDomain (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials,
                                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials,
                                  ClientConfiguration clientConfiguration,
                                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials provider and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

AmazonCloudSearchDomainAsyncClient

public AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ClientConfiguration clientConfiguration,
                                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearchDomain using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonCloudSearchDomain

Overrides:

shutdown in class AmazonWebServiceClient

uploadDocumentsAsync

public Future<UploadDocumentsResult> uploadDocumentsAsync(UploadDocumentsRequest uploadDocumentsRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide . For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide .

Specified by:

uploadDocumentsAsync in interface AmazonCloudSearchDomainAsync

Parameters:

uploadDocumentsRequest - Container for the necessary parameters to execute the UploadDocuments operation on AmazonCloudSearchDomain.

Returns:

A Java Future object containing the response from the UploadDocuments service method, as returned by AmazonCloudSearchDomain.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearchDomain indicating either a problem with the data in the request, or a server side issue.

uploadDocumentsAsync

public Future<UploadDocumentsResult> uploadDocumentsAsync(UploadDocumentsRequest uploadDocumentsRequest,
                                                 AsyncHandler<UploadDocumentsRequest,UploadDocumentsResult> asyncHandler)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide . For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide .

Specified by:

uploadDocumentsAsync in interface AmazonCloudSearchDomainAsync

Parameters:

uploadDocumentsRequest - Container for the necessary parameters to execute the UploadDocuments operation on AmazonCloudSearchDomain.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the UploadDocuments service method, as returned by AmazonCloudSearchDomain.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearchDomain indicating either a problem with the data in the request, or a server side issue.

suggestAsync

public Future<SuggestResult> suggestAsync(SuggestRequest suggestRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide .

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

Specified by:

suggestAsync in interface AmazonCloudSearchDomainAsync

Parameters:

suggestRequest - Container for the necessary parameters to execute the Suggest operation on AmazonCloudSearchDomain.

Returns:

A Java Future object containing the response from the Suggest service method, as returned by AmazonCloudSearchDomain.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearchDomain indicating either a problem with the data in the request, or a server side issue.

suggestAsync

public Future<SuggestResult> suggestAsync(SuggestRequest suggestRequest,
                                 AsyncHandler<SuggestRequest,SuggestResult> asyncHandler)
                                   throws AmazonServiceException,
                                          AmazonClientException

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide .

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

Specified by:

suggestAsync in interface AmazonCloudSearchDomainAsync

Parameters:

suggestRequest - Container for the necessary parameters to execute the Suggest operation on AmazonCloudSearchDomain.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the Suggest service method, as returned by AmazonCloudSearchDomain.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearchDomain indicating either a problem with the data in the request, or a server side issue.

searchAsync

public Future<SearchResult> searchAsync(SearchRequest searchRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:

• simple : search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes.
• structured : search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.
• lucene : specify search criteria using the Apache Lucene query parser syntax.
• dismax : specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.

For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide .

The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

Specified by:

searchAsync in interface AmazonCloudSearchDomainAsync

Parameters:

searchRequest - Container for the necessary parameters to execute the Search operation on AmazonCloudSearchDomain.

Returns:

A Java Future object containing the response from the Search service method, as returned by AmazonCloudSearchDomain.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearchDomain indicating either a problem with the data in the request, or a server side issue.

searchAsync

public Future<SearchResult> searchAsync(SearchRequest searchRequest,
                               AsyncHandler<SearchRequest,SearchResult> asyncHandler)
                                 throws AmazonServiceException,
                                        AmazonClientException

Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:

• simple : search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes.
• structured : search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.
• lucene : specify search criteria using the Apache Lucene query parser syntax.
• dismax : specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.

For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide .

The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

Specified by:

searchAsync in interface AmazonCloudSearchDomainAsync

Parameters:

searchRequest - Container for the necessary parameters to execute the Search operation on AmazonCloudSearchDomain.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the Search service method, as returned by AmazonCloudSearchDomain.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearchDomain indicating either a problem with the data in the request, or a server side issue.