com.amazonaws.services.cloudsearchv2

Class AmazonCloudSearchAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudsearchv2.AmazonCloudSearchClient

com.amazonaws.services.cloudsearchv2.AmazonCloudSearchAsyncClient

All Implemented Interfaces:

AmazonCloudSearch, AmazonCloudSearchAsync

@ThreadSafe
public class AmazonCloudSearchAsyncClient
extends AmazonCloudSearchClient
implements AmazonCloudSearchAsync

Interface for accessing Amazon CloudSearch asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon CloudSearch Configuration Service

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

Constructor and Description
AmazonCloudSearchAsyncClient() Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch.
AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials.
AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch 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 Amazon CloudSearch using the specified AWS account credentials and executor service.
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials provider.
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the provided 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 Amazon CloudSearch 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 Amazon CloudSearch using the specified AWS account credentials provider and executor service.
AmazonCloudSearchAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch.

Method Summary

Methods

Modifier and Type	Method and Description
Future<BuildSuggestersResult>	buildSuggestersAsync(BuildSuggestersRequest request) Indexes the search suggestions.
Future<BuildSuggestersResult>	buildSuggestersAsync(BuildSuggestersRequest request, AsyncHandler<BuildSuggestersRequest,BuildSuggestersResult> asyncHandler) Indexes the search suggestions.
Future<CreateDomainResult>	createDomainAsync(CreateDomainRequest request) Creates a new search domain.
Future<CreateDomainResult>	createDomainAsync(CreateDomainRequest request, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler) Creates a new search domain.
Future<DefineAnalysisSchemeResult>	defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest request) Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options.
Future<DefineAnalysisSchemeResult>	defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest request, AsyncHandler<DefineAnalysisSchemeRequest,DefineAnalysisSchemeResult> asyncHandler) Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options.
Future<DefineExpressionResult>	defineExpressionAsync(DefineExpressionRequest request) Configures an Expression for the search domain.
Future<DefineExpressionResult>	defineExpressionAsync(DefineExpressionRequest request, AsyncHandler<DefineExpressionRequest,DefineExpressionResult> asyncHandler) Configures an Expression for the search domain.
Future<DefineIndexFieldResult>	defineIndexFieldAsync(DefineIndexFieldRequest request) Configures an IndexField for the search domain.
Future<DefineIndexFieldResult>	defineIndexFieldAsync(DefineIndexFieldRequest request, AsyncHandler<DefineIndexFieldRequest,DefineIndexFieldResult> asyncHandler) Configures an IndexField for the search domain.
Future<DefineSuggesterResult>	defineSuggesterAsync(DefineSuggesterRequest request) Configures a suggester for a domain.
Future<DefineSuggesterResult>	defineSuggesterAsync(DefineSuggesterRequest request, AsyncHandler<DefineSuggesterRequest,DefineSuggesterResult> asyncHandler) Configures a suggester for a domain.
Future<DeleteAnalysisSchemeResult>	deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest request) Deletes an analysis scheme.
Future<DeleteAnalysisSchemeResult>	deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest request, AsyncHandler<DeleteAnalysisSchemeRequest,DeleteAnalysisSchemeResult> asyncHandler) Deletes an analysis scheme.
Future<DeleteDomainResult>	deleteDomainAsync(DeleteDomainRequest request) Permanently deletes a search domain and all of its data.
Future<DeleteDomainResult>	deleteDomainAsync(DeleteDomainRequest request, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler) Permanently deletes a search domain and all of its data.
Future<DeleteExpressionResult>	deleteExpressionAsync(DeleteExpressionRequest request) Removes an Expression from the search domain.
Future<DeleteExpressionResult>	deleteExpressionAsync(DeleteExpressionRequest request, AsyncHandler<DeleteExpressionRequest,DeleteExpressionResult> asyncHandler) Removes an Expression from the search domain.
Future<DeleteIndexFieldResult>	deleteIndexFieldAsync(DeleteIndexFieldRequest request) Removes an IndexField from the search domain.
Future<DeleteIndexFieldResult>	deleteIndexFieldAsync(DeleteIndexFieldRequest request, AsyncHandler<DeleteIndexFieldRequest,DeleteIndexFieldResult> asyncHandler) Removes an IndexField from the search domain.
Future<DeleteSuggesterResult>	deleteSuggesterAsync(DeleteSuggesterRequest request) Deletes a suggester.
Future<DeleteSuggesterResult>	deleteSuggesterAsync(DeleteSuggesterRequest request, AsyncHandler<DeleteSuggesterRequest,DeleteSuggesterResult> asyncHandler) Deletes a suggester.
Future<DescribeAnalysisSchemesResult>	describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest request) Gets the analysis schemes configured for a domain.
Future<DescribeAnalysisSchemesResult>	describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest request, AsyncHandler<DescribeAnalysisSchemesRequest,DescribeAnalysisSchemesResult> asyncHandler) Gets the analysis schemes configured for a domain.
Future<DescribeAvailabilityOptionsResult>	describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest request) Gets the availability options configured for a domain.
Future<DescribeAvailabilityOptionsResult>	describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest request, AsyncHandler<DescribeAvailabilityOptionsRequest,DescribeAvailabilityOptionsResult> asyncHandler) Gets the availability options configured for a domain.
Future<DescribeDomainsResult>	describeDomainsAsync() Simplified method form for invoking the DescribeDomains operation.
Future<DescribeDomainsResult>	describeDomainsAsync(AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler) Simplified method form for invoking the DescribeDomains operation with an AsyncHandler.
Future<DescribeDomainsResult>	describeDomainsAsync(DescribeDomainsRequest request) Gets information about the search domains owned by this account.
Future<DescribeDomainsResult>	describeDomainsAsync(DescribeDomainsRequest request, AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler) Gets information about the search domains owned by this account.
Future<DescribeExpressionsResult>	describeExpressionsAsync(DescribeExpressionsRequest request) Gets the expressions configured for the search domain.
Future<DescribeExpressionsResult>	describeExpressionsAsync(DescribeExpressionsRequest request, AsyncHandler<DescribeExpressionsRequest,DescribeExpressionsResult> asyncHandler) Gets the expressions configured for the search domain.
Future<DescribeIndexFieldsResult>	describeIndexFieldsAsync(DescribeIndexFieldsRequest request) Gets information about the index fields configured for the search domain.
Future<DescribeIndexFieldsResult>	describeIndexFieldsAsync(DescribeIndexFieldsRequest request, AsyncHandler<DescribeIndexFieldsRequest,DescribeIndexFieldsResult> asyncHandler) Gets information about the index fields configured for the search domain.
Future<DescribeScalingParametersResult>	describeScalingParametersAsync(DescribeScalingParametersRequest request) Gets the scaling parameters configured for a domain.
Future<DescribeScalingParametersResult>	describeScalingParametersAsync(DescribeScalingParametersRequest request, AsyncHandler<DescribeScalingParametersRequest,DescribeScalingParametersResult> asyncHandler) Gets the scaling parameters configured for a domain.
Future<DescribeServiceAccessPoliciesResult>	describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest request) Gets information about the access policies that control access to the domain's document and search endpoints.
Future<DescribeServiceAccessPoliciesResult>	describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest request, AsyncHandler<DescribeServiceAccessPoliciesRequest,DescribeServiceAccessPoliciesResult> asyncHandler) Gets information about the access policies that control access to the domain's document and search endpoints.
Future<DescribeSuggestersResult>	describeSuggestersAsync(DescribeSuggestersRequest request) Gets the suggesters configured for a domain.
Future<DescribeSuggestersResult>	describeSuggestersAsync(DescribeSuggestersRequest request, AsyncHandler<DescribeSuggestersRequest,DescribeSuggestersResult> asyncHandler) Gets the suggesters configured for a domain.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<IndexDocumentsResult>	indexDocumentsAsync(IndexDocumentsRequest request) Tells the search domain to start indexing its documents using the latest indexing options.
Future<IndexDocumentsResult>	indexDocumentsAsync(IndexDocumentsRequest request, AsyncHandler<IndexDocumentsRequest,IndexDocumentsResult> asyncHandler) Tells the search domain to start indexing its documents using the latest indexing options.
Future<ListDomainNamesResult>	listDomainNamesAsync() Simplified method form for invoking the ListDomainNames operation.
Future<ListDomainNamesResult>	listDomainNamesAsync(AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler) Simplified method form for invoking the ListDomainNames operation with an AsyncHandler.
Future<ListDomainNamesResult>	listDomainNamesAsync(ListDomainNamesRequest request) Lists all search domains owned by an account.
Future<ListDomainNamesResult>	listDomainNamesAsync(ListDomainNamesRequest request, AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler) Lists all search domains owned by an account.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<UpdateAvailabilityOptionsResult>	updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest request) Configures the availability options for a domain.
Future<UpdateAvailabilityOptionsResult>	updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest request, AsyncHandler<UpdateAvailabilityOptionsRequest,UpdateAvailabilityOptionsResult> asyncHandler) Configures the availability options for a domain.
Future<UpdateScalingParametersResult>	updateScalingParametersAsync(UpdateScalingParametersRequest request) Configures scaling parameters for a domain.
Future<UpdateScalingParametersResult>	updateScalingParametersAsync(UpdateScalingParametersRequest request, AsyncHandler<UpdateScalingParametersRequest,UpdateScalingParametersResult> asyncHandler) Configures scaling parameters for a domain.
Future<UpdateServiceAccessPoliciesResult>	updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest request) Configures the access rules that control access to the domain's document and search endpoints.
Future<UpdateServiceAccessPoliciesResult>	updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest request, AsyncHandler<UpdateServiceAccessPoliciesRequest,UpdateServiceAccessPoliciesResult> asyncHandler) Configures the access rules that control access to the domain's document and search endpoints.

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

