Class AbstractAmazonCloudSearch
- All Implemented Interfaces:
AmazonCloudSearch
- Direct Known Subclasses:
AbstractAmazonCloudSearchAsync
AmazonCloudSearch
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuildSuggesters
(BuildSuggestersRequest request) Indexes the search suggestions.createDomain
(CreateDomainRequest request) Creates a new search domain.Configures an analysis scheme that can be applied to atext
ortext-array
field to define language-specific text processing options.defineExpression
(DefineExpressionRequest request) Configures anExpression
for the search domain.defineIndexField
(DefineIndexFieldRequest request) Configures anIndexField
for the search domain.defineSuggester
(DefineSuggesterRequest request) Configures a suggester for a domain.Deletes an analysis scheme.deleteDomain
(DeleteDomainRequest request) Permanently deletes a search domain and all of its data.deleteExpression
(DeleteExpressionRequest request) Removes anExpression
from the search domain.deleteIndexField
(DeleteIndexFieldRequest request) Removes anIndexField
from the search domain.deleteSuggester
(DeleteSuggesterRequest request) Deletes a suggester.Gets the analysis schemes configured for a domain.Gets the availability options configured for a domain.Simplified method form for invoking the DescribeDomains operation.describeDomains
(DescribeDomainsRequest request) Gets information about the search domains owned by this account.Gets the expressions configured for the search domain.Gets information about the index fields configured for the search domain.Gets the scaling parameters configured for a domain.Gets information about the access policies that control access to the domain's document and search endpoints.Gets the suggesters configured for a domain.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.indexDocuments
(IndexDocumentsRequest request) Tells the search domain to start indexing its documents using the latest indexing options.Simplified method form for invoking the ListDomainNames operation.listDomainNames
(ListDomainNamesRequest request) Lists all search domains owned by an account.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://cloudsearch.us-east-1.amazonaws.com/").void
An alternative toAmazonCloudSearch.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.Configures the availability options for a domain.Configures scaling parameters for a domain.Configures the access rules that control access to the domain's document and search endpoints.
-
Constructor Details
-
AbstractAmazonCloudSearch
protected AbstractAmazonCloudSearch()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonCloudSearch
Overrides the default endpoint for this client ("https://cloudsearch.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "cloudsearch.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudsearch.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonCloudSearch
- Parameters:
endpoint
- The endpoint (ex: "cloudsearch.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudsearch.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AmazonCloudSearch
An alternative toAmazonCloudSearch.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAmazonCloudSearch
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
buildSuggesters
Description copied from interface:AmazonCloudSearch
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
- Specified by:
buildSuggesters
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theBuildSuggester
operation. Specifies the name of the domain you want to update.- Returns:
- Result of the BuildSuggesters operation returned by the service.
-
createDomain
Description copied from interface:AmazonCloudSearch
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
- Specified by:
createDomain
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theCreateDomain
operation. Specifies a name for the new search domain.- Returns:
- Result of the CreateDomain operation returned by the service.
-
defineAnalysisScheme
Description copied from interface:AmazonCloudSearch
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.- Specified by:
defineAnalysisScheme
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theDefineAnalysisScheme
operation. Specifies the name of the domain you want to update and the analysis scheme configuration.- Returns:
- Result of the DefineAnalysisScheme operation returned by the service.
-
defineExpression
Description copied from interface:AmazonCloudSearch
Configures an
Expression
for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.- Specified by:
defineExpression
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DefineExpression operation returned by the service.
-
defineIndexField
Description copied from interface:AmazonCloudSearch
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.- Specified by:
defineIndexField
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theDefineIndexField
operation. Specifies the name of the domain you want to update and the index field configuration.- Returns:
- Result of the DefineIndexField operation returned by the service.
-
defineSuggester
Description copied from interface:AmazonCloudSearch
Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
- Specified by:
defineSuggester
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theDefineSuggester
operation. Specifies the name of the domain you want to update and the suggester configuration.- Returns:
- Result of the DefineSuggester operation returned by the service.
-
deleteAnalysisScheme
Description copied from interface:AmazonCloudSearch
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
- Specified by:
deleteAnalysisScheme
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DeleteAnalysisScheme operation returned by the service.
-
deleteDomain
Description copied from interface:AmazonCloudSearch
Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
- Specified by:
deleteDomain
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theDeleteDomain
operation. Specifies the name of the domain you want to delete.- Returns:
- Result of the DeleteDomain operation returned by the service.
-
deleteExpression
Description copied from interface:AmazonCloudSearch
Removes an
Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.- Specified by:
deleteExpression
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DeleteExpression operation returned by the service.
-
deleteIndexField
Description copied from interface:AmazonCloudSearch
Removes an
IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.- Specified by:
deleteIndexField
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DeleteIndexField operation returned by the service.
-
deleteSuggester
Description copied from interface:AmazonCloudSearch
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
- Specified by:
deleteSuggester
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DeleteSuggester operation returned by the service.
-
describeAnalysisSchemes
public DescribeAnalysisSchemesResult describeAnalysisSchemes(DescribeAnalysisSchemesRequest request) Description copied from interface:AmazonCloudSearch
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.- Specified by:
describeAnalysisSchemes
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DescribeAnalysisSchemes operation returned by the service.
-
describeAvailabilityOptions
public DescribeAvailabilityOptionsResult describeAvailabilityOptions(DescribeAvailabilityOptionsRequest request) Description copied from interface:AmazonCloudSearch
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.- Specified by:
describeAvailabilityOptions
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DescribeAvailabilityOptions operation returned by the service.
-
describeDomains
Description copied from interface:AmazonCloudSearch
Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a
matchall
request to your domain's search endpoint:q=matchall&q.parser=structured&size=0
. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.- Specified by:
describeDomains
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DescribeDomains operation returned by the service.
-
describeDomains
Description copied from interface:AmazonCloudSearch
Simplified method form for invoking the DescribeDomains operation.- Specified by:
describeDomains
in interfaceAmazonCloudSearch
- See Also:
-
describeExpressions
Description copied from interface:AmazonCloudSearch
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.- Specified by:
describeExpressions
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DescribeExpressions operation returned by the service.
-
describeIndexFields
Description copied from interface:AmazonCloudSearch
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.- Specified by:
describeIndexFields
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DescribeIndexFields operation returned by the service.
-
describeScalingParameters
public DescribeScalingParametersResult describeScalingParameters(DescribeScalingParametersRequest request) Description copied from interface:AmazonCloudSearch
Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
- Specified by:
describeScalingParameters
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theDescribeScalingParameters
operation. Specifies the name of the domain you want to describe.- Returns:
- Result of the DescribeScalingParameters operation returned by the service.
-
describeServiceAccessPolicies
public DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest request) Description copied from interface:AmazonCloudSearch
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.- Specified by:
describeServiceAccessPolicies
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DescribeServiceAccessPolicies operation returned by the service.
-
describeSuggesters
Description copied from interface:AmazonCloudSearch
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.- Specified by:
describeSuggesters
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the DescribeSuggesters operation returned by the service.
-
indexDocuments
Description copied from interface:AmazonCloudSearch
Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is
RequiresIndexDocuments
.- Specified by:
indexDocuments
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theIndexDocuments
operation. Specifies the name of the domain you want to re-index.- Returns:
- Result of the IndexDocuments operation returned by the service.
-
listDomainNames
Description copied from interface:AmazonCloudSearch
Lists all search domains owned by an account.
- Specified by:
listDomainNames
in interfaceAmazonCloudSearch
- Parameters:
request
-- Returns:
- Result of the ListDomainNames operation returned by the service.
-
listDomainNames
Description copied from interface:AmazonCloudSearch
Simplified method form for invoking the ListDomainNames operation.- Specified by:
listDomainNames
in interfaceAmazonCloudSearch
- See Also:
-
updateAvailabilityOptions
public UpdateAvailabilityOptionsResult updateAvailabilityOptions(UpdateAvailabilityOptionsRequest request) Description copied from interface:AmazonCloudSearch
Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
- Specified by:
updateAvailabilityOptions
in interfaceAmazonCloudSearch
- Parameters:
request
- Container for the parameters to theUpdateAvailabilityOptions
operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.- Returns:
- Result of the UpdateAvailabilityOptions operation returned by the service.
-
updateScalingParameters
public UpdateScalingParametersResult updateScalingParameters(UpdateScalingParametersRequest request) Description copied from interface:AmazonCloudSearch
Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
- Specified by:
updateScalingParameters
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the UpdateScalingParameters operation returned by the service.
-
updateServiceAccessPolicies
public UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest request) Description copied from interface:AmazonCloudSearch
Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.
- Specified by:
updateServiceAccessPolicies
in interfaceAmazonCloudSearch
- Parameters:
request
- 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:
- Result of the UpdateServiceAccessPolicies operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AmazonCloudSearch
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAmazonCloudSearch
-
getCachedResponseMetadata
Description copied from interface:AmazonCloudSearch
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonCloudSearch
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-