com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomainAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 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 com.amazonaws.services.cloudsearchdomain;
import com.amazonaws.services.cloudsearchdomain.model.*;
/**
* Interface for accessing Amazon CloudSearch Domain asynchronously. Each
* asynchronous method will return a Java Future object representing the
* asynchronous operation; overloads which accept an {@code 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.
*
*/
public interface AmazonCloudSearchDomainAsync extends AmazonCloudSearchDomain {
/**
*
* 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.
*
*
* @param searchRequest
* Container for the parameters to the Search request.
* @return A Java Future containing the result of the Search operation
* returned by the service.
* @sample AmazonCloudSearchDomainAsync.Search
*/
java.util.concurrent.Future searchAsync(
SearchRequest searchRequest);
/**
*
* 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.
*
*
* @param searchRequest
* Container for the parameters to the Search request.
* @param 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.
* @return A Java Future containing the result of the Search operation
* returned by the service.
* @sample AmazonCloudSearchDomainAsyncHandler.Search
*/
java.util.concurrent.Future searchAsync(
SearchRequest searchRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param suggestRequest
* Container for the parameters to the Suggest request.
* @return A Java Future containing the result of the Suggest operation
* returned by the service.
* @sample AmazonCloudSearchDomainAsync.Suggest
*/
java.util.concurrent.Future suggestAsync(
SuggestRequest suggestRequest);
/**
*
* 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.
*
*
* @param suggestRequest
* Container for the parameters to the Suggest request.
* @param 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.
* @return A Java Future containing the result of the Suggest operation
* returned by the service.
* @sample AmazonCloudSearchDomainAsyncHandler.Suggest
*/
java.util.concurrent.Future suggestAsync(
SuggestRequest suggestRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param uploadDocumentsRequest
* Container for the parameters to the UploadDocuments
* request.
* @return A Java Future containing the result of the UploadDocuments
* operation returned by the service.
* @sample AmazonCloudSearchDomainAsync.UploadDocuments
*/
java.util.concurrent.Future uploadDocumentsAsync(
UploadDocumentsRequest uploadDocumentsRequest);
/**
*
* 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.
*
*
* @param uploadDocumentsRequest
* Container for the parameters to the UploadDocuments
* request.
* @param 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.
* @return A Java Future containing the result of the UploadDocuments
* operation returned by the service.
* @sample AmazonCloudSearchDomainAsyncHandler.UploadDocuments
*/
java.util.concurrent.Future uploadDocumentsAsync(
UploadDocumentsRequest uploadDocumentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}