buildSuggesters, createDomain, defineAnalysisScheme, defineExpression, defineIndexField, defineSuggester, deleteAnalysisScheme, deleteDomain, deleteExpression, deleteIndexField, deleteSuggester, describeAnalysisSchemes, describeAvailabilityOptions, describeDomains, describeDomains, describeExpressions, describeIndexFields, describeScalingParameters, describeServiceAccessPolicies, describeSuggesters, getCachedResponseMetadata, indexDocuments, listDomainNames, listDomainNames, updateAvailabilityOptions, updateScalingParameters, updateServiceAccessPolicies

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

buildSuggesters, createDomain, defineAnalysisScheme, defineExpression, defineIndexField, defineSuggester, deleteAnalysisScheme, deleteDomain, deleteExpression, deleteIndexField, deleteSuggester, describeAnalysisSchemes, describeAvailabilityOptions, describeDomains, describeDomains, describeExpressions, describeIndexFields, describeScalingParameters, describeServiceAccessPolicies, describeSuggesters, getCachedResponseMetadata, indexDocuments, listDomainNames, listDomainNames, setEndpoint, setRegion, updateAvailabilityOptions, updateScalingParameters, updateServiceAccessPolicies

Constructor Detail

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient()

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch. 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
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

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).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch. 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
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

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().

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudSearch (ex: proxy settings, retry counts, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials.

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).

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

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.

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials, executor service, and client configuration options.

