GenerateDataSetRequest.Builder (AWS Java SDK :: Services :: AWS Marketplace Commerce Analytics 2.20.149 API)

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>, MarketplaceCommerceAnalyticsRequest.Builder, SdkBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GenerateDataSetRequest
```
public static interface GenerateDataSetRequest.Builder
extends MarketplaceCommerceAnalyticsRequest.Builder, SdkPojo, CopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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(Instant dataSetPublicationDate)` The date a data set was published.
`GenerateDataSetRequest.Builder`	`dataSetType(DataSetType dataSetType)` The desired data set type.
`GenerateDataSetRequest.Builder`	`dataSetType(String 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`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`GenerateDataSetRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`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.services.marketplacecommerceanalytics.model.MarketplaceCommerceAnalyticsRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - dataSetType
```
GenerateDataSetRequest.Builder dataSetType(String dataSetType)
```
    The desired data set type.
    - customer_subscriber_hourly_monthly_subscriptions
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - customer_subscriber_annual_subscriptions
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_usage_by_instance_type
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_fees
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_free_trial_conversions
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_new_instances
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_new_product_subscribers
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_canceled_product_subscribers
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - monthly_revenue_billing_and_revenue_data
      From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.
    - monthly_revenue_annual_subscriptions
      From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.
    - monthly_revenue_field_demonstration_usage
      From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    - monthly_revenue_flexible_payment_schedule
      From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    - disbursed_amount_by_product
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_instance_hours
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_customer_geo
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_age_of_uncollected_funds
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_age_of_disbursed_funds
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_age_of_past_due_funds
      From 2018-04-07 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_uncollected_funds_breakdown
      From 2019-10-04 to present: Available every 30 days by 24:00 UTC.
    - sales_compensation_billed_revenue
      From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.
    - us_sales_and_use_tax_records
      From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    - disbursed_amount_by_product_with_uncollected_funds
      This data set is deprecated. Download related reports from AMMP instead!
    - customer_profile_by_industry
      This data set is deprecated. Download related reports from AMMP instead!
    - customer_profile_by_revenue
      This data set is deprecated. Download related reports from AMMP instead!
    - customer_profile_by_geography
      This data set is deprecated. Download related reports from AMMP instead!
    Parameters:
    dataSetType - The desired data set type.
    
    customer_subscriber_hourly_monthly_subscriptions
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    customer_subscriber_annual_subscriptions
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_usage_by_instance_type
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_fees
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_free_trial_conversions
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_new_instances
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_new_product_subscribers
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_canceled_product_subscribers
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    monthly_revenue_billing_and_revenue_data
    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.
    
    monthly_revenue_annual_subscriptions
    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.
    
    monthly_revenue_field_demonstration_usage
    From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    
    monthly_revenue_flexible_payment_schedule
    From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    
    disbursed_amount_by_product
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_instance_hours
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_customer_geo
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_age_of_uncollected_funds
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_age_of_disbursed_funds
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_age_of_past_due_funds
    From 2018-04-07 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_uncollected_funds_breakdown
    From 2019-10-04 to present: Available every 30 days by 24:00 UTC.
    
    sales_compensation_billed_revenue
    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.
    
    us_sales_and_use_tax_records
    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    
    disbursed_amount_by_product_with_uncollected_funds
    This data set is deprecated. Download related reports from AMMP instead!
    
    customer_profile_by_industry
    This data set is deprecated. Download related reports from AMMP instead!
    
    customer_profile_by_revenue
    This data set is deprecated. Download related reports from AMMP instead!
    
    customer_profile_by_geography
    This data set is deprecated. Download related reports from AMMP instead!
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSetType, DataSetType
  - dataSetType
