Package software.amazon.awssdk.services.marketplacecommerceanalytics.model

Class GenerateDataSetRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.marketplacecommerceanalytics.model.GenerateDataSetRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>

@Generated("software.amazon.awssdk:codegen")
public class GenerateDataSetRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>

Container for the parameters to the GenerateDataSet operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerateDataSetRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GenerateDataSetRequest.Builder	builder()
Map<String,String>	customerDefinedValues()	(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
Date	dataSetPublicationDate()	The date a data set was published.
String	dataSetType()	The desired data set type.
String	destinationS3BucketName()	The name (friendly name, not ARN) of the destination S3 bucket.
String	destinationS3Prefix()	(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.
boolean	equals(Object obj)
int	hashCode()
String	roleNameArn()	The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
static Class<? extends GenerateDataSetRequest.Builder>	serializableBuilderClass()
String	snsTopicArn()	Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.
GenerateDataSetRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dataSetType

public String dataSetType()

The desired data set type.

• customer_subscriber_hourly_monthly_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.
• customer_subscriber_annual_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.
• daily_business_usage_by_instance_type - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_fees - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_free_trial_conversions - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_new_instances - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_new_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_canceled_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• monthly_revenue_billing_and_revenue_data - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
• monthly_revenue_annual_subscriptions - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
• disbursed_amount_by_product - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
• disbursed_amount_by_product_with_uncollected_funds -This data set is only available from 2012-04-19 until 2015-01-25. After 2015-01-25, this data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.
• disbursed_amount_by_instance_hours - Available every 30 days by 5:00 PM Pacific Time since 2012-09-04.
• disbursed_amount_by_customer_geo - Available every 30 days by 5:00 PM Pacific Time since 2012-04-19.
• disbursed_amount_by_age_of_uncollected_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
• disbursed_amount_by_age_of_disbursed_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
• customer_profile_by_industry - Available daily by 5:00 PM Pacific Time since 2015-10-01.
• customer_profile_by_revenue - Available daily by 5:00 PM Pacific Time since 2015-10-01.
• customer_profile_by_geography - Available daily by 5:00 PM Pacific Time since 2015-10-01.
• sales_compensation_billed_revenue - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2016-12.
• us_sales_and_use_tax_records - Available monthly on the 15th day of the month by 5:00 PM Pacific Time since 2017-02-15.

Returns:

The desired data set type.

• customer_subscriber_hourly_monthly_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.
• customer_subscriber_annual_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.
• daily_business_usage_by_instance_type - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_fees - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_free_trial_conversions - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_new_instances - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_new_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• daily_business_canceled_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.
• monthly_revenue_billing_and_revenue_data - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
• monthly_revenue_annual_subscriptions - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
• disbursed_amount_by_product - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
• disbursed_amount_by_product_with_uncollected_funds -This data set is only available from 2012-04-19 until 2015-01-25. After 2015-01-25, this data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.
• disbursed_amount_by_instance_hours - Available every 30 days by 5:00 PM Pacific Time since 2012-09-04.
• disbursed_amount_by_customer_geo - Available every 30 days by 5:00 PM Pacific Time since 2012-04-19.
• disbursed_amount_by_age_of_uncollected_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
• disbursed_amount_by_age_of_disbursed_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
• customer_profile_by_industry - Available daily by 5:00 PM Pacific Time since 2015-10-01.
• customer_profile_by_revenue - Available daily by 5:00 PM Pacific Time since 2015-10-01.
• customer_profile_by_geography - Available daily by 5:00 PM Pacific Time since 2015-10-01.
• sales_compensation_billed_revenue - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2016-12.
• us_sales_and_use_tax_records - Available monthly on the 15th day of the month by 5:00 PM Pacific Time since 2017-02-15.

See Also:

DataSetType

dataSetPublicationDate

public Date dataSetPublicationDate()

The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored).

Returns:

The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored).

roleNameArn

public String roleNameArn()

The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

Returns:

The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

destinationS3BucketName

public String destinationS3BucketName()

The name (friendly name, not ARN) of the destination S3 bucket.

Returns:

The name (friendly name, not ARN) of the destination S3 bucket.

destinationS3Prefix

public String destinationS3Prefix()

(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.

Returns:

(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.

snsTopicArn

public String snsTopicArn()

Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

Returns:

Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

customerDefinedValues

public Map<String,String> customerDefinedValues()

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems.

Returns:

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems.

toBuilder

public GenerateDataSetRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>

Returns:

a builder for type T

builder

public static GenerateDataSetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GenerateDataSetRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object