Parameters:

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.

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials provider. Default client settings will be used.

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).

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the provided AWS account credentials provider and client configuration options.

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().

Parameters:

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).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

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.

AmazonCloudSearchAsyncClient

public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials provider, executor service, and client configuration options.

Parameters:

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

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

buildSuggestersAsync

public Future<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest request)

Description copied from interface: AmazonCloudSearchAsync

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

Specified by:

buildSuggestersAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

Returns:

A Java Future containing the result of the BuildSuggesters operation returned by the service.

buildSuggestersAsync

public Future<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest request,
                                                 AsyncHandler<BuildSuggestersRequest,BuildSuggestersResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

Specified by:

buildSuggestersAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

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.

Returns:

A Java Future containing the result of the BuildSuggesters operation returned by the service.

createDomainAsync

public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request)

Description copied from interface: AmazonCloudSearchAsync

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

createDomainAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

Returns:

A Java Future containing the result of the CreateDomain operation returned by the service.

createDomainAsync

public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request,
                                           AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

createDomainAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

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.

Returns:

A Java Future containing the result of the CreateDomain operation returned by the service.

defineAnalysisSchemeAsync

public Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest request)

Description copied from interface: AmazonCloudSearchAsync

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Specified by:

defineAnalysisSchemeAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

Returns:

