AmazonCloudSearchAsyncClient (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.cloudsearch
Class AmazonCloudSearchAsyncClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.cloudsearch.AmazonCloudSearchClient
          com.amazonaws.services.cloudsearch.AmazonCloudSearchAsyncClient

All Implemented Interfaces:: AmazonCloudSearch, AmazonCloudSearchAsync

public class AmazonCloudSearchAsyncClient
extends AmazonCloudSearchClient
implements AmazonCloudSearchAsync
extends AmazonCloudSearchClient
implements AmazonCloudSearchAsync

Asynchronous client for accessing AmazonCloudSearch. 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. 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()` Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch.
`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)` Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials provider and client configuration options.
`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.
`AmazonCloudSearchAsyncClient(ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch.

Method Summary
`Future<CreateDomainResult>`	`createDomainAsync(CreateDomainRequest createDomainRequest)` Creates a new search domain.
`Future<CreateDomainResult>`	`createDomainAsync(CreateDomainRequest createDomainRequest, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)` Creates a new search domain.
`Future<DefineIndexFieldResult>`	`defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest)` Configures an `IndexField` for the search domain.
`Future<DefineIndexFieldResult>`	`defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest, AsyncHandler<DefineIndexFieldRequest,DefineIndexFieldResult> asyncHandler)` Configures an `IndexField` for the search domain.
`Future<DefineRankExpressionResult>`	`defineRankExpressionAsync(DefineRankExpressionRequest defineRankExpressionRequest)` Configures a `RankExpression` for the search domain.
`Future<DefineRankExpressionResult>`	`defineRankExpressionAsync(DefineRankExpressionRequest defineRankExpressionRequest, AsyncHandler<DefineRankExpressionRequest,DefineRankExpressionResult> asyncHandler)` Configures a `RankExpression` for the search domain.
`Future<DeleteDomainResult>`	`deleteDomainAsync(DeleteDomainRequest deleteDomainRequest)` Permanently deletes a search domain and all of its data.
`Future<DeleteDomainResult>`	`deleteDomainAsync(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)` Permanently deletes a search domain and all of its data.
`Future<DeleteIndexFieldResult>`	`deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest)` Removes an `IndexField` from the search domain.
`Future<DeleteIndexFieldResult>`	`deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest, AsyncHandler<DeleteIndexFieldRequest,DeleteIndexFieldResult> asyncHandler)` Removes an `IndexField` from the search domain.
`Future<DeleteRankExpressionResult>`	`deleteRankExpressionAsync(DeleteRankExpressionRequest deleteRankExpressionRequest)` Removes a `RankExpression` from the search domain.
`Future<DeleteRankExpressionResult>`	`deleteRankExpressionAsync(DeleteRankExpressionRequest deleteRankExpressionRequest, AsyncHandler<DeleteRankExpressionRequest,DeleteRankExpressionResult> asyncHandler)` Removes a `RankExpression` from the search domain.
`Future<DescribeDefaultSearchFieldResult>`	`describeDefaultSearchFieldAsync(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest)` Gets the default search field configured for the search domain.
`Future<DescribeDefaultSearchFieldResult>`	`describeDefaultSearchFieldAsync(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest, AsyncHandler<DescribeDefaultSearchFieldRequest,DescribeDefaultSearchFieldResult> asyncHandler)` 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<DescribeDomainsResult>`	`describeDomainsAsync(DescribeDomainsRequest describeDomainsRequest, AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler)` 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<DescribeIndexFieldsResult>`	`describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest, AsyncHandler<DescribeIndexFieldsRequest,DescribeIndexFieldsResult> asyncHandler)` 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<DescribeRankExpressionsResult>`	`describeRankExpressionsAsync(DescribeRankExpressionsRequest describeRankExpressionsRequest, AsyncHandler<DescribeRankExpressionsRequest,DescribeRankExpressionsResult> asyncHandler)` 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<DescribeServiceAccessPoliciesResult>`	`describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest, AsyncHandler<DescribeServiceAccessPoliciesRequest,DescribeServiceAccessPoliciesResult> asyncHandler)` 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<DescribeStemmingOptionsResult>`	`describeStemmingOptionsAsync(DescribeStemmingOptionsRequest describeStemmingOptionsRequest, AsyncHandler<DescribeStemmingOptionsRequest,DescribeStemmingOptionsResult> asyncHandler)` Gets the stemming dictionary configured for the search domain.
`Future<DescribeStopwordOptionsResult>`	`describeStopwordOptionsAsync(DescribeStopwordOptionsRequest describeStopwordOptionsRequest)` Gets the stopwords configured for the search domain.
`Future<DescribeStopwordOptionsResult>`	`describeStopwordOptionsAsync(DescribeStopwordOptionsRequest describeStopwordOptionsRequest, AsyncHandler<DescribeStopwordOptionsRequest,DescribeStopwordOptionsResult> asyncHandler)` Gets the stopwords configured for the search domain.
`Future<DescribeSynonymOptionsResult>`	`describeSynonymOptionsAsync(DescribeSynonymOptionsRequest describeSynonymOptionsRequest)` Gets the synonym dictionary configured for the search domain.
`Future<DescribeSynonymOptionsResult>`	`describeSynonymOptionsAsync(DescribeSynonymOptionsRequest describeSynonymOptionsRequest, AsyncHandler<DescribeSynonymOptionsRequest,DescribeSynonymOptionsResult> asyncHandler)` 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` .
`Future<IndexDocumentsResult>`	`indexDocumentsAsync(IndexDocumentsRequest indexDocumentsRequest, AsyncHandler<IndexDocumentsRequest,IndexDocumentsResult> asyncHandler)` 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<UpdateDefaultSearchFieldResult>`	`updateDefaultSearchFieldAsync(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest, AsyncHandler<UpdateDefaultSearchFieldRequest,UpdateDefaultSearchFieldResult> asyncHandler)` 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<UpdateServiceAccessPoliciesResult>`	`updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest, AsyncHandler<UpdateServiceAccessPoliciesRequest,UpdateServiceAccessPoliciesResult> asyncHandler)` 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<UpdateStemmingOptionsResult>`	`updateStemmingOptionsAsync(UpdateStemmingOptionsRequest updateStemmingOptionsRequest, AsyncHandler<UpdateStemmingOptionsRequest,UpdateStemmingOptionsResult> asyncHandler)` Configures a stemming dictionary for the search domain.
`Future<UpdateStopwordOptionsResult>`	`updateStopwordOptionsAsync(UpdateStopwordOptionsRequest updateStopwordOptionsRequest)` Configures stopwords for the search domain.
`Future<UpdateStopwordOptionsResult>`	`updateStopwordOptionsAsync(UpdateStopwordOptionsRequest updateStopwordOptionsRequest, AsyncHandler<UpdateStopwordOptionsRequest,UpdateStopwordOptionsResult> asyncHandler)` Configures stopwords for the search domain.
`Future<UpdateSynonymOptionsResult>`	`updateSynonymOptionsAsync(UpdateSynonymOptionsRequest updateSynonymOptionsRequest)` Configures a synonym dictionary for the search domain.
`Future<UpdateSynonymOptionsResult>`	`updateSynonymOptionsAsync(UpdateSynonymOptionsRequest updateSynonymOptionsRequest, AsyncHandler<UpdateSynonymOptionsRequest,UpdateSynonymOptionsResult> asyncHandler)` Configures a synonym dictionary for the search domain.

