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

Interface GenerateDataSetRequest.Builder

All Superinterfaces:

CopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>, SdkBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>

Enclosing class:

GenerateDataSetRequest

public static interface GenerateDataSetRequest.Builder
extends CopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>

Method Summary

Modifier and Type	Method	Description
GenerateDataSetRequest.Builder	customerDefinedValues(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.
GenerateDataSetRequest.Builder	dataSetPublicationDate(Date dataSetPublicationDate)	The date a data set was published.
GenerateDataSetRequest.Builder	dataSetType(String dataSetType)	The desired data set type.
GenerateDataSetRequest.Builder	dataSetType(DataSetType dataSetType)	The desired data set type.
GenerateDataSetRequest.Builder	destinationS3BucketName(String destinationS3BucketName)	The name (friendly name, not ARN) of the destination S3 bucket.
GenerateDataSetRequest.Builder	destinationS3Prefix(String destinationS3Prefix)	(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.
GenerateDataSetRequest.Builder	roleNameArn(String roleNameArn)	The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
GenerateDataSetRequest.Builder	snsTopicArn(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.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

dataSetType

GenerateDataSetRequest.Builder dataSetType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSetType

dataSetType

GenerateDataSetRequest.Builder dataSetType(DataSetType 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSetType

dataSetPublicationDate

GenerateDataSetRequest.Builder dataSetPublicationDate(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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

roleNameArn

GenerateDataSetRequest.Builder roleNameArn(String roleNameArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationS3BucketName

GenerateDataSetRequest.Builder destinationS3BucketName(String destinationS3BucketName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationS3Prefix

GenerateDataSetRequest.Builder destinationS3Prefix(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

snsTopicArn

GenerateDataSetRequest.Builder snsTopicArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

customerDefinedValues

GenerateDataSetRequest.Builder customerDefinedValues(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.