A Java Future containing the result of the DefineAnalysisScheme operation returned by the service.

defineAnalysisSchemeAsync

public Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest request,
                                                           AsyncHandler<DefineAnalysisSchemeRequest,DefineAnalysisSchemeResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Specified by:

defineAnalysisSchemeAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

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.

Returns:

A Java Future containing the result of the DefineAnalysisScheme operation returned by the service.

defineExpressionAsync

public Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest request)

Description copied from interface: AmazonCloudSearchAsync

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Specified by:

defineExpressionAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

Returns:

A Java Future containing the result of the DefineExpression operation returned by the service.

defineExpressionAsync

public Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest request,
                                                   AsyncHandler<DefineExpressionRequest,DefineExpressionResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Specified by:

defineExpressionAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

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.

Returns:

A Java Future containing the result of the DefineExpression operation returned by the service.

defineIndexFieldAsync

public Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest request)

Description copied from interface: AmazonCloudSearchAsync

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Specified by:

defineIndexFieldAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

Returns:

A Java Future containing the result of the DefineIndexField operation returned by the service.

defineIndexFieldAsync

public Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest request,
                                                   AsyncHandler<DefineIndexFieldRequest,DefineIndexFieldResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Specified by:

defineIndexFieldAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

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.

Returns:

A Java Future containing the result of the DefineIndexField operation returned by the service.

defineSuggesterAsync

public Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest request)

Description copied from interface: AmazonCloudSearchAsync

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Specified by:

defineSuggesterAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

Returns:

A Java Future containing the result of the DefineSuggester operation returned by the service.

defineSuggesterAsync

public Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest request,
                                                 AsyncHandler<DefineSuggesterRequest,DefineSuggesterResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Specified by:

defineSuggesterAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

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.

Returns:

A Java Future containing the result of the DefineSuggester operation returned by the service.

deleteAnalysisSchemeAsync

public Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest request)

Description copied from interface: AmazonCloudSearchAsync

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Specified by:

deleteAnalysisSchemeAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

Returns:

A Java Future containing the result of the DeleteAnalysisScheme operation returned by the service.

deleteAnalysisSchemeAsync

public Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest request,
                                                           AsyncHandler<DeleteAnalysisSchemeRequest,DeleteAnalysisSchemeResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Specified by:

deleteAnalysisSchemeAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

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.

Returns:

A Java Future containing the result of the DeleteAnalysisScheme operation returned by the service.

deleteDomainAsync

public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request)

Description copied from interface: AmazonCloudSearchAsync

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

deleteDomainAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

Returns:

A Java Future containing the result of the DeleteDomain operation returned by the service.

deleteDomainAsync

public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request,
                                           AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

deleteDomainAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

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.

Returns:

A Java Future containing the result of the DeleteDomain operation returned by the service.

deleteExpressionAsync

public Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest request)

Description copied from interface: AmazonCloudSearchAsync

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Specified by:

deleteExpressionAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

Returns:

A Java Future containing the result of the DeleteExpression operation returned by the service.

deleteExpressionAsync

public Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest request,
                                                   AsyncHandler<DeleteExpressionRequest,DeleteExpressionResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Specified by:

deleteExpressionAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

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.

Returns:

A Java Future containing the result of the DeleteExpression operation returned by the service.

deleteIndexFieldAsync

public Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest request)

Description copied from interface: AmazonCloudSearchAsync

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Specified by:

deleteIndexFieldAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

Returns:

A Java Future containing the result of the DeleteIndexField operation returned by the service.

deleteIndexFieldAsync

public Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest request,
                                                   AsyncHandler<DeleteIndexFieldRequest,DeleteIndexFieldResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Specified by:

deleteIndexFieldAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

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.

Returns:

A Java Future containing the result of the DeleteIndexField operation returned by the service.

deleteSuggesterAsync

public Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest request)

Description copied from interface: AmazonCloudSearchAsync

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Specified by:

deleteSuggesterAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

Returns:

A Java Future containing the result of the DeleteSuggester operation returned by the service.

deleteSuggesterAsync

public Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest request,
                                                 AsyncHandler<DeleteSuggesterRequest,DeleteSuggesterResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Specified by:

deleteSuggesterAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

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.

Returns:

A Java Future containing the result of the DeleteSuggester operation returned by the service.

