AbstractAWSElasticsearch (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticsearch.AbstractAWSElasticsearch

All Implemented Interfaces:

AWSElasticsearch

Direct Known Subclasses:

AbstractAWSElasticsearchAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSElasticsearch
extends Object
implements AWSElasticsearch
```
Abstract implementation of AWSElasticsearch. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.elasticsearch.AWSElasticsearch
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddTagsResult`	`addTags(AddTagsRequest request)` Attaches tags to an existing Elasticsearch domain.
`CreateElasticsearchDomainResult`	`createElasticsearchDomain(CreateElasticsearchDomainRequest request)` Creates a new Elasticsearch domain.
`DeleteElasticsearchDomainResult`	`deleteElasticsearchDomain(DeleteElasticsearchDomainRequest request)` Permanently deletes the specified Elasticsearch domain and all of its data.
`DeleteElasticsearchServiceRoleResult`	`deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest request)` Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
`DescribeElasticsearchDomainResult`	`describeElasticsearchDomain(DescribeElasticsearchDomainRequest request)` Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
`DescribeElasticsearchDomainConfigResult`	`describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest request)` Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
`DescribeElasticsearchDomainsResult`	`describeElasticsearchDomains(DescribeElasticsearchDomainsRequest request)` Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
`DescribeElasticsearchInstanceTypeLimitsResult`	`describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest request)` Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
`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.
`ListDomainNamesResult`	`listDomainNames(ListDomainNamesRequest request)` Returns the name of all Elasticsearch domains owned by the current user's account.
`ListElasticsearchInstanceTypesResult`	`listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest request)` List all Elasticsearch instance types that are supported for given ElasticsearchVersion
`ListElasticsearchVersionsResult`	`listElasticsearchVersions(ListElasticsearchVersionsRequest request)` List all supported Elasticsearch versions
`ListTagsResult`	`listTags(ListTagsRequest request)` Returns all tags for the given Elasticsearch domain.
`RemoveTagsResult`	`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`	`setRegion(Region region)` An alternative to `AWSElasticsearch.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.
`UpdateElasticsearchDomainConfigResult`	`updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest request)` Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    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 interface AWSElasticsearch
    
    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
```
public void setRegion(Region region)
```
    Description copied from interface: AWSElasticsearch
    
    An alternative to AWSElasticsearch.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 interface AWSElasticsearch
    
    Parameters:
    
    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.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addTags
```
public AddTagsResult addTags(AddTagsRequest request)
```
    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 interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the AddTags 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 interface AWSElasticsearch
    
    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 interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.
    
    Returns:
    
    Result of the DeleteElasticsearchDomain operation returned by the service.
  - deleteElasticsearchServiceRole
```
public DeleteElasticsearchServiceRoleResult deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
    
    Specified by:
    
    deleteElasticsearchServiceRole in interface AWSElasticsearch
    
    Returns:
    
    Result of the DeleteElasticsearchServiceRole 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 interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeElasticsearchDomain 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 interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeElasticsearchDomainConfig 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 interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.
    
    Returns:
    
    Result of the DescribeElasticsearchDomains operation returned by the service.
  - describeElasticsearchInstanceTypeLimits
```
public DescribeElasticsearchInstanceTypeLimitsResult describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
    
    Specified by:
    
    describeElasticsearchInstanceTypeLimits in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.
    
    Returns:
    
    Result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.
  - listDomainNames
```
public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns the name of all Elasticsearch domains owned by the current user's account.
    
    Specified by:
    
    listDomainNames in interface AWSElasticsearch
    
    Returns:
    
    Result of the ListDomainNames operation returned by the service.
  - listElasticsearchInstanceTypes
```
public ListElasticsearchInstanceTypesResult listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    List all Elasticsearch instance types that are supported for given ElasticsearchVersion
    
    Specified by:
    
    listElasticsearchInstanceTypes in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the ListElasticsearchInstanceTypes operation.
    
    Returns:
    
    Result of the ListElasticsearchInstanceTypes operation returned by the service.
  - listElasticsearchVersions
```
public ListElasticsearchVersionsResult listElasticsearchVersions(ListElasticsearchVersionsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    List all supported Elasticsearch versions
    
    Specified by:
    
    listElasticsearchVersions in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the ListElasticsearchVersions operation.
    Use MaxResults to control the maximum number of results to retrieve in a single call.
    
    Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.
    
    Returns:
    
    Result of the ListElasticsearchVersions operation returned by the service.
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns all tags for the given Elasticsearch domain.
    
    Specified by:
    
    listTags in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the ListTags operation. Specify the ARN 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
```
public RemoveTagsResult removeTags(RemoveTagsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Removes the specified set of tags from the specified Elasticsearch domain.
    
    Specified by:
    
    removeTags in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.
    
    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 interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the UpdateElasticsearchDomain 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 interface AWSElasticsearch
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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 interface AWSElasticsearch
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSElasticsearch

Field Summary

Fields inherited from interface com.amazonaws.services.elasticsearch.AWSElasticsearch

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addTags

createElasticsearchDomain

deleteElasticsearchDomain

deleteElasticsearchServiceRole

describeElasticsearchDomain

describeElasticsearchDomainConfig

describeElasticsearchDomains

describeElasticsearchInstanceTypeLimits

listDomainNames

listElasticsearchInstanceTypes

listElasticsearchVersions

listTags

removeTags

updateElasticsearchDomainConfig

shutdown

getCachedResponseMetadata