```
GenerateDataSetRequest.Builder dataSetType(DataSetType dataSetType)
```
    The desired data set type.
    - customer_subscriber_hourly_monthly_subscriptions
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - customer_subscriber_annual_subscriptions
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_usage_by_instance_type
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_fees
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_free_trial_conversions
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_new_instances
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_new_product_subscribers
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - daily_business_canceled_product_subscribers
      From 2017-09-15 to present: Available daily by 24:00 UTC.
    - monthly_revenue_billing_and_revenue_data
      From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.
    - monthly_revenue_annual_subscriptions
      From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.
    - monthly_revenue_field_demonstration_usage
      From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    - monthly_revenue_flexible_payment_schedule
      From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    - disbursed_amount_by_product
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_instance_hours
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_customer_geo
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_age_of_uncollected_funds
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_age_of_disbursed_funds
      From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_age_of_past_due_funds
      From 2018-04-07 to present: Available every 30 days by 24:00 UTC.
    - disbursed_amount_by_uncollected_funds_breakdown
      From 2019-10-04 to present: Available every 30 days by 24:00 UTC.
    - sales_compensation_billed_revenue
      From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.
    - us_sales_and_use_tax_records
      From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    - disbursed_amount_by_product_with_uncollected_funds
      This data set is deprecated. Download related reports from AMMP instead!
    - customer_profile_by_industry
      This data set is deprecated. Download related reports from AMMP instead!
    - customer_profile_by_revenue
      This data set is deprecated. Download related reports from AMMP instead!
    - customer_profile_by_geography
      This data set is deprecated. Download related reports from AMMP instead!
    Parameters:
    dataSetType - The desired data set type.
    
    customer_subscriber_hourly_monthly_subscriptions
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    customer_subscriber_annual_subscriptions
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_usage_by_instance_type
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_fees
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_free_trial_conversions
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_new_instances
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_new_product_subscribers
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    daily_business_canceled_product_subscribers
    From 2017-09-15 to present: Available daily by 24:00 UTC.
    
    monthly_revenue_billing_and_revenue_data
    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.
    
    monthly_revenue_annual_subscriptions
    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.
    
    monthly_revenue_field_demonstration_usage
    From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    
    monthly_revenue_flexible_payment_schedule
    From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    
    disbursed_amount_by_product
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_instance_hours
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_customer_geo
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_age_of_uncollected_funds
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_age_of_disbursed_funds
    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_age_of_past_due_funds
    From 2018-04-07 to present: Available every 30 days by 24:00 UTC.
    
    disbursed_amount_by_uncollected_funds_breakdown
    From 2019-10-04 to present: Available every 30 days by 24:00 UTC.
    
    sales_compensation_billed_revenue
    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.
    
    us_sales_and_use_tax_records
    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
    
    disbursed_amount_by_product_with_uncollected_funds
    This data set is deprecated. Download related reports from AMMP instead!
    
    customer_profile_by_industry
    This data set is deprecated. Download related reports from AMMP instead!
    
    customer_profile_by_revenue
    This data set is deprecated. Download related reports from AMMP instead!
    
    customer_profile_by_geography
    This data set is deprecated. Download related reports from AMMP instead!
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataSetType, DataSetType
  - dataSetPublicationDate
```
GenerateDataSetRequest.Builder dataSetPublicationDate(Instant dataSetPublicationDate)
```
    The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For monthly data sets except those with prefix disbursed_amount, provide a date with month-level granularity for the desired month (the day value will be ignored). For data sets with prefix disbursed_amount, provide a date with day-level granularity for the desired day. For these data sets we will look backwards in time over the range of 31 days until the first data set is found (the latest one).
    
    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 monthly data sets except those with prefix disbursed_amount, provide a date with month-level granularity for the desired month (the day value will be ignored). For data sets with prefix disbursed_amount, provide a date with day-level granularity for the desired day. For these data sets we will look backwards in time over the range of 31 days until the first data set is found (the latest one).
    
    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.
  - overrideConfiguration
```
GenerateDataSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
GenerateDataSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface GenerateDataSetRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.marketplacecommerceanalytics.model.MarketplaceCommerceAnalyticsRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

dataSetType

dataSetType

dataSetPublicationDate

roleNameArn

destinationS3BucketName

destinationS3Prefix

snsTopicArn

customerDefinedValues

overrideConfiguration

overrideConfiguration