com.amazon.paapi

Class AbstractProductAdvertisingAPI

java.lang.Object

com.amazon.paapi.AbstractProductAdvertisingAPI

All Implemented Interfaces:

ProductAdvertisingAPI

Direct Known Subclasses:

AbstractProductAdvertisingAPIAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractProductAdvertisingAPI
extends java.lang.Object
implements ProductAdvertisingAPI

Abstract implementation of ProductAdvertisingAPI. 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.amazon.paapi.ProductAdvertisingAPI

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProductAdvertisingAPI()

Method Summary

Modifier and Type	Method and Description
com.amazonaws.ResponseMetadata	getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetRecommendationsResult	getRecommendations(GetRecommendationsRequest request) GetRecommendations operation allows associates to retrieve a set of product recommendations from Amazon catalog complementary to the input content in JSON format.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://webservices.amazon.com/").
void	setRegion(com.amazonaws.regions.Region region) An alternative to ProductAdvertisingAPI.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractProductAdvertisingAPI

protected AbstractProductAdvertisingAPI()

Method Detail

setEndpoint

public void setEndpoint(java.lang.String endpoint)

Description copied from interface: ProductAdvertisingAPI

Overrides the default endpoint for this client ("https://webservices.amazon.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "webservices.amazon.com/") or a full URL, including the protocol (ex: "https://webservices.amazon.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 ProductAdvertisingAPI

Parameters:

endpoint - The endpoint (ex: "webservices.amazon.com/") or a full URL, including the protocol (ex: "https://webservices.amazon.com/") of the region specific AWS endpoint this client will communicate with.

setRegion

public void setRegion(com.amazonaws.regions.Region region)

Description copied from interface: ProductAdvertisingAPI

An alternative to ProductAdvertisingAPI.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 ProductAdvertisingAPI

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)

getRecommendations

public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)

Description copied from interface: ProductAdvertisingAPI

GetRecommendations operation allows associates to retrieve a set of product recommendations from Amazon catalog complementary to the input content in JSON format.

Specified by:

getRecommendations in interface ProductAdvertisingAPI

Parameters:

request - It contains request parameters for the GetRecommendations operation. You can specify up to X number of parameters for each request. Specify the parameters in JSON as part of the body of the request.

Returns:

Result of the GetRecommendations operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: ProductAdvertisingAPI

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 ProductAdvertisingAPI

getCachedResponseMetadata

public com.amazonaws.ResponseMetadata getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request)

Description copied from interface: ProductAdvertisingAPI

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 ProductAdvertisingAPI

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.