com.amazonaws.services.marketplacecommerceanalytics.model.GenerateDataSetRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-marketplacecommerceanalytics Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.marketplacecommerceanalytics.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the GenerateDataSet operation.
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GenerateDataSetRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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!
*
*
*
*
*/
private String dataSetType;
/**
* 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).
*/
private java.util.Date dataSetPublicationDate;
/**
* The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS
* services.
*/
private String roleNameArn;
/** The name (friendly name, not ARN) of the destination S3 bucket. */
private String destinationS3BucketName;
/**
* (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.
*/
private String destinationS3Prefix;
/**
* 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.
*/
private String snsTopicArn;
/**
* (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.
*/
private java.util.Map customerDefinedValues;
/**
*
* 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!
*
*
*
*
*
* @param 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!
*
*
*
* @see DataSetType
*/
public void setDataSetType(String dataSetType) {
this.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!
*
*
*
*
*
* @return 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 DataSetType
*/
public String getDataSetType() {
return this.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!
*
*
*
*
*
* @param 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!
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataSetType
*/
public GenerateDataSetRequest withDataSetType(String dataSetType) {
setDataSetType(dataSetType);
return this;
}
/**
*
* 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!
*
*
*
*
*
* @param 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!
*
*
*
* @see DataSetType
*/
public void setDataSetType(DataSetType dataSetType) {
withDataSetType(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!
*
*
*
*
*
* @param 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!
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataSetType
*/
public GenerateDataSetRequest withDataSetType(DataSetType dataSetType) {
this.dataSetType = dataSetType.toString();
return this;
}
/**
* 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).
*
* @param 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).
*/
public void setDataSetPublicationDate(java.util.Date dataSetPublicationDate) {
this.dataSetPublicationDate = 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).
*
* @return 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).
*/
public java.util.Date getDataSetPublicationDate() {
return this.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).
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataSetRequest withDataSetPublicationDate(java.util.Date dataSetPublicationDate) {
setDataSetPublicationDate(dataSetPublicationDate);
return this;
}
/**
* The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS
* services.
*
* @param roleNameArn
* The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the
* provided AWS services.
*/
public void setRoleNameArn(String roleNameArn) {
this.roleNameArn = roleNameArn;
}
/**
* The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS
* services.
*
* @return The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the
* provided AWS services.
*/
public String getRoleNameArn() {
return this.roleNameArn;
}
/**
* The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS
* services.
*
* @param roleNameArn
* The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the
* provided AWS services.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataSetRequest withRoleNameArn(String roleNameArn) {
setRoleNameArn(roleNameArn);
return this;
}
/**
* The name (friendly name, not ARN) of the destination S3 bucket.
*
* @param destinationS3BucketName
* The name (friendly name, not ARN) of the destination S3 bucket.
*/
public void setDestinationS3BucketName(String destinationS3BucketName) {
this.destinationS3BucketName = destinationS3BucketName;
}
/**
* The name (friendly name, not ARN) of the destination S3 bucket.
*
* @return The name (friendly name, not ARN) of the destination S3 bucket.
*/
public String getDestinationS3BucketName() {
return this.destinationS3BucketName;
}
/**
* The name (friendly name, not ARN) of the destination S3 bucket.
*
* @param destinationS3BucketName
* The name (friendly name, not ARN) of the destination S3 bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataSetRequest withDestinationS3BucketName(String destinationS3BucketName) {
setDestinationS3BucketName(destinationS3BucketName);
return this;
}
/**
* (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.
*
* @param 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.
*/
public void setDestinationS3Prefix(String destinationS3Prefix) {
this.destinationS3Prefix = 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.
*
* @return (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.
*/
public String getDestinationS3Prefix() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataSetRequest withDestinationS3Prefix(String destinationS3Prefix) {
setDestinationS3Prefix(destinationS3Prefix);
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setSnsTopicArn(String snsTopicArn) {
this.snsTopicArn = 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.
*
* @return 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.
*/
public String getSnsTopicArn() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataSetRequest withSnsTopicArn(String snsTopicArn) {
setSnsTopicArn(snsTopicArn);
return this;
}
/**
* (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.
*
* @return (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.
*/
public java.util.Map getCustomerDefinedValues() {
return 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.
*
* @param 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.
*/
public void setCustomerDefinedValues(java.util.Map customerDefinedValues) {
this.customerDefinedValues = 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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataSetRequest withCustomerDefinedValues(java.util.Map customerDefinedValues) {
setCustomerDefinedValues(customerDefinedValues);
return this;
}
/**
* Add a single CustomerDefinedValues entry
*
* @see GenerateDataSetRequest#withCustomerDefinedValues
* @returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataSetRequest addCustomerDefinedValuesEntry(String key, String value) {
if (null == this.customerDefinedValues) {
this.customerDefinedValues = new java.util.HashMap();
}
if (this.customerDefinedValues.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.customerDefinedValues.put(key, value);
return this;
}
/**
* Removes all the entries added into CustomerDefinedValues.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GenerateDataSetRequest clearCustomerDefinedValuesEntries() {
this.customerDefinedValues = null;
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDataSetType() != null)
sb.append("DataSetType: ").append(getDataSetType()).append(",");
if (getDataSetPublicationDate() != null)
sb.append("DataSetPublicationDate: ").append(getDataSetPublicationDate()).append(",");
if (getRoleNameArn() != null)
sb.append("RoleNameArn: ").append(getRoleNameArn()).append(",");
if (getDestinationS3BucketName() != null)
sb.append("DestinationS3BucketName: ").append(getDestinationS3BucketName()).append(",");
if (getDestinationS3Prefix() != null)
sb.append("DestinationS3Prefix: ").append(getDestinationS3Prefix()).append(",");
if (getSnsTopicArn() != null)
sb.append("SnsTopicArn: ").append(getSnsTopicArn()).append(",");
if (getCustomerDefinedValues() != null)
sb.append("CustomerDefinedValues: ").append(getCustomerDefinedValues());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GenerateDataSetRequest == false)
return false;
GenerateDataSetRequest other = (GenerateDataSetRequest) obj;
if (other.getDataSetType() == null ^ this.getDataSetType() == null)
return false;
if (other.getDataSetType() != null && other.getDataSetType().equals(this.getDataSetType()) == false)
return false;
if (other.getDataSetPublicationDate() == null ^ this.getDataSetPublicationDate() == null)
return false;
if (other.getDataSetPublicationDate() != null && other.getDataSetPublicationDate().equals(this.getDataSetPublicationDate()) == false)
return false;
if (other.getRoleNameArn() == null ^ this.getRoleNameArn() == null)
return false;
if (other.getRoleNameArn() != null && other.getRoleNameArn().equals(this.getRoleNameArn()) == false)
return false;
if (other.getDestinationS3BucketName() == null ^ this.getDestinationS3BucketName() == null)
return false;
if (other.getDestinationS3BucketName() != null && other.getDestinationS3BucketName().equals(this.getDestinationS3BucketName()) == false)
return false;
if (other.getDestinationS3Prefix() == null ^ this.getDestinationS3Prefix() == null)
return false;
if (other.getDestinationS3Prefix() != null && other.getDestinationS3Prefix().equals(this.getDestinationS3Prefix()) == false)
return false;
if (other.getSnsTopicArn() == null ^ this.getSnsTopicArn() == null)
return false;
if (other.getSnsTopicArn() != null && other.getSnsTopicArn().equals(this.getSnsTopicArn()) == false)
return false;
if (other.getCustomerDefinedValues() == null ^ this.getCustomerDefinedValues() == null)
return false;
if (other.getCustomerDefinedValues() != null && other.getCustomerDefinedValues().equals(this.getCustomerDefinedValues()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDataSetType() == null) ? 0 : getDataSetType().hashCode());
hashCode = prime * hashCode + ((getDataSetPublicationDate() == null) ? 0 : getDataSetPublicationDate().hashCode());
hashCode = prime * hashCode + ((getRoleNameArn() == null) ? 0 : getRoleNameArn().hashCode());
hashCode = prime * hashCode + ((getDestinationS3BucketName() == null) ? 0 : getDestinationS3BucketName().hashCode());
hashCode = prime * hashCode + ((getDestinationS3Prefix() == null) ? 0 : getDestinationS3Prefix().hashCode());
hashCode = prime * hashCode + ((getSnsTopicArn() == null) ? 0 : getSnsTopicArn().hashCode());
hashCode = prime * hashCode + ((getCustomerDefinedValues() == null) ? 0 : getCustomerDefinedValues().hashCode());
return hashCode;
}
@Override
public GenerateDataSetRequest clone() {
return (GenerateDataSetRequest) super.clone();
}
}