Class AbstractAWSElasticsearch
- All Implemented Interfaces:
AWSElasticsearch
- Direct Known Subclasses:
AbstractAWSElasticsearchAsync
AWSElasticsearch
. 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 TypeMethodDescriptionaddTags
(AddTagsRequest request) Attaches tags to an existing Elasticsearch domain.Creates a new Elasticsearch domain.Permanently deletes the specified Elasticsearch domain and all of its data.Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.listDomainNames
(ListDomainNamesRequest request) Returns the name of all Elasticsearch domains owned by the current user's account.listTags
(ListTagsRequest request) Returns all tags for the given Elasticsearch domain.removeTags
(RemoveTagsRequest request) Removes the specified set of tags from the specified Elasticsearch domain.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://es.us-east-1.amazonaws.com").void
An alternative toAWSElasticsearch.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.Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
-
Constructor Details
-
AbstractAWSElasticsearch
protected AbstractAWSElasticsearch()
-
-
Method Details
-
setEndpoint
Description copied from interface:AWSElasticsearch
Overrides the default endpoint for this client ("https://es.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: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://es.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 interfaceAWSElasticsearch
- Parameters:
endpoint
- The endpoint (ex: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://es.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AWSElasticsearch
An alternative toAWSElasticsearch.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 interfaceAWSElasticsearch
- 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:
-
addTags
Description copied from interface:AWSElasticsearch
Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
- Specified by:
addTags
in interfaceAWSElasticsearch
- Parameters:
request
- Container for the parameters to theAddTags
operation. Specify the tags that you want to attach to the Elasticsearch domain.- Returns:
- Result of the AddTags operation returned by the service.
-
createElasticsearchDomain
public CreateElasticsearchDomainResult createElasticsearchDomain(CreateElasticsearchDomainRequest request) Description copied from interface:AWSElasticsearch
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
- Specified by:
createElasticsearchDomain
in interfaceAWSElasticsearch
- Parameters:
request
-- Returns:
- Result of the CreateElasticsearchDomain operation returned by the service.
-
deleteElasticsearchDomain
public DeleteElasticsearchDomainResult deleteElasticsearchDomain(DeleteElasticsearchDomainRequest request) Description copied from interface:AWSElasticsearch
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
- Specified by:
deleteElasticsearchDomain
in interfaceAWSElasticsearch
- Parameters:
request
- Container for the parameters to theDeleteElasticsearchDomain
operation. Specifies the name of the Elasticsearch domain that you want to delete.- Returns:
- Result of the DeleteElasticsearchDomain operation returned by the service.
-
describeElasticsearchDomain
public DescribeElasticsearchDomainResult describeElasticsearchDomain(DescribeElasticsearchDomainRequest request) Description copied from interface:AWSElasticsearch
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
- Specified by:
describeElasticsearchDomain
in interfaceAWSElasticsearch
- Parameters:
request
- Container for the parameters to theDescribeElasticsearchDomain
operation.- Returns:
- Result of the DescribeElasticsearchDomain operation returned by the service.
-
describeElasticsearchDomainConfig
public DescribeElasticsearchDomainConfigResult describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest request) Description copied from interface:AWSElasticsearch
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
- Specified by:
describeElasticsearchDomainConfig
in interfaceAWSElasticsearch
- Parameters:
request
- Container for the parameters to theDescribeElasticsearchDomainConfig
operation. Specifies the domain name for which you want configuration information.- Returns:
- Result of the DescribeElasticsearchDomainConfig operation returned by the service.
-
describeElasticsearchDomains
public DescribeElasticsearchDomainsResult describeElasticsearchDomains(DescribeElasticsearchDomainsRequest request) Description copied from interface:AWSElasticsearch
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
- Specified by:
describeElasticsearchDomains
in interfaceAWSElasticsearch
- Parameters:
request
- Container for the parameters to theDescribeElasticsearchDomains
operation. By default, the API returns the status of all Elasticsearch domains.- Returns:
- Result of the DescribeElasticsearchDomains operation returned by the service.
-
listDomainNames
Description copied from interface:AWSElasticsearch
Returns the name of all Elasticsearch domains owned by the current user's account.
- Specified by:
listDomainNames
in interfaceAWSElasticsearch
- Parameters:
request
-- Returns:
- Result of the ListDomainNames operation returned by the service.
-
listTags
Description copied from interface:AWSElasticsearch
Returns all tags for the given Elasticsearch domain.
- Specified by:
listTags
in interfaceAWSElasticsearch
- Parameters:
request
- Container for the parameters to theListTags
operation. Specify theARN
for the Elasticsearch domain to which the tags are attached that you want to view are attached.- Returns:
- Result of the ListTags operation returned by the service.
-
removeTags
Description copied from interface:AWSElasticsearch
Removes the specified set of tags from the specified Elasticsearch domain.
- Specified by:
removeTags
in interfaceAWSElasticsearch
- Parameters:
request
- Container for the parameters to theRemoveTags
operation. Specify theARN
for the Elasticsearch domain from which you want to remove the specifiedTagKey
.- Returns:
- Result of the RemoveTags operation returned by the service.
-
updateElasticsearchDomainConfig
public UpdateElasticsearchDomainConfigResult updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest request) Description copied from interface:AWSElasticsearch
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
- Specified by:
updateElasticsearchDomainConfig
in interfaceAWSElasticsearch
- Parameters:
request
- Container for the parameters to theUpdateElasticsearchDomain
operation. Specifies the type and number of instances in the domain cluster.- Returns:
- Result of the UpdateElasticsearchDomainConfig operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AWSElasticsearch
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 interfaceAWSElasticsearch
-
getCachedResponseMetadata
Description copied from interface:AWSElasticsearch
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 interfaceAWSElasticsearch
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-