Class AbstractAWSMarketplaceCommerceAnalytics
- java.lang.Object
-
- com.amazonaws.services.marketplacecommerceanalytics.AbstractAWSMarketplaceCommerceAnalytics
-
- All Implemented Interfaces:
AWSMarketplaceCommerceAnalytics
- Direct Known Subclasses:
AbstractAWSMarketplaceCommerceAnalyticsAsync
public class AbstractAWSMarketplaceCommerceAnalytics extends Object implements AWSMarketplaceCommerceAnalytics
Abstract implementation ofAWSMarketplaceCommerceAnalytics
. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAWSMarketplaceCommerceAnalytics()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GenerateDataSetResult
generateDataSet(GenerateDataSetRequest request)
Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available.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.void
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://marketplacecommerceanalytics.us-east-1.amazonaws.com").void
setRegion(Region region)
An alternative toAWSMarketplaceCommerceAnalytics.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.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AWSMarketplaceCommerceAnalytics
Overrides the default endpoint for this client ("https://marketplacecommerceanalytics.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: "marketplacecommerceanalytics.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://marketplacecommerceanalytics.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 interfaceAWSMarketplaceCommerceAnalytics
- Parameters:
endpoint
- The endpoint (ex: "marketplacecommerceanalytics.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://marketplacecommerceanalytics.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:AWSMarketplaceCommerceAnalytics
An alternative toAWSMarketplaceCommerceAnalytics.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 interfaceAWSMarketplaceCommerceAnalytics
- 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:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
generateDataSet
public GenerateDataSetResult generateDataSet(GenerateDataSetRequest request)
Description copied from interface:AWSMarketplaceCommerceAnalytics
Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.- Specified by:
generateDataSet
in interfaceAWSMarketplaceCommerceAnalytics
- Parameters:
request
- Container for the parameters to the GenerateDataSet operation.- Returns:
- Result of the GenerateDataSet operation returned by the service.
-
shutdown
public void shutdown()
Description copied from interface:AWSMarketplaceCommerceAnalytics
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 interfaceAWSMarketplaceCommerceAnalytics
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AWSMarketplaceCommerceAnalytics
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 interfaceAWSMarketplaceCommerceAnalytics
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-