@Generated(value="software.amazon.awssdk:codegen") public interface CloudSearchAsyncClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static CloudSearchAsyncClient create()
CloudSearchAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudSearchAsyncClientBuilder builder()
CloudSearchAsyncClient
.default CompletableFuture<BuildSuggestersResponse> buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
buildSuggestersRequest
- Container for the parameters to the BuildSuggester
operation. Specifies the name of
the domain you want to update.default CompletableFuture<BuildSuggestersResponse> buildSuggesters(Consumer<BuildSuggestersRequest.Builder> buildSuggestersRequest)
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the BuildSuggestersRequest.Builder
avoiding the need
to create one manually via BuildSuggestersRequest.builder()
buildSuggestersRequest
- A Consumer
that will call methods on BuildSuggestersRequest.Builder
to create a request.
Container for the parameters to the BuildSuggester
operation. Specifies the name of
the domain you want to update.default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest)
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
createDomainRequest
- Container for the parameters to the CreateDomain
operation. Specifies a name for the
new search domain.default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the CreateDomainRequest.Builder
avoiding the need to
create one manually via CreateDomainRequest.builder()
createDomainRequest
- A Consumer
that will call methods on CreateDomainRequest.Builder
to create a request.
Container for the parameters to the CreateDomain
operation. Specifies a name for the
new search domain.default CompletableFuture<DefineAnalysisSchemeResponse> defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest)
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.
defineAnalysisSchemeRequest
- Container for the parameters to the DefineAnalysisScheme
operation. Specifies the name
of the domain you want to update and the analysis scheme configuration.default CompletableFuture<DefineAnalysisSchemeResponse> defineAnalysisScheme(Consumer<DefineAnalysisSchemeRequest.Builder> defineAnalysisSchemeRequest)
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.
This is a convenience which creates an instance of the DefineAnalysisSchemeRequest.Builder
avoiding the
need to create one manually via DefineAnalysisSchemeRequest.builder()
defineAnalysisSchemeRequest
- A Consumer
that will call methods on DefineAnalysisSchemeRequest.Builder
to create a
request. Container for the parameters to the DefineAnalysisScheme
operation. Specifies
the name of the domain you want to update and the analysis scheme configuration.default CompletableFuture<DefineExpressionResponse> defineExpression(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.
defineExpressionRequest
- 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.default CompletableFuture<DefineExpressionResponse> defineExpression(Consumer<DefineExpressionRequest.Builder> 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.
This is a convenience which creates an instance of the DefineExpressionRequest.Builder
avoiding the need
to create one manually via DefineExpressionRequest.builder()
defineExpressionRequest
- A Consumer
that will call methods on DefineExpressionRequest.Builder
to create a 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.default CompletableFuture<DefineIndexFieldResponse> defineIndexField(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 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.
defineIndexFieldRequest
- Container for the parameters to the DefineIndexField
operation. Specifies the name of
the domain you want to update and the index field configuration.default CompletableFuture<DefineIndexFieldResponse> defineIndexField(Consumer<DefineIndexFieldRequest.Builder> 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 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.
This is a convenience which creates an instance of the DefineIndexFieldRequest.Builder
avoiding the need
to create one manually via DefineIndexFieldRequest.builder()
defineIndexFieldRequest
- A Consumer
that will call methods on DefineIndexFieldRequest.Builder
to create a request.
Container for the parameters to the DefineIndexField
operation. Specifies the name of
the domain you want to update and the index field configuration.default CompletableFuture<DefineSuggesterResponse> defineSuggester(DefineSuggesterRequest defineSuggesterRequest)
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.
defineSuggesterRequest
- Container for the parameters to the DefineSuggester
operation. Specifies the name of
the domain you want to update and the suggester configuration.default CompletableFuture<DefineSuggesterResponse> defineSuggester(Consumer<DefineSuggesterRequest.Builder> defineSuggesterRequest)
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.
This is a convenience which creates an instance of the DefineSuggesterRequest.Builder
avoiding the need
to create one manually via DefineSuggesterRequest.builder()
defineSuggesterRequest
- A Consumer
that will call methods on DefineSuggesterRequest.Builder
to create a request.
Container for the parameters to the DefineSuggester
operation. Specifies the name of
the domain you want to update and the suggester configuration.default CompletableFuture<DeleteAnalysisSchemeResponse> deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
deleteAnalysisSchemeRequest
- 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.default CompletableFuture<DeleteAnalysisSchemeResponse> deleteAnalysisScheme(Consumer<DeleteAnalysisSchemeRequest.Builder> deleteAnalysisSchemeRequest)
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the DeleteAnalysisSchemeRequest.Builder
avoiding the
need to create one manually via DeleteAnalysisSchemeRequest.builder()
deleteAnalysisSchemeRequest
- A Consumer
that will call methods on DeleteAnalysisSchemeRequest.Builder
to create a
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.default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest)
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.
deleteDomainRequest
- Container for the parameters to the DeleteDomain
operation. Specifies the name of the
domain you want to delete.default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
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.
This is a convenience which creates an instance of the DeleteDomainRequest.Builder
avoiding the need to
create one manually via DeleteDomainRequest.builder()
deleteDomainRequest
- A Consumer
that will call methods on DeleteDomainRequest.Builder
to create a request.
Container for the parameters to the DeleteDomain
operation. Specifies the name of the
domain you want to delete.default CompletableFuture<DeleteExpressionResponse> deleteExpression(DeleteExpressionRequest deleteExpressionRequest)
Removes an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
deleteExpressionRequest
- 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.default CompletableFuture<DeleteExpressionResponse> deleteExpression(Consumer<DeleteExpressionRequest.Builder> deleteExpressionRequest)
Removes an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the DeleteExpressionRequest.Builder
avoiding the need
to create one manually via DeleteExpressionRequest.builder()
deleteExpressionRequest
- A Consumer
that will call methods on DeleteExpressionRequest.Builder
to create a 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.default CompletableFuture<DeleteIndexFieldResponse> deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)
Removes an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
deleteIndexFieldRequest
- 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.default CompletableFuture<DeleteIndexFieldResponse> deleteIndexField(Consumer<DeleteIndexFieldRequest.Builder> deleteIndexFieldRequest)
Removes an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the DeleteIndexFieldRequest.Builder
avoiding the need
to create one manually via DeleteIndexFieldRequest.builder()
deleteIndexFieldRequest
- A Consumer
that will call methods on DeleteIndexFieldRequest.Builder
to create a 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.default CompletableFuture<DeleteSuggesterResponse> deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest)
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
deleteSuggesterRequest
- 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.default CompletableFuture<DeleteSuggesterResponse> deleteSuggester(Consumer<DeleteSuggesterRequest.Builder> deleteSuggesterRequest)
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the DeleteSuggesterRequest.Builder
avoiding the need
to create one manually via DeleteSuggesterRequest.builder()
deleteSuggesterRequest
- A Consumer
that will call methods on DeleteSuggesterRequest.Builder
to create a 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.default CompletableFuture<DescribeAnalysisSchemesResponse> describeAnalysisSchemes(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 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.
describeAnalysisSchemesRequest
- 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
.default CompletableFuture<DescribeAnalysisSchemesResponse> describeAnalysisSchemes(Consumer<DescribeAnalysisSchemesRequest.Builder> 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 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.
This is a convenience which creates an instance of the DescribeAnalysisSchemesRequest.Builder
avoiding
the need to create one manually via DescribeAnalysisSchemesRequest.builder()
describeAnalysisSchemesRequest
- A Consumer
that will call methods on DescribeAnalysisSchemesRequest.Builder
to create a
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
.default CompletableFuture<DescribeAvailabilityOptionsResponse> describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest)
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.
describeAvailabilityOptionsRequest
- 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
.default CompletableFuture<DescribeAvailabilityOptionsResponse> describeAvailabilityOptions(Consumer<DescribeAvailabilityOptionsRequest.Builder> describeAvailabilityOptionsRequest)
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.
This is a convenience which creates an instance of the DescribeAvailabilityOptionsRequest.Builder
avoiding the need to create one manually via DescribeAvailabilityOptionsRequest.builder()
describeAvailabilityOptionsRequest
- A Consumer
that will call methods on DescribeAvailabilityOptionsRequest.Builder
to create
a 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
.default CompletableFuture<DescribeDomainsResponse> describeDomains(DescribeDomainsRequest describeDomainsRequest)
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.
describeDomainsRequest
- 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.default CompletableFuture<DescribeDomainsResponse> describeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest)
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.
This is a convenience which creates an instance of the DescribeDomainsRequest.Builder
avoiding the need
to create one manually via DescribeDomainsRequest.builder()
describeDomainsRequest
- A Consumer
that will call methods on DescribeDomainsRequest.Builder
to create a 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.default CompletableFuture<DescribeDomainsResponse> describeDomains()
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.
default CompletableFuture<DescribeExpressionsResponse> describeExpressions(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 to true
to show the active configuration and exclude pending changes.
For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
describeExpressionsRequest
- 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
.default CompletableFuture<DescribeExpressionsResponse> describeExpressions(Consumer<DescribeExpressionsRequest.Builder> 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 to true
to show the active configuration and exclude pending changes.
For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the DescribeExpressionsRequest.Builder
avoiding the
need to create one manually via DescribeExpressionsRequest.builder()
describeExpressionsRequest
- A Consumer
that will call methods on DescribeExpressionsRequest.Builder
to create a
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
.default CompletableFuture<DescribeIndexFieldsResponse> describeIndexFields(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 to true
to show the active configuration and exclude pending changes.
For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
describeIndexFieldsRequest
- 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
.default CompletableFuture<DescribeIndexFieldsResponse> describeIndexFields(Consumer<DescribeIndexFieldsRequest.Builder> 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 to true
to show the active configuration and exclude pending changes.
For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the DescribeIndexFieldsRequest.Builder
avoiding the
need to create one manually via DescribeIndexFieldsRequest.builder()
describeIndexFieldsRequest
- A Consumer
that will call methods on DescribeIndexFieldsRequest.Builder
to create a
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
.default CompletableFuture<DescribeScalingParametersResponse> describeScalingParameters(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.
describeScalingParametersRequest
- Container for the parameters to the DescribeScalingParameters
operation. Specifies the
name of the domain you want to describe.default CompletableFuture<DescribeScalingParametersResponse> describeScalingParameters(Consumer<DescribeScalingParametersRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeScalingParametersRequest.Builder
avoiding
the need to create one manually via DescribeScalingParametersRequest.builder()
describeScalingParametersRequest
- A Consumer
that will call methods on DescribeScalingParametersRequest.Builder
to create a
request. Container for the parameters to the DescribeScalingParameters
operation.
Specifies the name of the domain you want to describe.default CompletableFuture<DescribeServiceAccessPoliciesResponse> describeServiceAccessPolicies(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 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.
describeServiceAccessPoliciesRequest
- 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
.default CompletableFuture<DescribeServiceAccessPoliciesResponse> describeServiceAccessPolicies(Consumer<DescribeServiceAccessPoliciesRequest.Builder> 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 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.
This is a convenience which creates an instance of the DescribeServiceAccessPoliciesRequest.Builder
avoiding the need to create one manually via DescribeServiceAccessPoliciesRequest.builder()
describeServiceAccessPoliciesRequest
- A Consumer
that will call methods on DescribeServiceAccessPoliciesRequest.Builder
to
create a 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
.default CompletableFuture<DescribeSuggestersResponse> describeSuggesters(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 to true
to
show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
describeSuggestersRequest
- 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
.default CompletableFuture<DescribeSuggestersResponse> describeSuggesters(Consumer<DescribeSuggestersRequest.Builder> 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 to true
to
show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
This is a convenience which creates an instance of the DescribeSuggestersRequest.Builder
avoiding the
need to create one manually via DescribeSuggestersRequest.builder()
describeSuggestersRequest
- A Consumer
that will call methods on DescribeSuggestersRequest.Builder
to create a
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
.default CompletableFuture<IndexDocumentsResponse> indexDocuments(IndexDocumentsRequest indexDocumentsRequest)
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
.
indexDocumentsRequest
- Container for the parameters to the IndexDocuments
operation. Specifies the name of
the domain you want to re-index.default CompletableFuture<IndexDocumentsResponse> indexDocuments(Consumer<IndexDocumentsRequest.Builder> indexDocumentsRequest)
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
.
This is a convenience which creates an instance of the IndexDocumentsRequest.Builder
avoiding the need to
create one manually via IndexDocumentsRequest.builder()
indexDocumentsRequest
- A Consumer
that will call methods on IndexDocumentsRequest.Builder
to create a request.
Container for the parameters to the IndexDocuments
operation. Specifies the name of
the domain you want to re-index.default CompletableFuture<ListDomainNamesResponse> listDomainNames(ListDomainNamesRequest listDomainNamesRequest)
Lists all search domains owned by an account.
listDomainNamesRequest
- default CompletableFuture<ListDomainNamesResponse> listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)
Lists all search domains owned by an account.
This is a convenience which creates an instance of the ListDomainNamesRequest.Builder
avoiding the need
to create one manually via ListDomainNamesRequest.builder()
listDomainNamesRequest
- A Consumer
that will call methods on ListDomainNamesRequest.Builder
to create a request.default CompletableFuture<ListDomainNamesResponse> listDomainNames()
Lists all search domains owned by an account.
default CompletableFuture<UpdateAvailabilityOptionsResponse> updateAvailabilityOptions(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.
updateAvailabilityOptionsRequest
- Container for the parameters to the UpdateAvailabilityOptions
operation. Specifies the
name of the domain you want to update and the Multi-AZ availability option.default CompletableFuture<UpdateAvailabilityOptionsResponse> updateAvailabilityOptions(Consumer<UpdateAvailabilityOptionsRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateAvailabilityOptionsRequest.Builder
avoiding
the need to create one manually via UpdateAvailabilityOptionsRequest.builder()
updateAvailabilityOptionsRequest
- A Consumer
that will call methods on UpdateAvailabilityOptionsRequest.Builder
to create a
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.default CompletableFuture<UpdateScalingParametersResponse> updateScalingParameters(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.
updateScalingParametersRequest
- 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.default CompletableFuture<UpdateScalingParametersResponse> updateScalingParameters(Consumer<UpdateScalingParametersRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateScalingParametersRequest.Builder
avoiding
the need to create one manually via UpdateScalingParametersRequest.builder()
updateScalingParametersRequest
- A Consumer
that will call methods on UpdateScalingParametersRequest.Builder
to create a
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.default CompletableFuture<UpdateServiceAccessPoliciesResponse> updateServiceAccessPolicies(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.
updateServiceAccessPoliciesRequest
- 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.default CompletableFuture<UpdateServiceAccessPoliciesResponse> updateServiceAccessPolicies(Consumer<UpdateServiceAccessPoliciesRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateServiceAccessPoliciesRequest.Builder
avoiding the need to create one manually via UpdateServiceAccessPoliciesRequest.builder()
updateServiceAccessPoliciesRequest
- A Consumer
that will call methods on UpdateServiceAccessPoliciesRequest.Builder
to create
a 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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.