com.amazon.paapi

Class ProductAdvertisingAPIAsyncClient

java.lang.Object

AmazonWebServiceClient

com.amazon.paapi.ProductAdvertisingAPIClient

com.amazon.paapi.ProductAdvertisingAPIAsyncClient

All Implemented Interfaces:

ProductAdvertisingAPI, ProductAdvertisingAPIAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProductAdvertisingAPIAsyncClient
extends ProductAdvertisingAPIClient
implements ProductAdvertisingAPIAsync

Client for accessing ProductAdvertisingAPI asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

The Product Advertising API provides programmatic access to Amazon’s product selection and discovery functionality so that developers like you can advertise Amazon products to monetize your website. The Product Advertising API helps you advertise Amazon products using product search and look up capability, product information and features such as Customer Reviews, Similar Products, Wish Lists and New and Used listings.

Field Summary

Fields inherited from class com.amazon.paapi.ProductAdvertisingAPIClient

configFactory

Fields inherited from interface com.amazon.paapi.ProductAdvertisingAPI

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
ProductAdvertisingAPIAsyncClient() Deprecated. use ProductAdvertisingAPIAsyncClientBuilder.defaultClient()
ProductAdvertisingAPIAsyncClient(AWSCredentials awsCredentials) Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider)
ProductAdvertisingAPIAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withClientConfiguration(ClientConfiguration) and ProductAdvertisingAPIAsyncClientBuilder#withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
ProductAdvertisingAPIAsyncClient(AWSCredentials awsCredentials, java.util.concurrent.ExecutorService executorService) Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
ProductAdvertisingAPIAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider)
ProductAdvertisingAPIAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withClientConfiguration(ClientConfiguration)
ProductAdvertisingAPIAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withClientConfiguration(ClientConfiguration) and ProductAdvertisingAPIAsyncClientBuilder#withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
ProductAdvertisingAPIAsyncClient(AWSCredentialsProvider awsCredentialsProvider, java.util.concurrent.ExecutorService executorService) Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
ProductAdvertisingAPIAsyncClient(ClientConfiguration clientConfiguration) Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static ProductAdvertisingAPIAsyncClientBuilder	asyncBuilder()
java.util.concurrent.ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
java.util.concurrent.Future<GetRecommendationsResult>	getRecommendationsAsync(GetRecommendationsRequest request) GetRecommendations operation allows associates to retrieve a set of product recommendations from Amazon catalog complementary to the input content in JSON format.
java.util.concurrent.Future<GetRecommendationsResult>	getRecommendationsAsync(GetRecommendationsRequest request, <any> asyncHandler) GetRecommendations operation allows associates to retrieve a set of product recommendations from Amazon catalog complementary to the input content in JSON format.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazon.paapi.ProductAdvertisingAPIClient

builder, getCachedResponseMetadata, getRecommendations

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazon.paapi.ProductAdvertisingAPI

getCachedResponseMetadata, getRecommendations, setEndpoint, setRegion

Constructor Detail

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient()

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder.defaultClient()

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

com.amazonaws.auth.DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient(ClientConfiguration clientConfiguration)

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withClientConfiguration(ClientConfiguration)

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to ProductAdvertisingAPI (ex: proxy settings, retry counts, etc).

See Also:

com.amazonaws.auth.DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient(AWSCredentials awsCredentials)

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

See Also:

Executors.newFixedThreadPool(int)

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient(AWSCredentials awsCredentials,
                                                    java.util.concurrent.ExecutorService executorService)

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient(AWSCredentials awsCredentials,
                                                    ClientConfiguration clientConfiguration,
                                                    java.util.concurrent.ExecutorService executorService)

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withClientConfiguration(ClientConfiguration) and ProductAdvertisingAPIAsyncClientBuilder#withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials, executor service, and client configuration options.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

See Also:

Executors.newFixedThreadPool(int)

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                                    ClientConfiguration clientConfiguration)

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withClientConfiguration(ClientConfiguration)

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI using the provided AWS account credentials provider and client configuration options.

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

See Also:

com.amazonaws.auth.DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                                    java.util.concurrent.ExecutorService executorService)

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

ProductAdvertisingAPIAsyncClient

@Deprecated
public ProductAdvertisingAPIAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                                    ClientConfiguration clientConfiguration,
                                                    java.util.concurrent.ExecutorService executorService)

Deprecated. use ProductAdvertisingAPIAsyncClientBuilder#withCredentials(AWSCredentialsProvider) and ProductAdvertisingAPIAsyncClientBuilder#withClientConfiguration(ClientConfiguration) and ProductAdvertisingAPIAsyncClientBuilder#withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on ProductAdvertisingAPI using the specified AWS account credentials provider, executor service, and client configuration options.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

asyncBuilder

public static ProductAdvertisingAPIAsyncClientBuilder asyncBuilder()

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

getRecommendationsAsync

public java.util.concurrent.Future<GetRecommendationsResult> getRecommendationsAsync(GetRecommendationsRequest request)

Description copied from interface: ProductAdvertisingAPIAsync

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

Specified by:

getRecommendationsAsync in interface ProductAdvertisingAPIAsync

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:

A Java Future containing the result of the GetRecommendations operation returned by the service.

See Also:

AWS API Documentation

getRecommendationsAsync

public java.util.concurrent.Future<GetRecommendationsResult> getRecommendationsAsync(GetRecommendationsRequest request,
                                                                                     <any> asyncHandler)

Description copied from interface: ProductAdvertisingAPIAsync

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

Specified by:

getRecommendationsAsync in interface ProductAdvertisingAPIAsync

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.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetRecommendations operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface ProductAdvertisingAPI