describeAnalysisSchemesAsync

public Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest request)

Description copied from interface: AmazonCloudSearchAsync

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Specified by:

describeAnalysisSchemesAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Returns:

A Java Future containing the result of the DescribeAnalysisSchemes operation returned by the service.

describeAnalysisSchemesAsync

public Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest request,
                                                                 AsyncHandler<DescribeAnalysisSchemesRequest,DescribeAnalysisSchemesResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Specified by:

describeAnalysisSchemesAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

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.

Returns:

A Java Future containing the result of the DescribeAnalysisSchemes operation returned by the service.

describeAvailabilityOptionsAsync

public Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest request)

Description copied from interface: AmazonCloudSearchAsync

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Specified by:

describeAvailabilityOptionsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Returns:

A Java Future containing the result of the DescribeAvailabilityOptions operation returned by the service.

describeAvailabilityOptionsAsync

public Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest request,
                                                                         AsyncHandler<DescribeAvailabilityOptionsRequest,DescribeAvailabilityOptionsResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Specified by:

describeAvailabilityOptionsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

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.

Returns:

A Java Future containing the result of the DescribeAvailabilityOptions operation returned by the service.

describeDomainsAsync

public Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest request)

Description copied from interface: AmazonCloudSearchAsync

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

describeDomainsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

Returns:

A Java Future containing the result of the DescribeDomains operation returned by the service.

describeDomainsAsync

public Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest request,
                                                 AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

describeDomainsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

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.

Returns:

A Java Future containing the result of the DescribeDomains operation returned by the service.

describeDomainsAsync

public Future<DescribeDomainsResult> describeDomainsAsync()

Simplified method form for invoking the DescribeDomains operation.

Specified by:

describeDomainsAsync in interface AmazonCloudSearchAsync

See Also:

describeDomainsAsync(DescribeDomainsRequest)

describeDomainsAsync

public Future<DescribeDomainsResult> describeDomainsAsync(AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler)

Simplified method form for invoking the DescribeDomains operation with an AsyncHandler.

Specified by:

describeDomainsAsync in interface AmazonCloudSearchAsync

See Also:

describeDomainsAsync(DescribeDomainsRequest, com.amazonaws.handlers.AsyncHandler)

describeExpressionsAsync

public Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest request)

Description copied from interface: AmazonCloudSearchAsync

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Specified by:

describeExpressionsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Returns:

A Java Future containing the result of the DescribeExpressions operation returned by the service.

describeExpressionsAsync

public Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest request,
                                                         AsyncHandler<DescribeExpressionsRequest,DescribeExpressionsResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Specified by:

describeExpressionsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

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.

Returns:

A Java Future containing the result of the DescribeExpressions operation returned by the service.

describeIndexFieldsAsync

public Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest request)

Description copied from interface: AmazonCloudSearchAsync

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

Specified by:

describeIndexFieldsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Returns:

A Java Future containing the result of the DescribeIndexFields operation returned by the service.

describeIndexFieldsAsync

public Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest request,
                                                         AsyncHandler<DescribeIndexFieldsRequest,DescribeIndexFieldsResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

Specified by:

describeIndexFieldsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

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.

Returns:

A Java Future containing the result of the DescribeIndexFields operation returned by the service.

describeScalingParametersAsync

public Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest request)

Description copied from interface: AmazonCloudSearchAsync

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Specified by:

describeScalingParametersAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

Returns:

A Java Future containing the result of the DescribeScalingParameters operation returned by the service.

describeScalingParametersAsync

public Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest request,
                                                                     AsyncHandler<DescribeScalingParametersRequest,DescribeScalingParametersResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Specified by:

describeScalingParametersAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

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.

Returns:

A Java Future containing the result of the DescribeScalingParameters operation returned by the service.

describeServiceAccessPoliciesAsync

public Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest request)

Description copied from interface: AmazonCloudSearchAsync

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

describeServiceAccessPoliciesAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Returns:

A Java Future containing the result of the DescribeServiceAccessPolicies operation returned by the service.

describeServiceAccessPoliciesAsync

public Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest request,
                                                                             AsyncHandler<DescribeServiceAccessPoliciesRequest,DescribeServiceAccessPoliciesResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

describeServiceAccessPoliciesAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

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.

Returns:

