@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCloudSearchAsyncClient extends AmazonCloudSearchClient implements AmazonCloudSearchAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonCloudSearchAsyncClient()
Deprecated.
|
AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonCloudSearchAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
builder, buildSuggesters, createDomain, defineAnalysisScheme, defineExpression, defineIndexField, defineSuggester, deleteAnalysisScheme, deleteDomain, deleteExpression, deleteIndexField, deleteSuggester, describeAnalysisSchemes, describeAvailabilityOptions, describeDomainEndpointOptions, describeDomains, describeDomains, describeExpressions, describeIndexFields, describeScalingParameters, describeServiceAccessPolicies, describeSuggesters, getCachedResponseMetadata, indexDocuments, listDomainNames, listDomainNames, updateAvailabilityOptions, updateDomainEndpointOptions, updateScalingParameters, updateServiceAccessPolicies
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
buildSuggesters, createDomain, defineAnalysisScheme, defineExpression, defineIndexField, defineSuggester, deleteAnalysisScheme, deleteDomain, deleteExpression, deleteIndexField, deleteSuggester, describeAnalysisSchemes, describeAvailabilityOptions, describeDomainEndpointOptions, describeDomains, describeDomains, describeExpressions, describeIndexFields, describeScalingParameters, describeServiceAccessPolicies, describeSuggesters, getCachedResponseMetadata, indexDocuments, listDomainNames, listDomainNames, setEndpoint, setRegion, updateAvailabilityOptions, updateDomainEndpointOptions, updateScalingParameters, updateServiceAccessPolicies
@Deprecated public AmazonCloudSearchAsyncClient()
AmazonCloudSearchAsyncClientBuilder.defaultClient()
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).
@Deprecated public AmazonCloudSearchAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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()
.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon CloudSearch (ex: proxy
settings, retry counts, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
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).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
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.@Deprecated public AmazonCloudSearchAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
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.@Deprecated public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
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).
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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()
.
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).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
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.@Deprecated public AmazonCloudSearchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
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.public static AmazonCloudSearchAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest request)
AmazonCloudSearchAsync
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
buildSuggestersAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the BuildSuggester
operation. Specifies the name of
the domain you want to update.public Future<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest request, AsyncHandler<BuildSuggestersRequest,BuildSuggestersResult> asyncHandler)
AmazonCloudSearchAsync
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
buildSuggestersAsync
in interface AmazonCloudSearchAsync
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.public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request)
AmazonCloudSearchAsync
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
createDomainAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the CreateDomain
operation. Specifies a name for the
new search domain.public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
AmazonCloudSearchAsync
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
createDomainAsync
in interface AmazonCloudSearchAsync
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.public Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest request)
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.
defineAnalysisSchemeAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the DefineAnalysisScheme
operation. Specifies the name
of the domain you want to update and the analysis scheme configuration.public Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest request, AsyncHandler<DefineAnalysisSchemeRequest,DefineAnalysisSchemeResult> asyncHandler)
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.
defineAnalysisSchemeAsync
in interface AmazonCloudSearchAsync
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.public Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest request)
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.
defineExpressionAsync
in interface AmazonCloudSearchAsync
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.public Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest request, AsyncHandler<DefineExpressionRequest,DefineExpressionResult> asyncHandler)
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.
defineExpressionAsync
in interface AmazonCloudSearchAsync
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.public Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest request)
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.
defineIndexFieldAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the DefineIndexField
operation. Specifies the name of
the domain you want to update and the index field configuration.public Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest request, AsyncHandler<DefineIndexFieldRequest,DefineIndexFieldResult> asyncHandler)
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.
defineIndexFieldAsync
in interface AmazonCloudSearchAsync
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.public Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest request)
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.
defineSuggesterAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the DefineSuggester
operation. Specifies the name of
the domain you want to update and the suggester configuration.public Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest request, AsyncHandler<DefineSuggesterRequest,DefineSuggesterResult> asyncHandler)
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.
defineSuggesterAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest request)
AmazonCloudSearchAsync
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
deleteAnalysisSchemeAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest request, AsyncHandler<DeleteAnalysisSchemeRequest,DeleteAnalysisSchemeResult> asyncHandler)
AmazonCloudSearchAsync
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
deleteAnalysisSchemeAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request)
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.
deleteDomainAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the DeleteDomain
operation. Specifies the name of the
domain you want to delete.public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
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.
deleteDomainAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest request)
AmazonCloudSearchAsync
Removes an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
deleteExpressionAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest request, AsyncHandler<DeleteExpressionRequest,DeleteExpressionResult> asyncHandler)
AmazonCloudSearchAsync
Removes an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
deleteExpressionAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest request)
AmazonCloudSearchAsync
Removes an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
deleteIndexFieldAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest request, AsyncHandler<DeleteIndexFieldRequest,DeleteIndexFieldResult> asyncHandler)
AmazonCloudSearchAsync
Removes an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
deleteIndexFieldAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest request)
AmazonCloudSearchAsync
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
deleteSuggesterAsync
in interface AmazonCloudSearchAsync
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.public Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest request, AsyncHandler<DeleteSuggesterRequest,DeleteSuggesterResult> asyncHandler)
AmazonCloudSearchAsync
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
deleteSuggesterAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest request)
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.
describeAnalysisSchemesAsync
in interface AmazonCloudSearchAsync
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
.public Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest request, AsyncHandler<DescribeAnalysisSchemesRequest,DescribeAnalysisSchemesResult> asyncHandler)
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.
describeAnalysisSchemesAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest request)
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.
describeAvailabilityOptionsAsync
in interface AmazonCloudSearchAsync
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
.public Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest request, AsyncHandler<DescribeAvailabilityOptionsRequest,DescribeAvailabilityOptionsResult> asyncHandler)
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.
describeAvailabilityOptionsAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeDomainEndpointOptionsResult> describeDomainEndpointOptionsAsync(DescribeDomainEndpointOptionsRequest request)
AmazonCloudSearchAsync
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
describeDomainEndpointOptionsAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the DescribeDomainEndpointOptions
operation. Specify
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
.public Future<DescribeDomainEndpointOptionsResult> describeDomainEndpointOptionsAsync(DescribeDomainEndpointOptionsRequest request, AsyncHandler<DescribeDomainEndpointOptionsRequest,DescribeDomainEndpointOptionsResult> asyncHandler)
AmazonCloudSearchAsync
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
describeDomainEndpointOptionsAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the DescribeDomainEndpointOptions
operation. Specify
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.public Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest request)
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.
describeDomainsAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest request, AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler)
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.
describeDomainsAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeDomainsResult> describeDomainsAsync()
describeDomainsAsync
in interface AmazonCloudSearchAsync
describeDomainsAsync(DescribeDomainsRequest)
public Future<DescribeDomainsResult> describeDomainsAsync(AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler)
describeDomainsAsync
in interface AmazonCloudSearchAsync
describeDomainsAsync(DescribeDomainsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest request)
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.
describeExpressionsAsync
in interface AmazonCloudSearchAsync
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
.public Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest request, AsyncHandler<DescribeExpressionsRequest,DescribeExpressionsResult> asyncHandler)
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.
describeExpressionsAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest request)
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.
describeIndexFieldsAsync
in interface AmazonCloudSearchAsync
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
.public Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest request, AsyncHandler<DescribeIndexFieldsRequest,DescribeIndexFieldsResult> asyncHandler)
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.
describeIndexFieldsAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest request)
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.
describeScalingParametersAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the DescribeScalingParameters
operation. Specifies the
name of the domain you want to describe.public Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest request, AsyncHandler<DescribeScalingParametersRequest,DescribeScalingParametersResult> asyncHandler)
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.
describeScalingParametersAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest request)
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.
describeServiceAccessPoliciesAsync
in interface AmazonCloudSearchAsync
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
.public Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest request, AsyncHandler<DescribeServiceAccessPoliciesRequest,DescribeServiceAccessPoliciesResult> asyncHandler)
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.
describeServiceAccessPoliciesAsync
in interface AmazonCloudSearchAsync
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.public Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest request)
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.
describeSuggestersAsync
in interface AmazonCloudSearchAsync
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
.public Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest request, AsyncHandler<DescribeSuggestersRequest,DescribeSuggestersResult> asyncHandler)
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.
describeSuggestersAsync
in interface AmazonCloudSearchAsync
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.public Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest request)
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
.
indexDocumentsAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the IndexDocuments
operation. Specifies the name of
the domain you want to re-index.public Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest request, AsyncHandler<IndexDocumentsRequest,IndexDocumentsResult> asyncHandler)
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
.
indexDocumentsAsync
in interface AmazonCloudSearchAsync
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.public Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest request)
AmazonCloudSearchAsync
Lists all search domains owned by an account.
listDomainNamesAsync
in interface AmazonCloudSearchAsync
public Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest request, AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler)
AmazonCloudSearchAsync
Lists all search domains owned by an account.
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.public Future<ListDomainNamesResult> listDomainNamesAsync()
listDomainNamesAsync
in interface AmazonCloudSearchAsync
listDomainNamesAsync(ListDomainNamesRequest)
public Future<ListDomainNamesResult> listDomainNamesAsync(AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler)
listDomainNamesAsync
in interface AmazonCloudSearchAsync
listDomainNamesAsync(ListDomainNamesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest request)
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.
updateAvailabilityOptionsAsync
in interface AmazonCloudSearchAsync
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.public Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest request, AsyncHandler<UpdateAvailabilityOptionsRequest,UpdateAvailabilityOptionsResult> asyncHandler)
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.
updateAvailabilityOptionsAsync
in interface AmazonCloudSearchAsync
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.public Future<UpdateDomainEndpointOptionsResult> updateDomainEndpointOptionsAsync(UpdateDomainEndpointOptionsRequest request)
AmazonCloudSearchAsync
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
updateDomainEndpointOptionsAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the UpdateDomainEndpointOptions
operation. Specifies
the name of the domain you want to update and the domain endpoint options.public Future<UpdateDomainEndpointOptionsResult> updateDomainEndpointOptionsAsync(UpdateDomainEndpointOptionsRequest request, AsyncHandler<UpdateDomainEndpointOptionsRequest,UpdateDomainEndpointOptionsResult> asyncHandler)
AmazonCloudSearchAsync
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
updateDomainEndpointOptionsAsync
in interface AmazonCloudSearchAsync
request
- Container for the parameters to the UpdateDomainEndpointOptions
operation. Specifies
the name of the domain you want to update and the domain endpoint options.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest request)
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.
updateScalingParametersAsync
in interface AmazonCloudSearchAsync
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.public Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest request, AsyncHandler<UpdateScalingParametersRequest,UpdateScalingParametersResult> asyncHandler)
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.
updateScalingParametersAsync
in interface AmazonCloudSearchAsync
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.public Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest request)
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.
updateServiceAccessPoliciesAsync
in interface AmazonCloudSearchAsync
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.public Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest request, AsyncHandler<UpdateServiceAccessPoliciesRequest,UpdateServiceAccessPoliciesResult> asyncHandler)
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.
updateServiceAccessPoliciesAsync
in interface AmazonCloudSearchAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonCloudSearch
shutdown
in class AmazonCloudSearchClient