Class AbstractAWSElasticsearch

  • All Implemented Interfaces:
    AWSElasticsearch
    Direct Known Subclasses:
    AbstractAWSElasticsearchAsync

    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.
    • Constructor Detail

      • AbstractAWSElasticsearch

        protected AbstractAWSElasticsearch()
    • 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.
      • 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.
      • 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.
      • 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.