|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
java.lang.Objectcom.amazonaws.AmazonWebServiceClient
com.amazonaws.services.cloudsearch.AmazonCloudSearchClient
com.amazonaws.services.cloudsearch.AmazonCloudSearchAsyncClient
public class AmazonCloudSearchAsyncClient
Client for accessing AmazonCloudSearch. All calls made using this client are non-blocking and will immediately return a Java Future. Callers must use the Future object to determine when the service call has actually completed. Amazon CloudSearch Configuration Service
You use the Configuration Service to create, configure, and manage
search domains. Amazon CloudSearch configuration requests are
submitted to cloudsearch.us-east-1.amazonaws.com using
the AWS Query protocol.
| Constructor Summary | |
|---|---|
AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials. |
|
AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials, executor service, and client configuration options. |
|
AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials and executor service. |
|
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials provider. |
|
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials provider, executor service, and client configuration options. |
|
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials provider and executor service. |
|
| Method Summary | |
|---|---|
Future<CreateDomainResult> |
createDomainAsync(CreateDomainRequest createDomainRequest)
Creates a new search domain. |
Future<DefineIndexFieldResult> |
defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest)
Configures an IndexField for the search domain. |
Future<DefineRankExpressionResult> |
defineRankExpressionAsync(DefineRankExpressionRequest defineRankExpressionRequest)
Configures a RankExpression for the search domain. |
Future<DeleteDomainResult> |
deleteDomainAsync(DeleteDomainRequest deleteDomainRequest)
Permanently deletes a search domain and all of its data. |
Future<DeleteIndexFieldResult> |
deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest)
Removes an IndexField from the search domain. |
Future<DeleteRankExpressionResult> |
deleteRankExpressionAsync(DeleteRankExpressionRequest deleteRankExpressionRequest)
Removes a RankExpression from the search domain. |
Future<DescribeDefaultSearchFieldResult> |
describeDefaultSearchFieldAsync(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest)
Gets the default search field configured for the search domain. |
Future<DescribeDomainsResult> |
describeDomainsAsync(DescribeDomainsRequest describeDomainsRequest)
Gets information about the search domains owned by this account. |
Future<DescribeIndexFieldsResult> |
describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest)
Gets information about the index fields configured for the search domain. |
Future<DescribeRankExpressionsResult> |
describeRankExpressionsAsync(DescribeRankExpressionsRequest describeRankExpressionsRequest)
Gets the rank expressions configured for the search domain. |
Future<DescribeServiceAccessPoliciesResult> |
describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)
Gets information about the resource-based policies that control access to the domain's document and search services. |
Future<DescribeStemmingOptionsResult> |
describeStemmingOptionsAsync(DescribeStemmingOptionsRequest describeStemmingOptionsRequest)
Gets the stemming dictionary configured for the search domain. |
Future<DescribeStopwordOptionsResult> |
describeStopwordOptionsAsync(DescribeStopwordOptionsRequest describeStopwordOptionsRequest)
Gets the stopwords configured for the search domain. |
Future<DescribeSynonymOptionsResult> |
describeSynonymOptionsAsync(DescribeSynonymOptionsRequest describeSynonymOptionsRequest)
Gets the synonym dictionary configured for the search domain. |
ExecutorService |
getExecutorService()
Returns the executor service used by this async client to execute requests. |
Future<IndexDocumentsResult> |
indexDocumentsAsync(IndexDocumentsRequest indexDocumentsRequest)
Tells the search domain to start indexing its documents using the latest text processing options and IndexFields . |
void |
shutdown()
Shuts down the client, releasing all managed resources. |
Future<UpdateDefaultSearchFieldResult> |
updateDefaultSearchFieldAsync(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest)
Configures the default search field for the search domain. |
Future<UpdateServiceAccessPoliciesResult> |
updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)
Configures the policies that control access to the domain's document and search services. |
Future<UpdateStemmingOptionsResult> |
updateStemmingOptionsAsync(UpdateStemmingOptionsRequest updateStemmingOptionsRequest)
Configures a stemming dictionary for the search domain. |
Future<UpdateStopwordOptionsResult> |
updateStopwordOptionsAsync(UpdateStopwordOptionsRequest updateStopwordOptionsRequest)
Configures stopwords for the search domain. |
Future<UpdateSynonymOptionsResult> |
updateSynonymOptionsAsync(UpdateSynonymOptionsRequest updateSynonymOptionsRequest)
Configures a synonym dictionary for the search domain. |
| Methods inherited from class com.amazonaws.AmazonWebServiceClient |
|---|
addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials)
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.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.
public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
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.
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.
public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
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.
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.public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
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.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.
public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
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.
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.
public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
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.
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 |
|---|
public ExecutorService getExecutorService()
public void shutdown()
shutdown in interface AmazonCloudSearchshutdown in class AmazonWebServiceClient
public Future<UpdateDefaultSearchFieldResult> updateDefaultSearchFieldAsync(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest)
throws AmazonServiceException,
AmazonClientException
Configures the default search field for the search domain. The default search field is used when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.
updateDefaultSearchFieldAsync in interface AmazonCloudSearchAsyncupdateDefaultSearchFieldRequest - Container for the necessary
parameters to execute the UpdateDefaultSearchField operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DeleteRankExpressionResult> deleteRankExpressionAsync(DeleteRankExpressionRequest deleteRankExpressionRequest)
throws AmazonServiceException,
AmazonClientException
Removes a RankExpression from the search domain.
deleteRankExpressionAsync in interface AmazonCloudSearchAsyncdeleteRankExpressionRequest - Container for the necessary
parameters to execute the DeleteRankExpression operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DescribeRankExpressionsResult> describeRankExpressionsAsync(DescribeRankExpressionsRequest describeRankExpressionsRequest)
throws AmazonServiceException,
AmazonClientException
Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.
describeRankExpressionsAsync in interface AmazonCloudSearchAsyncdescribeRankExpressionsRequest - Container for the necessary
parameters to execute the DescribeRankExpressions operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest)
throws AmazonServiceException,
AmazonClientException
Creates a new search domain.
createDomainAsync in interface AmazonCloudSearchAsynccreateDomainRequest - Container for the necessary parameters to
execute the CreateDomain operation on AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)
throws AmazonServiceException,
AmazonClientException
Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100KB.
updateServiceAccessPoliciesAsync in interface AmazonCloudSearchAsyncupdateServiceAccessPoliciesRequest - Container for the necessary
parameters to execute the UpdateServiceAccessPolicies operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest)
throws AmazonServiceException,
AmazonClientException
Configures an IndexField for the search domain. Used to
create new fields and modify existing ones. If the field exists, the
new configuration replaces the old one. You can configure a maximum of
200 index fields.
defineIndexFieldAsync in interface AmazonCloudSearchAsyncdefineIndexFieldRequest - Container for the necessary parameters
to execute the DefineIndexField operation on AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DefineRankExpressionResult> defineRankExpressionAsync(DefineRankExpressionRequest defineRankExpressionRequest)
throws AmazonServiceException,
AmazonClientException
Configures a RankExpression for the search domain. Used
to create new rank expressions and modify existing ones. If the
expression exists, the new configuration replaces the old one. You can
configure a maximum of 50 rank expressions.
defineRankExpressionAsync in interface AmazonCloudSearchAsyncdefineRankExpressionRequest - Container for the necessary
parameters to execute the DefineRankExpression operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DescribeSynonymOptionsResult> describeSynonymOptionsAsync(DescribeSynonymOptionsRequest describeSynonymOptionsRequest)
throws AmazonServiceException,
AmazonClientException
Gets the synonym dictionary configured for the search domain.
describeSynonymOptionsAsync in interface AmazonCloudSearchAsyncdescribeSynonymOptionsRequest - Container for the necessary
parameters to execute the DescribeSynonymOptions operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DescribeStopwordOptionsResult> describeStopwordOptionsAsync(DescribeStopwordOptionsRequest describeStopwordOptionsRequest)
throws AmazonServiceException,
AmazonClientException
Gets the stopwords configured for the search domain.
describeStopwordOptionsAsync in interface AmazonCloudSearchAsyncdescribeStopwordOptionsRequest - Container for the necessary
parameters to execute the DescribeStopwordOptions operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest)
throws AmazonServiceException,
AmazonClientException
Permanently deletes a search domain and all of its data.
deleteDomainAsync in interface AmazonCloudSearchAsyncdeleteDomainRequest - Container for the necessary parameters to
execute the DeleteDomain operation on AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)
throws AmazonServiceException,
AmazonClientException
Gets information about the resource-based policies that control access to the domain's document and search services.
describeServiceAccessPoliciesAsync in interface AmazonCloudSearchAsyncdescribeServiceAccessPoliciesRequest - Container for the
necessary parameters to execute the DescribeServiceAccessPolicies
operation on AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DescribeDefaultSearchFieldResult> describeDefaultSearchFieldAsync(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest)
throws AmazonServiceException,
AmazonClientException
Gets the default search field configured for the search domain.
describeDefaultSearchFieldAsync in interface AmazonCloudSearchAsyncdescribeDefaultSearchFieldRequest - Container for the necessary
parameters to execute the DescribeDefaultSearchField operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<UpdateStopwordOptionsResult> updateStopwordOptionsAsync(UpdateStopwordOptionsRequest updateStopwordOptionsRequest)
throws AmazonServiceException,
AmazonClientException
Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10KB.
updateStopwordOptionsAsync in interface AmazonCloudSearchAsyncupdateStopwordOptionsRequest - Container for the necessary
parameters to execute the UpdateStopwordOptions operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<UpdateSynonymOptionsResult> updateSynonymOptionsAsync(UpdateSynonymOptionsRequest updateSynonymOptionsRequest)
throws AmazonServiceException,
AmazonClientException
Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100KB.
updateSynonymOptionsAsync in interface AmazonCloudSearchAsyncupdateSynonymOptionsRequest - Container for the necessary
parameters to execute the UpdateSynonymOptions operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<UpdateStemmingOptionsResult> updateStemmingOptionsAsync(UpdateStemmingOptionsRequest updateStemmingOptionsRequest)
throws AmazonServiceException,
AmazonClientException
Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500KB.
updateStemmingOptionsAsync in interface AmazonCloudSearchAsyncupdateStemmingOptionsRequest - Container for the necessary
parameters to execute the UpdateStemmingOptions operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DescribeStemmingOptionsResult> describeStemmingOptionsAsync(DescribeStemmingOptionsRequest describeStemmingOptionsRequest)
throws AmazonServiceException,
AmazonClientException
Gets the stemming dictionary configured for the search domain.
describeStemmingOptionsAsync in interface AmazonCloudSearchAsyncdescribeStemmingOptionsRequest - Container for the necessary
parameters to execute the DescribeStemmingOptions operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest describeDomainsRequest)
throws AmazonServiceException,
AmazonClientException
Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.
describeDomainsAsync in interface AmazonCloudSearchAsyncdescribeDomainsRequest - Container for the necessary parameters
to execute the DescribeDomains operation on AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest indexDocumentsRequest)
throws AmazonServiceException,
AmazonClientException
Tells the search domain to start indexing its documents using the
latest text processing options and IndexFields . This
operation must be invoked to make options whose OptionStatus has
OptionState of RequiresIndexDocuments
visible in search results.
indexDocumentsAsync in interface AmazonCloudSearchAsyncindexDocumentsRequest - Container for the necessary parameters to
execute the IndexDocuments operation on AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest)
throws AmazonServiceException,
AmazonClientException
Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.
describeIndexFieldsAsync in interface AmazonCloudSearchAsyncdescribeIndexFieldsRequest - Container for the necessary
parameters to execute the DescribeIndexFields operation on
AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
public Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest)
throws AmazonServiceException,
AmazonClientException
Removes an IndexField from the search domain.
deleteIndexFieldAsync in interface AmazonCloudSearchAsyncdeleteIndexFieldRequest - Container for the necessary parameters
to execute the DeleteIndexField operation on AmazonCloudSearch.
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 AmazonCloudSearch indicating
either a problem with the data in the request, or a server side issue.
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||