GenerateDataSetRequest (AWS Java SDK :: Services :: AWS Marketplace Commerce Analytics 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.marketplacecommerceanalytics.model.MarketplaceCommerceAnalyticsRequest
    - - software.amazon.awssdk.services.marketplacecommerceanalytics.model.GenerateDataSetRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>

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

Container for the parameters to the GenerateDataSet operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GenerateDataSetRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GenerateDataSetRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`Instant`	`dataSetPublicationDate()` The date a data set was published.
`DataSetType`	`dataSetType()` The desired data set type.
`String`	`dataSetTypeAsString()` 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCustomerDefinedValues()` For responses, this returns true if the service returned a value for the CustomerDefinedValues property.
`int`	`hashCode()`
`String`	`roleNameArn()` The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
`List<SdkField<?>>`	`sdkFields()`
`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()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - dataSetType
```
public final 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!
    If the service returns an enum value that is not available in the current SDK version, dataSetType will return DataSetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataSetTypeAsString().
    Returns:
    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!
    See Also:
    
    DataSetType
  - dataSetTypeAsString
```
public final String dataSetTypeAsString()
```
    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!
    If the service returns an enum value that is not available in the current SDK version, dataSetType will return DataSetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataSetTypeAsString().
    Returns:
    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!
    See Also:
    
    DataSetType
  - dataSetPublicationDate
```
public final 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).
    
    Returns:
    
    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).
  - roleNameArn
```
public final 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 final 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 final 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 final 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.
  - hasCustomerDefinedValues
```
public final boolean hasCustomerDefinedValues()
```
    For responses, this returns true if the service returned a value for the CustomerDefinedValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - customerDefinedValues
```
public final 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomerDefinedValues() method.
    
    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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>
    
    Specified by:
    
    toBuilder in class MarketplaceCommerceAnalyticsRequest
  - builder
```
public static GenerateDataSetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GenerateDataSetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GenerateDataSetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

dataSetType

dataSetTypeAsString

dataSetPublicationDate

roleNameArn

destinationS3BucketName

destinationS3Prefix

snsTopicArn

hasCustomerDefinedValues

customerDefinedValues

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields