@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCloudSearchDomainAsync extends AbstractAmazonCloudSearchDomain implements AmazonCloudSearchDomainAsync
AmazonCloudSearchDomainAsync
. Convenient method forms pass through to the
corresponding overload that takes a request object and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
getCachedResponseMetadata, search, setEndpoint, setRegion, shutdown, suggest, uploadDocuments
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCachedResponseMetadata, search, setEndpoint, setRegion, shutdown, suggest, uploadDocuments
public Future<SearchResult> searchAsync(SearchRequest request)
AmazonCloudSearchDomainAsync
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.
searchAsync
in interface AmazonCloudSearchDomainAsync
request
- Container for the parameters to the Search
request.public Future<SearchResult> searchAsync(SearchRequest request, AsyncHandler<SearchRequest,SearchResult> asyncHandler)
AmazonCloudSearchDomainAsync
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.
searchAsync
in interface AmazonCloudSearchDomainAsync
request
- 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)
AmazonCloudSearchDomainAsync
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.
suggestAsync
in interface AmazonCloudSearchDomainAsync
request
- Container for the parameters to the Suggest
request.public Future<SuggestResult> suggestAsync(SuggestRequest request, AsyncHandler<SuggestRequest,SuggestResult> asyncHandler)
AmazonCloudSearchDomainAsync
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.
suggestAsync
in interface AmazonCloudSearchDomainAsync
request
- 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)
AmazonCloudSearchDomainAsync
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.
uploadDocumentsAsync
in interface AmazonCloudSearchDomainAsync
request
- Container for the parameters to the UploadDocuments
request.public Future<UploadDocumentsResult> uploadDocumentsAsync(UploadDocumentsRequest request, AsyncHandler<UploadDocumentsRequest,UploadDocumentsResult> asyncHandler)
AmazonCloudSearchDomainAsync
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.
uploadDocumentsAsync
in interface AmazonCloudSearchDomainAsync
request
- 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.