A Java Future containing the result of the DescribeServiceAccessPolicies operation returned by the service.

describeSuggestersAsync

public Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest request)

Description copied from interface: AmazonCloudSearchAsync

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Specified by:

describeSuggestersAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Returns:

A Java Future containing the result of the DescribeSuggesters operation returned by the service.

describeSuggestersAsync

public Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest request,
                                                       AsyncHandler<DescribeSuggestersRequest,DescribeSuggestersResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Specified by:

describeSuggestersAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

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.

Returns:

A Java Future containing the result of the DescribeSuggesters operation returned by the service.

indexDocumentsAsync

public Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest request)

Description copied from interface: AmazonCloudSearchAsync

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

Specified by:

indexDocumentsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

Returns:

A Java Future containing the result of the IndexDocuments operation returned by the service.

indexDocumentsAsync

public Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest request,
                                               AsyncHandler<IndexDocumentsRequest,IndexDocumentsResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

Specified by:

indexDocumentsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

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.

Returns:

A Java Future containing the result of the IndexDocuments operation returned by the service.

listDomainNamesAsync

public Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest request)

Description copied from interface: AmazonCloudSearchAsync

Lists all search domains owned by an account.

Specified by:

listDomainNamesAsync in interface AmazonCloudSearchAsync

Returns:

A Java Future containing the result of the ListDomainNames operation returned by the service.

listDomainNamesAsync

public Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest request,
                                                 AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Lists all search domains owned by an account.

Specified by:

listDomainNamesAsync in interface AmazonCloudSearchAsync

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.

Returns:

A Java Future containing the result of the ListDomainNames operation returned by the service.

listDomainNamesAsync

public Future<ListDomainNamesResult> listDomainNamesAsync()

Simplified method form for invoking the ListDomainNames operation.

Specified by:

listDomainNamesAsync in interface AmazonCloudSearchAsync

See Also:

listDomainNamesAsync(ListDomainNamesRequest)

listDomainNamesAsync

public Future<ListDomainNamesResult> listDomainNamesAsync(AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler)

Simplified method form for invoking the ListDomainNames operation with an AsyncHandler.

Specified by:

listDomainNamesAsync in interface AmazonCloudSearchAsync

See Also:

listDomainNamesAsync(ListDomainNamesRequest, com.amazonaws.handlers.AsyncHandler)

updateAvailabilityOptionsAsync

public Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest request)

Description copied from interface: AmazonCloudSearchAsync

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Specified by:

updateAvailabilityOptionsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

Returns:

A Java Future containing the result of the UpdateAvailabilityOptions operation returned by the service.

updateAvailabilityOptionsAsync

public Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest request,
                                                                     AsyncHandler<UpdateAvailabilityOptionsRequest,UpdateAvailabilityOptionsResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Specified by:

updateAvailabilityOptionsAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

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.

Returns:

A Java Future containing the result of the UpdateAvailabilityOptions operation returned by the service.

updateScalingParametersAsync

public Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest request)

Description copied from interface: AmazonCloudSearchAsync

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Specified by:

updateScalingParametersAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

Returns:

A Java Future containing the result of the UpdateScalingParameters operation returned by the service.

updateScalingParametersAsync

public Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest request,
                                                                 AsyncHandler<UpdateScalingParametersRequest,UpdateScalingParametersResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Specified by:

updateScalingParametersAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

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.

Returns:

A Java Future containing the result of the UpdateScalingParameters operation returned by the service.

updateServiceAccessPoliciesAsync

public Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest request)

Description copied from interface: AmazonCloudSearchAsync

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

Specified by:

updateServiceAccessPoliciesAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

Returns:

A Java Future containing the result of the UpdateServiceAccessPolicies operation returned by the service.

updateServiceAccessPoliciesAsync

public Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest request,
                                                                         AsyncHandler<UpdateServiceAccessPoliciesRequest,UpdateServiceAccessPoliciesResult> asyncHandler)

Description copied from interface: AmazonCloudSearchAsync

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

Specified by:

updateServiceAccessPoliciesAsync in interface AmazonCloudSearchAsync

Parameters:

request - Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

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.

Returns:

A Java Future containing the result of the UpdateServiceAccessPolicies operation returned by the service.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonCloudSearch

Overrides:

shutdown in class AmazonWebServiceClient