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

@Generated("software.amazon.awssdk:codegen") public final class GenerateDataSetRequest extends MarketplaceCommerceAnalyticsRequest implements ToCopyableBuilder<GenerateDataSetRequest.Builder,GenerateDataSetRequest>
Container for the parameters to the GenerateDataSet operation.
  • Method Details

    • 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:
    • 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:
    • 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()
      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>
      Specified by:
      toBuilder in class MarketplaceCommerceAnalyticsRequest
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.