@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCloudSearchDomainAsyncClient extends AmazonCloudSearchDomainClient implements AmazonCloudSearchDomainAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonCloudSearchDomainAsyncClient()
Deprecated.
|
AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonCloudSearchDomainAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AmazonCloudSearchDomainAsyncClientBuilder |
asyncBuilder() |
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<SearchResult> |
searchAsync(SearchRequest request)
Retrieves a list of documents that match the specified search criteria.
|
Future<SearchResult> |
searchAsync(SearchRequest request,
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 request)
Retrieves autocomplete suggestions for a partial query string.
|
Future<SuggestResult> |
suggestAsync(SuggestRequest request,
AsyncHandler<SuggestRequest,SuggestResult> asyncHandler)
Retrieves autocomplete suggestions for a partial query string.
|
Future<UploadDocumentsResult> |
uploadDocumentsAsync(UploadDocumentsRequest request)
Posts a batch of documents to a search domain for indexing.
|
Future<UploadDocumentsResult> |
uploadDocumentsAsync(UploadDocumentsRequest request,
AsyncHandler<UploadDocumentsRequest,UploadDocumentsResult> asyncHandler)
Posts a batch of documents to a search domain for indexing.
|
builder, getCachedResponseMetadata, search, suggest, uploadDocumentsaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetCachedResponseMetadata, search, setEndpoint, setRegion, suggest, uploadDocuments@Deprecated public AmazonCloudSearchDomainAsyncClient()
AmazonCloudSearchDomainAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonCloudSearchDomainAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudSearch Domain (ex:
proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonCloudSearchDomainAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
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).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonCloudSearchDomainAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.public static AmazonCloudSearchDomainAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<SearchResult> searchAsync(SearchRequest request)
AmazonCloudSearchDomainAsyncRetrieves 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.
searchAsync in interface AmazonCloudSearchDomainAsyncrequest - Container for the parameters to the Search request.public Future<SearchResult> searchAsync(SearchRequest request, AsyncHandler<SearchRequest,SearchResult> asyncHandler)
AmazonCloudSearchDomainAsyncRetrieves 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.
searchAsync in interface AmazonCloudSearchDomainAsyncrequest - Container for the parameters to the Search request.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SuggestResult> suggestAsync(SuggestRequest request)
AmazonCloudSearchDomainAsyncRetrieves 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.
suggestAsync in interface AmazonCloudSearchDomainAsyncrequest - Container for the parameters to the Suggest request.public Future<SuggestResult> suggestAsync(SuggestRequest request, AsyncHandler<SuggestRequest,SuggestResult> asyncHandler)
AmazonCloudSearchDomainAsyncRetrieves 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.
suggestAsync in interface AmazonCloudSearchDomainAsyncrequest - Container for the parameters to the Suggest request.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UploadDocumentsResult> uploadDocumentsAsync(UploadDocumentsRequest request)
AmazonCloudSearchDomainAsyncPosts 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.
uploadDocumentsAsync in interface AmazonCloudSearchDomainAsyncrequest - Container for the parameters to the UploadDocuments request.public Future<UploadDocumentsResult> uploadDocumentsAsync(UploadDocumentsRequest request, AsyncHandler<UploadDocumentsRequest,UploadDocumentsResult> asyncHandler)
AmazonCloudSearchDomainAsyncPosts 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.
uploadDocumentsAsync in interface AmazonCloudSearchDomainAsyncrequest - Container for the parameters to the UploadDocuments request.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonCloudSearchDomainshutdown in class AmazonCloudSearchDomainClient