@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCloudSearch extends Object implements AmazonCloudSearch
AmazonCloudSearch
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BuildSuggestersResult |
buildSuggesters(BuildSuggestersRequest request)
Indexes the search suggestions.
|
CreateDomainResult |
createDomain(CreateDomainRequest request)
Creates a new search domain.
|
DefineAnalysisSchemeResult |
defineAnalysisScheme(DefineAnalysisSchemeRequest request)
Configures an analysis scheme that can be applied to a
text or text-array field to
define language-specific text processing options. |
DefineExpressionResult |
defineExpression(DefineExpressionRequest request)
Configures an
Expression for the search domain. |
DefineIndexFieldResult |
defineIndexField(DefineIndexFieldRequest request)
Configures an
IndexField for the search domain. |
DefineSuggesterResult |
defineSuggester(DefineSuggesterRequest request)
Configures a suggester for a domain.
|
DeleteAnalysisSchemeResult |
deleteAnalysisScheme(DeleteAnalysisSchemeRequest request)
Deletes an analysis scheme.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest request)
Permanently deletes a search domain and all of its data.
|
DeleteExpressionResult |
deleteExpression(DeleteExpressionRequest request)
Removes an
Expression from the search domain. |
DeleteIndexFieldResult |
deleteIndexField(DeleteIndexFieldRequest request)
Removes an
IndexField from the search domain. |
DeleteSuggesterResult |
deleteSuggester(DeleteSuggesterRequest request)
Deletes a suggester.
|
DescribeAnalysisSchemesResult |
describeAnalysisSchemes(DescribeAnalysisSchemesRequest request)
Gets the analysis schemes configured for a domain.
|
DescribeAvailabilityOptionsResult |
describeAvailabilityOptions(DescribeAvailabilityOptionsRequest request)
Gets the availability options configured for a domain.
|
DescribeDomainEndpointOptionsResult |
describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest request)
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
|
DescribeDomainsResult |
describeDomains()
Simplified method form for invoking the DescribeDomains operation.
|
DescribeDomainsResult |
describeDomains(DescribeDomainsRequest request)
Gets information about the search domains owned by this account.
|
DescribeExpressionsResult |
describeExpressions(DescribeExpressionsRequest request)
Gets the expressions configured for the search domain.
|
DescribeIndexFieldsResult |
describeIndexFields(DescribeIndexFieldsRequest request)
Gets information about the index fields configured for the search domain.
|
DescribeScalingParametersResult |
describeScalingParameters(DescribeScalingParametersRequest request)
Gets the scaling parameters configured for a domain.
|
DescribeServiceAccessPoliciesResult |
describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest request)
Gets information about the access policies that control access to the domain's document and search endpoints.
|
DescribeSuggestersResult |
describeSuggesters(DescribeSuggestersRequest request)
Gets the suggesters configured for a domain.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
IndexDocumentsResult |
indexDocuments(IndexDocumentsRequest request)
Tells the search domain to start indexing its documents using the latest indexing options.
|
ListDomainNamesResult |
listDomainNames()
Simplified method form for invoking the ListDomainNames operation.
|
ListDomainNamesResult |
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 |
setRegion(Region region)
An alternative to
AmazonCloudSearch.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.
|
UpdateAvailabilityOptionsResult |
updateAvailabilityOptions(UpdateAvailabilityOptionsRequest request)
Configures the availability options for a domain.
|
UpdateDomainEndpointOptionsResult |
updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest request)
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
|
UpdateScalingParametersResult |
updateScalingParameters(UpdateScalingParametersRequest request)
Configures scaling parameters for a domain.
|
UpdateServiceAccessPoliciesResult |
updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest request)
Configures the access rules that control access to the domain's document and search endpoints.
|
public void setEndpoint(String endpoint)
AmazonCloudSearch
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
setEndpoint
in interface AmazonCloudSearch
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.public void setRegion(Region region)
AmazonCloudSearch
AmazonCloudSearch.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.
setRegion
in interface AmazonCloudSearch
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public BuildSuggestersResult buildSuggesters(BuildSuggestersRequest request)
AmazonCloudSearch
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
buildSuggesters
in interface AmazonCloudSearch
request
- Container for the parameters to the BuildSuggester
operation. Specifies the name of
the domain you want to update.public CreateDomainResult createDomain(CreateDomainRequest request)
AmazonCloudSearch
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
createDomain
in interface AmazonCloudSearch
request
- Container for the parameters to the CreateDomain
operation. Specifies a name for the
new search domain.public DefineAnalysisSchemeResult defineAnalysisScheme(DefineAnalysisSchemeRequest request)
AmazonCloudSearch
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.
defineAnalysisScheme
in interface AmazonCloudSearch
request
- Container for the parameters to the DefineAnalysisScheme
operation. Specifies the name
of the domain you want to update and the analysis scheme configuration.public DefineExpressionResult defineExpression(DefineExpressionRequest request)
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.
defineExpression
in interface AmazonCloudSearch
request
- Container for the parameters to the DefineExpression
operation. Specifies the name of
the domain you want to update and the expression you want to configure.public DefineIndexFieldResult defineIndexField(DefineIndexFieldRequest request)
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 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.
defineIndexField
in interface AmazonCloudSearch
request
- Container for the parameters to the DefineIndexField
operation. Specifies the name of
the domain you want to update and the index field configuration.public DefineSuggesterResult defineSuggester(DefineSuggesterRequest request)
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.
defineSuggester
in interface AmazonCloudSearch
request
- Container for the parameters to the DefineSuggester
operation. Specifies the name of
the domain you want to update and the suggester configuration.public DeleteAnalysisSchemeResult deleteAnalysisScheme(DeleteAnalysisSchemeRequest request)
AmazonCloudSearch
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
deleteAnalysisScheme
in interface AmazonCloudSearch
request
- Container for the parameters to the DeleteAnalysisScheme
operation. Specifies the name
of the domain you want to update and the analysis scheme you want to delete.public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
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.
deleteDomain
in interface AmazonCloudSearch
request
- Container for the parameters to the DeleteDomain
operation. Specifies the name of the
domain you want to delete.public DeleteExpressionResult deleteExpression(DeleteExpressionRequest request)
AmazonCloudSearch
Removes an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
deleteExpression
in interface AmazonCloudSearch
request
- Container for the parameters to the DeleteExpression
operation. Specifies the name of
the domain you want to update and the name of the expression you want to delete.public DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest request)
AmazonCloudSearch
Removes an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
deleteIndexField
in interface AmazonCloudSearch
request
- Container for the parameters to the DeleteIndexField
operation. Specifies the name of
the domain you want to update and the name of the index field you want to delete.public DeleteSuggesterResult deleteSuggester(DeleteSuggesterRequest request)
AmazonCloudSearch
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
deleteSuggester
in interface AmazonCloudSearch
request
- Container for the parameters to the DeleteSuggester
operation. Specifies the name of
the domain you want to update and name of the suggester you want to delete.public DescribeAnalysisSchemesResult describeAnalysisSchemes(DescribeAnalysisSchemesRequest request)
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 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.
describeAnalysisSchemes
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeAnalysisSchemes
operation. Specifies the
name of the domain you want to describe. To limit the response to particular analysis schemes, specify the
names of the analysis schemes you want to describe. To show the active configuration and exclude any
pending changes, set the Deployed
option to true
.public DescribeAvailabilityOptionsResult describeAvailabilityOptions(DescribeAvailabilityOptionsRequest request)
AmazonCloudSearch
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.
describeAvailabilityOptions
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeAvailabilityOptions
operation. Specifies
the name of the domain you want to describe. To show the active configuration and exclude any pending
changes, set the Deployed option to true
.public DescribeDomainEndpointOptionsResult describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest request)
AmazonCloudSearch
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
describeDomainEndpointOptions
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeDomainEndpointOptions
operation. Specify
the name of the domain you want to describe. To show the active configuration and exclude any pending
changes, set the Deployed option to true
.public DescribeDomainsResult describeDomains(DescribeDomainsRequest request)
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.
describeDomains
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeDomains
operation. By default shows the
status of all domains. To restrict the response to particular domains, specify the names of the domains
you want to describe.public DescribeDomainsResult describeDomains()
AmazonCloudSearch
describeDomains
in interface AmazonCloudSearch
AmazonCloudSearch.describeDomains(DescribeDomainsRequest)
public DescribeExpressionsResult describeExpressions(DescribeExpressionsRequest request)
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 to true
to show the active configuration and exclude pending changes.
For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
describeExpressions
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeDomains
operation. Specifies the name of
the domain you want to describe. To restrict the response to particular expressions, specify the names of
the expressions you want to describe. To show the active configuration and exclude any pending changes,
set the Deployed
option to true
.public DescribeIndexFieldsResult describeIndexFields(DescribeIndexFieldsRequest request)
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 to true
to show the active configuration and exclude pending changes.
For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
describeIndexFields
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeIndexFields
operation. Specifies the name
of the domain you want to describe. To restrict the response to particular index fields, specify the names
of the index fields you want to describe. To show the active configuration and exclude any pending
changes, set the Deployed
option to true
.public DescribeScalingParametersResult describeScalingParameters(DescribeScalingParametersRequest request)
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.
describeScalingParameters
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeScalingParameters
operation. Specifies the
name of the domain you want to describe.public DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest request)
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 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.
describeServiceAccessPolicies
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeServiceAccessPolicies
operation. Specifies
the name of the domain you want to describe. To show the active configuration and exclude any pending
changes, set the Deployed
option to true
.public DescribeSuggestersResult describeSuggesters(DescribeSuggestersRequest request)
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 to true
to
show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
describeSuggesters
in interface AmazonCloudSearch
request
- Container for the parameters to the DescribeSuggester
operation. Specifies the name of
the domain you want to describe. To restrict the response to particular suggesters, specify the names of
the suggesters you want to describe. To show the active configuration and exclude any pending changes, set
the Deployed
option to true
.public IndexDocumentsResult indexDocuments(IndexDocumentsRequest request)
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
.
indexDocuments
in interface AmazonCloudSearch
request
- Container for the parameters to the IndexDocuments
operation. Specifies the name of
the domain you want to re-index.public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)
AmazonCloudSearch
Lists all search domains owned by an account.
listDomainNames
in interface AmazonCloudSearch
public ListDomainNamesResult listDomainNames()
AmazonCloudSearch
listDomainNames
in interface AmazonCloudSearch
AmazonCloudSearch.listDomainNames(ListDomainNamesRequest)
public UpdateAvailabilityOptionsResult updateAvailabilityOptions(UpdateAvailabilityOptionsRequest request)
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.
updateAvailabilityOptions
in interface AmazonCloudSearch
request
- Container for the parameters to the UpdateAvailabilityOptions
operation. Specifies the
name of the domain you want to update and the Multi-AZ availability option.public UpdateDomainEndpointOptionsResult updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest request)
AmazonCloudSearch
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
updateDomainEndpointOptions
in interface AmazonCloudSearch
request
- Container for the parameters to the UpdateDomainEndpointOptions
operation. Specifies
the name of the domain you want to update and the domain endpoint options.public UpdateScalingParametersResult updateScalingParameters(UpdateScalingParametersRequest request)
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.
updateScalingParameters
in interface AmazonCloudSearch
request
- Container for the parameters to the UpdateScalingParameters
operation. Specifies the
name of the domain you want to update and the scaling parameters you want to configure.public UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest request)
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.
updateServiceAccessPolicies
in interface AmazonCloudSearch
request
- Container for the parameters to the UpdateServiceAccessPolicies
operation. Specifies
the name of the domain you want to update and the access rules you want to configure.public void shutdown()
AmazonCloudSearch
shutdown
in interface AmazonCloudSearch
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCloudSearch
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.
getCachedResponseMetadata
in interface AmazonCloudSearch
request
- The originally executed request.