Interface AmazonCloudSearchAsync
- All Superinterfaces:
AmazonCloudSearch
- All Known Implementing Classes:
AbstractAmazonCloudSearchAsync
,AmazonCloudSearchAsyncClient
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.
-
Method Summary
Modifier and TypeMethodDescriptionbuildSuggestersAsync
(BuildSuggestersRequest buildSuggestersRequest) Indexes the search suggestions.buildSuggestersAsync
(BuildSuggestersRequest buildSuggestersRequest, AsyncHandler<BuildSuggestersRequest, BuildSuggestersResult> asyncHandler) Indexes the search suggestions.createDomainAsync
(CreateDomainRequest createDomainRequest) Creates a new search domain.createDomainAsync
(CreateDomainRequest createDomainRequest, AsyncHandler<CreateDomainRequest, CreateDomainResult> asyncHandler) Creates a new search domain.defineAnalysisSchemeAsync
(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) Configures an analysis scheme that can be applied to atext
ortext-array
field to define language-specific text processing options.defineAnalysisSchemeAsync
(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest, AsyncHandler<DefineAnalysisSchemeRequest, DefineAnalysisSchemeResult> asyncHandler) Configures an analysis scheme that can be applied to atext
ortext-array
field to define language-specific text processing options.defineExpressionAsync
(DefineExpressionRequest defineExpressionRequest) Configures anExpression
for the search domain.defineExpressionAsync
(DefineExpressionRequest defineExpressionRequest, AsyncHandler<DefineExpressionRequest, DefineExpressionResult> asyncHandler) Configures anExpression
for the search domain.defineIndexFieldAsync
(DefineIndexFieldRequest defineIndexFieldRequest) Configures anIndexField
for the search domain.defineIndexFieldAsync
(DefineIndexFieldRequest defineIndexFieldRequest, AsyncHandler<DefineIndexFieldRequest, DefineIndexFieldResult> asyncHandler) Configures anIndexField
for the search domain.defineSuggesterAsync
(DefineSuggesterRequest defineSuggesterRequest) Configures a suggester for a domain.defineSuggesterAsync
(DefineSuggesterRequest defineSuggesterRequest, AsyncHandler<DefineSuggesterRequest, DefineSuggesterResult> asyncHandler) Configures a suggester for a domain.deleteAnalysisSchemeAsync
(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) Deletes an analysis scheme.deleteAnalysisSchemeAsync
(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest, AsyncHandler<DeleteAnalysisSchemeRequest, DeleteAnalysisSchemeResult> asyncHandler) Deletes an analysis scheme.deleteDomainAsync
(DeleteDomainRequest deleteDomainRequest) Permanently deletes a search domain and all of its data.deleteDomainAsync
(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest, DeleteDomainResult> asyncHandler) Permanently deletes a search domain and all of its data.deleteExpressionAsync
(DeleteExpressionRequest deleteExpressionRequest) Removes anExpression
from the search domain.deleteExpressionAsync
(DeleteExpressionRequest deleteExpressionRequest, AsyncHandler<DeleteExpressionRequest, DeleteExpressionResult> asyncHandler) Removes anExpression
from the search domain.deleteIndexFieldAsync
(DeleteIndexFieldRequest deleteIndexFieldRequest) Removes anIndexField
from the search domain.deleteIndexFieldAsync
(DeleteIndexFieldRequest deleteIndexFieldRequest, AsyncHandler<DeleteIndexFieldRequest, DeleteIndexFieldResult> asyncHandler) Removes anIndexField
from the search domain.deleteSuggesterAsync
(DeleteSuggesterRequest deleteSuggesterRequest) Deletes a suggester.deleteSuggesterAsync
(DeleteSuggesterRequest deleteSuggesterRequest, AsyncHandler<DeleteSuggesterRequest, DeleteSuggesterResult> asyncHandler) Deletes a suggester.describeAnalysisSchemesAsync
(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest) Gets the analysis schemes configured for a domain.describeAnalysisSchemesAsync
(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest, AsyncHandler<DescribeAnalysisSchemesRequest, DescribeAnalysisSchemesResult> asyncHandler) Gets the analysis schemes configured for a domain.describeAvailabilityOptionsAsync
(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) Gets the availability options configured for a domain.describeAvailabilityOptionsAsync
(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest, AsyncHandler<DescribeAvailabilityOptionsRequest, DescribeAvailabilityOptionsResult> asyncHandler) Gets the availability options configured for a domain.Simplified method form for invoking the DescribeDomains operation.Simplified method form for invoking the DescribeDomains operation with an AsyncHandler.describeDomainsAsync
(DescribeDomainsRequest describeDomainsRequest) Gets information about the search domains owned by this account.describeDomainsAsync
(DescribeDomainsRequest describeDomainsRequest, AsyncHandler<DescribeDomainsRequest, DescribeDomainsResult> asyncHandler) Gets information about the search domains owned by this account.describeExpressionsAsync
(DescribeExpressionsRequest describeExpressionsRequest) Gets the expressions configured for the search domain.describeExpressionsAsync
(DescribeExpressionsRequest describeExpressionsRequest, AsyncHandler<DescribeExpressionsRequest, DescribeExpressionsResult> asyncHandler) Gets the expressions configured for the search domain.describeIndexFieldsAsync
(DescribeIndexFieldsRequest describeIndexFieldsRequest) Gets information about the index fields configured for the search domain.describeIndexFieldsAsync
(DescribeIndexFieldsRequest describeIndexFieldsRequest, AsyncHandler<DescribeIndexFieldsRequest, DescribeIndexFieldsResult> asyncHandler) Gets information about the index fields configured for the search domain.describeScalingParametersAsync
(DescribeScalingParametersRequest describeScalingParametersRequest) Gets the scaling parameters configured for a domain.describeScalingParametersAsync
(DescribeScalingParametersRequest describeScalingParametersRequest, AsyncHandler<DescribeScalingParametersRequest, DescribeScalingParametersResult> asyncHandler) Gets the scaling parameters configured for a domain.describeServiceAccessPoliciesAsync
(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) Gets information about the access policies that control access to the domain's document and search endpoints.describeServiceAccessPoliciesAsync
(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest, AsyncHandler<DescribeServiceAccessPoliciesRequest, DescribeServiceAccessPoliciesResult> asyncHandler) Gets information about the access policies that control access to the domain's document and search endpoints.describeSuggestersAsync
(DescribeSuggestersRequest describeSuggestersRequest) Gets the suggesters configured for a domain.describeSuggestersAsync
(DescribeSuggestersRequest describeSuggestersRequest, AsyncHandler<DescribeSuggestersRequest, DescribeSuggestersResult> asyncHandler) Gets the suggesters configured for a domain.indexDocumentsAsync
(IndexDocumentsRequest indexDocumentsRequest) Tells the search domain to start indexing its documents using the latest indexing options.indexDocumentsAsync
(IndexDocumentsRequest indexDocumentsRequest, AsyncHandler<IndexDocumentsRequest, IndexDocumentsResult> asyncHandler) Tells the search domain to start indexing its documents using the latest indexing options.Simplified method form for invoking the ListDomainNames operation.Simplified method form for invoking the ListDomainNames operation with an AsyncHandler.listDomainNamesAsync
(ListDomainNamesRequest listDomainNamesRequest) Lists all search domains owned by an account.listDomainNamesAsync
(ListDomainNamesRequest listDomainNamesRequest, AsyncHandler<ListDomainNamesRequest, ListDomainNamesResult> asyncHandler) Lists all search domains owned by an account.updateAvailabilityOptionsAsync
(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) Configures the availability options for a domain.updateAvailabilityOptionsAsync
(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest, AsyncHandler<UpdateAvailabilityOptionsRequest, UpdateAvailabilityOptionsResult> asyncHandler) Configures the availability options for a domain.updateScalingParametersAsync
(UpdateScalingParametersRequest updateScalingParametersRequest) Configures scaling parameters for a domain.updateScalingParametersAsync
(UpdateScalingParametersRequest updateScalingParametersRequest, AsyncHandler<UpdateScalingParametersRequest, UpdateScalingParametersResult> asyncHandler) Configures scaling parameters for a domain.updateServiceAccessPoliciesAsync
(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) Configures the access rules that control access to the domain's document and search endpoints.updateServiceAccessPoliciesAsync
(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest, AsyncHandler<UpdateServiceAccessPoliciesRequest, UpdateServiceAccessPoliciesResult> asyncHandler) Configures the access rules that control access to the domain's document and search endpoints.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, shutdown, updateAvailabilityOptions, updateScalingParameters, updateServiceAccessPolicies
-
Method Details
-
buildSuggestersAsync
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
- Parameters:
buildSuggestersRequest
- Container for the parameters to theBuildSuggester
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
Future<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest buildSuggestersRequest, AsyncHandler<BuildSuggestersRequest, BuildSuggestersResult> asyncHandler) Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
- Parameters:
buildSuggestersRequest
- Container for the parameters to theBuildSuggester
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
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
- Parameters:
createDomainRequest
- Container for the parameters to theCreateDomain
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
Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest, AsyncHandler<CreateDomainRequest, CreateDomainResult> asyncHandler) Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
- Parameters:
createDomainRequest
- Container for the parameters to theCreateDomain
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
Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) Configures an analysis scheme that can be applied to a
text
ortext-array
field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.- Parameters:
defineAnalysisSchemeRequest
- Container for the parameters to theDefineAnalysisScheme
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
Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest, AsyncHandler<DefineAnalysisSchemeRequest, DefineAnalysisSchemeResult> asyncHandler) Configures an analysis scheme that can be applied to a
text
ortext-array
field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.- Parameters:
defineAnalysisSchemeRequest
- Container for the parameters to theDefineAnalysisScheme
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
Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest defineExpressionRequest) 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.- Parameters:
defineExpressionRequest
- Container for the parameters to theDefineExpression
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
Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest defineExpressionRequest, AsyncHandler<DefineExpressionRequest, DefineExpressionResult> asyncHandler) 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.- Parameters:
defineExpressionRequest
- Container for the parameters to theDefineExpression
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
Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest) 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 theIndexFieldType
. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.- Parameters:
defineIndexFieldRequest
- Container for the parameters to theDefineIndexField
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
Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest, AsyncHandler<DefineIndexFieldRequest, DefineIndexFieldResult> asyncHandler) 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 theIndexFieldType
. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.- Parameters:
defineIndexFieldRequest
- Container for the parameters to theDefineIndexField
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
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.
- Parameters:
defineSuggesterRequest
- Container for the parameters to theDefineSuggester
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
Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest defineSuggesterRequest, AsyncHandler<DefineSuggesterRequest, DefineSuggesterResult> asyncHandler) 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.
- Parameters:
defineSuggesterRequest
- Container for the parameters to theDefineSuggester
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
Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
- Parameters:
deleteAnalysisSchemeRequest
- Container for the parameters to theDeleteAnalysisScheme
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
Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest, AsyncHandler<DeleteAnalysisSchemeRequest, DeleteAnalysisSchemeResult> asyncHandler) Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
- Parameters:
deleteAnalysisSchemeRequest
- Container for the parameters to theDeleteAnalysisScheme
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
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.
- Parameters:
deleteDomainRequest
- Container for the parameters to theDeleteDomain
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
Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest, DeleteDomainResult> asyncHandler) 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.
- Parameters:
deleteDomainRequest
- Container for the parameters to theDeleteDomain
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
Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest deleteExpressionRequest) Removes an
Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.- Parameters:
deleteExpressionRequest
- Container for the parameters to theDeleteExpression
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
Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest deleteExpressionRequest, AsyncHandler<DeleteExpressionRequest, DeleteExpressionResult> asyncHandler) Removes an
Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.- Parameters:
deleteExpressionRequest
- Container for the parameters to theDeleteExpression
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
Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest) Removes an
IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.- Parameters:
deleteIndexFieldRequest
- Container for the parameters to theDeleteIndexField
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
Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest, AsyncHandler<DeleteIndexFieldRequest, DeleteIndexFieldResult> asyncHandler) Removes an
IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.- Parameters:
deleteIndexFieldRequest
- Container for the parameters to theDeleteIndexField
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
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
- Parameters:
deleteSuggesterRequest
- Container for the parameters to theDeleteSuggester
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
Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest deleteSuggesterRequest, AsyncHandler<DeleteSuggesterRequest, DeleteSuggesterResult> asyncHandler) Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
- Parameters:
deleteSuggesterRequest
- Container for the parameters to theDeleteSuggester
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
Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest) 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 theDeployed
option totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.- Parameters:
describeAnalysisSchemesRequest
- Container for the parameters to theDescribeAnalysisSchemes
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 theDeployed
option totrue
.- Returns:
- A Java Future containing the result of the DescribeAnalysisSchemes operation returned by the service.
-
describeAnalysisSchemesAsync
Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest, AsyncHandler<DescribeAnalysisSchemesRequest, DescribeAnalysisSchemesResult> asyncHandler) 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 theDeployed
option totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.- Parameters:
describeAnalysisSchemesRequest
- Container for the parameters to theDescribeAnalysisSchemes
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 theDeployed
option totrue
.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
Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the
Deployed
option totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.- Parameters:
describeAvailabilityOptionsRequest
- Container for the parameters to theDescribeAvailabilityOptions
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 totrue
.- Returns:
- A Java Future containing the result of the DescribeAvailabilityOptions operation returned by the service.
-
describeAvailabilityOptionsAsync
Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest, AsyncHandler<DescribeAvailabilityOptionsRequest, DescribeAvailabilityOptionsResult> asyncHandler) Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the
Deployed
option totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.- Parameters:
describeAvailabilityOptionsRequest
- Container for the parameters to theDescribeAvailabilityOptions
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 totrue
.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
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.- Parameters:
describeDomainsRequest
- Container for the parameters to theDescribeDomains
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
Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest describeDomainsRequest, AsyncHandler<DescribeDomainsRequest, DescribeDomainsResult> asyncHandler) 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.- Parameters:
describeDomainsRequest
- Container for the parameters to theDescribeDomains
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
Future<DescribeDomainsResult> describeDomainsAsync()Simplified method form for invoking the DescribeDomains operation. -
describeDomainsAsync
Future<DescribeDomainsResult> describeDomainsAsync(AsyncHandler<DescribeDomainsRequest, DescribeDomainsResult> asyncHandler) Simplified method form for invoking the DescribeDomains operation with an AsyncHandler. -
describeExpressionsAsync
Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest describeExpressionsRequest) 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 totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.- Parameters:
describeExpressionsRequest
- Container for the parameters to theDescribeDomains
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 theDeployed
option totrue
.- Returns:
- A Java Future containing the result of the DescribeExpressions operation returned by the service.
-
describeExpressionsAsync
Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest describeExpressionsRequest, AsyncHandler<DescribeExpressionsRequest, DescribeExpressionsResult> asyncHandler) 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 totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.- Parameters:
describeExpressionsRequest
- Container for the parameters to theDescribeDomains
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 theDeployed
option totrue
.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
Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest) 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 totrue
to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.- Parameters:
describeIndexFieldsRequest
- Container for the parameters to theDescribeIndexFields
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 theDeployed
option totrue
.- Returns:
- A Java Future containing the result of the DescribeIndexFields operation returned by the service.
-
describeIndexFieldsAsync
Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest, AsyncHandler<DescribeIndexFieldsRequest, DescribeIndexFieldsResult> asyncHandler) 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 totrue
to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.- Parameters:
describeIndexFieldsRequest
- Container for the parameters to theDescribeIndexFields
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 theDeployed
option totrue
.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
Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest describeScalingParametersRequest) 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.
- Parameters:
describeScalingParametersRequest
- Container for the parameters to theDescribeScalingParameters
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
Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest describeScalingParametersRequest, AsyncHandler<DescribeScalingParametersRequest, DescribeScalingParametersResult> asyncHandler) 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.
- Parameters:
describeScalingParametersRequest
- Container for the parameters to theDescribeScalingParameters
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
Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) 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 totrue
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.- Parameters:
describeServiceAccessPoliciesRequest
- Container for the parameters to theDescribeServiceAccessPolicies
operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.- Returns:
- A Java Future containing the result of the DescribeServiceAccessPolicies operation returned by the service.
-
describeServiceAccessPoliciesAsync
Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest, AsyncHandler<DescribeServiceAccessPoliciesRequest, DescribeServiceAccessPoliciesResult> asyncHandler) 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 totrue
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.- Parameters:
describeServiceAccessPoliciesRequest
- Container for the parameters to theDescribeServiceAccessPolicies
operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.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
Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest describeSuggestersRequest) 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 totrue
to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.- Parameters:
describeSuggestersRequest
- Container for the parameters to theDescribeSuggester
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 theDeployed
option totrue
.- Returns:
- A Java Future containing the result of the DescribeSuggesters operation returned by the service.
-
describeSuggestersAsync
Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest describeSuggestersRequest, AsyncHandler<DescribeSuggestersRequest, DescribeSuggestersResult> asyncHandler) 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 totrue
to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.- Parameters:
describeSuggestersRequest
- Container for the parameters to theDescribeSuggester
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 theDeployed
option totrue
.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
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
.- Parameters:
indexDocumentsRequest
- Container for the parameters to theIndexDocuments
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
Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest indexDocumentsRequest, AsyncHandler<IndexDocumentsRequest, IndexDocumentsResult> asyncHandler) 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
.- Parameters:
indexDocumentsRequest
- Container for the parameters to theIndexDocuments
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
Lists all search domains owned by an account.
- Parameters:
listDomainNamesRequest
-- Returns:
- A Java Future containing the result of the ListDomainNames operation returned by the service.
-
listDomainNamesAsync
Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest listDomainNamesRequest, AsyncHandler<ListDomainNamesRequest, ListDomainNamesResult> asyncHandler) Lists all search domains owned by an account.
- Parameters:
listDomainNamesRequest
-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
Future<ListDomainNamesResult> listDomainNamesAsync()Simplified method form for invoking the ListDomainNames operation. -
listDomainNamesAsync
Future<ListDomainNamesResult> listDomainNamesAsync(AsyncHandler<ListDomainNamesRequest, ListDomainNamesResult> asyncHandler) Simplified method form for invoking the ListDomainNames operation with an AsyncHandler. -
updateAvailabilityOptionsAsync
Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) 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.
- Parameters:
updateAvailabilityOptionsRequest
- Container for the parameters to theUpdateAvailabilityOptions
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
Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest, AsyncHandler<UpdateAvailabilityOptionsRequest, UpdateAvailabilityOptionsResult> asyncHandler) 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.
- Parameters:
updateAvailabilityOptionsRequest
- Container for the parameters to theUpdateAvailabilityOptions
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
Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest updateScalingParametersRequest) 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.
- Parameters:
updateScalingParametersRequest
- Container for the parameters to theUpdateScalingParameters
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
Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest updateScalingParametersRequest, AsyncHandler<UpdateScalingParametersRequest, UpdateScalingParametersResult> asyncHandler) 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.
- Parameters:
updateScalingParametersRequest
- Container for the parameters to theUpdateScalingParameters
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
Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) 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.
- Parameters:
updateServiceAccessPoliciesRequest
- Container for the parameters to theUpdateServiceAccessPolicies
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
Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest, AsyncHandler<UpdateServiceAccessPoliciesRequest, UpdateServiceAccessPoliciesResult> asyncHandler) 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.
- Parameters:
updateServiceAccessPoliciesRequest
- Container for the parameters to theUpdateServiceAccessPolicies
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.
-