Methods inherited from class com.amazonaws.services.cloudsearch.AmazonCloudSearchClient
`createDomain, defineIndexField, defineRankExpression, deleteDomain, deleteIndexField, deleteRankExpression, describeDefaultSearchField, describeDomains, describeDomains, describeIndexFields, describeRankExpressions, describeServiceAccessPolicies, describeStemmingOptions, describeStopwordOptions, describeSynonymOptions, getCachedResponseMetadata, indexDocuments, setEndpoint, updateDefaultSearchField, updateServiceAccessPolicies, updateStemmingOptions, updateStopwordOptions, updateSynonymOptions`

Methods inherited from class com.amazonaws.services.cloudsearch.AmazonCloudSearchClient

createDomain, defineIndexField, defineRankExpression, deleteDomain, deleteIndexField, deleteRankExpression, describeDefaultSearchField, describeDomains, describeDomains, describeIndexFields, describeRankExpressions, describeServiceAccessPolicies, describeStemmingOptions, describeStopwordOptions, describeSynonymOptions, getCachedResponseMetadata, indexDocuments, setEndpoint, updateDefaultSearchField, updateServiceAccessPolicies, updateStemmingOptions, updateStopwordOptions, updateSynonymOptions

Methods inherited from class com.amazonaws.AmazonWebServiceClient
`addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, withTimeOffset`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.amazonaws.services.cloudsearch.AmazonCloudSearch
createDomain, defineIndexField, defineRankExpression, deleteDomain, deleteIndexField, deleteRankExpression, describeDefaultSearchField, describeDomains, describeDomains, describeIndexFields, describeRankExpressions, describeServiceAccessPolicies, describeStemmingOptions, describeStopwordOptions, describeSynonymOptions, getCachedResponseMetadata, indexDocuments, setEndpoint, setRegion, updateDefaultSearchField, updateServiceAccessPolicies, updateStemmingOptions, updateStopwordOptions, updateSynonymOptions

Methods inherited from interface com.amazonaws.services.cloudsearch.AmazonCloudSearch

createDomain, defineIndexField, defineRankExpression, deleteDomain, deleteIndexField, deleteRankExpression, describeDefaultSearchField, describeDomains, describeDomains, describeIndexFields, describeRankExpressions, describeServiceAccessPolicies, describeStemmingOptions, describeStopwordOptions, describeSynonymOptions, getCachedResponseMetadata, indexDocuments, setEndpoint, setRegion, updateDefaultSearchField, updateServiceAccessPolicies, updateStemmingOptions, updateStopwordOptions, updateSynonymOptions

Constructor Detail

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch. 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:: DefaultAWSCredentialsProvider

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonCloudSearch. 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 AmazonCloudSearch (ex: proxy settings, retry counts, etc.).
See Also:: DefaultAWSCredentialsProvider

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials)

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