com.amazonaws.services.marketplacecommerceanalytics.model

Class StartSupportDataExportRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.marketplacecommerceanalytics.model.StartSupportDataExportRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartSupportDataExportRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the StartSupportDataExport operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartSupportDataExportRequest()

Method Summary

Modifier and Type	Method and Description
StartSupportDataExportRequest	addCustomerDefinedValuesEntry(String key, String value) Add a single CustomerDefinedValues entry
StartSupportDataExportRequest	clearCustomerDefinedValuesEntries() Removes all the entries added into CustomerDefinedValues.
StartSupportDataExportRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,String>	getCustomerDefinedValues() (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
String	getDataSetType() Specifies the data set type to be written to the output csv file.
String	getDestinationS3BucketName() The name (friendly name, not ARN) of the destination S3 bucket.
String	getDestinationS3Prefix() (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.
Date	getFromDate() The start date from which to retrieve the data set in UTC.
String	getRoleNameArn() The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
String	getSnsTopicArn() 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.
int	hashCode()
void	setCustomerDefinedValues(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.
void	setDataSetType(String dataSetType) Specifies the data set type to be written to the output csv file.
void	setDataSetType(SupportDataSetType dataSetType) Specifies the data set type to be written to the output csv file.
void	setDestinationS3BucketName(String destinationS3BucketName) The name (friendly name, not ARN) of the destination S3 bucket.
void	setDestinationS3Prefix(String destinationS3Prefix) (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.
void	setFromDate(Date fromDate) The start date from which to retrieve the data set in UTC.
void	setRoleNameArn(String roleNameArn) The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
void	setSnsTopicArn(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.
String	toString() Returns a string representation of this object.
StartSupportDataExportRequest	withCustomerDefinedValues(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.
StartSupportDataExportRequest	withDataSetType(String dataSetType) Specifies the data set type to be written to the output csv file.
StartSupportDataExportRequest	withDataSetType(SupportDataSetType dataSetType) Specifies the data set type to be written to the output csv file.
StartSupportDataExportRequest	withDestinationS3BucketName(String destinationS3BucketName) The name (friendly name, not ARN) of the destination S3 bucket.
StartSupportDataExportRequest	withDestinationS3Prefix(String destinationS3Prefix) (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.
StartSupportDataExportRequest	withFromDate(Date fromDate) The start date from which to retrieve the data set in UTC.
StartSupportDataExportRequest	withRoleNameArn(String roleNameArn) The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
StartSupportDataExportRequest	withSnsTopicArn(String snsTopicArn) Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartSupportDataExportRequest

public StartSupportDataExportRequest()

Method Detail

setDataSetType

public void setDataSetType(String dataSetType)

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

Parameters:

dataSetType - Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

See Also:

SupportDataSetType

getDataSetType

public String getDataSetType()

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

Returns:

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

See Also:

SupportDataSetType

withDataSetType

public StartSupportDataExportRequest withDataSetType(String dataSetType)

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

Parameters:

dataSetType - Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

Returns:

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

See Also:

SupportDataSetType

setDataSetType

public void setDataSetType(SupportDataSetType dataSetType)

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

Parameters:

dataSetType - Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

See Also:

SupportDataSetType

withDataSetType

public StartSupportDataExportRequest withDataSetType(SupportDataSetType dataSetType)

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

Parameters:

dataSetType - Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

Returns:

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

See Also:

SupportDataSetType

setFromDate

public void setFromDate(Date fromDate)

The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.

Parameters:

fromDate - The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.

getFromDate

public Date getFromDate()

The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.

Returns:

The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.

withFromDate

public StartSupportDataExportRequest withFromDate(Date fromDate)

The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.

Parameters:

fromDate - The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.

Returns:

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

setRoleNameArn

public void setRoleNameArn(String roleNameArn)

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

Parameters:

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

getRoleNameArn

public String getRoleNameArn()

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.

withRoleNameArn

public StartSupportDataExportRequest withRoleNameArn(String roleNameArn)

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

Parameters:

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

Returns:

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

setDestinationS3BucketName

public void setDestinationS3BucketName(String destinationS3BucketName)

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

Parameters:

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

getDestinationS3BucketName

public String getDestinationS3BucketName()

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

Returns:

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

withDestinationS3BucketName

public StartSupportDataExportRequest withDestinationS3BucketName(String destinationS3BucketName)

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

Parameters:

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

Returns:

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

setDestinationS3Prefix

public void setDestinationS3Prefix(String destinationS3Prefix)

(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.

Parameters:

destinationS3Prefix - (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.

getDestinationS3Prefix

public String getDestinationS3Prefix()

(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.

withDestinationS3Prefix

public StartSupportDataExportRequest withDestinationS3Prefix(String destinationS3Prefix)

(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.

Parameters:

destinationS3Prefix - (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.

Returns:

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

setSnsTopicArn

public void setSnsTopicArn(String snsTopicArn)

Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

Parameters:

snsTopicArn - Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

getSnsTopicArn

public String getSnsTopicArn()

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.

withSnsTopicArn

public StartSupportDataExportRequest withSnsTopicArn(String snsTopicArn)

Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

Parameters:

snsTopicArn - Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

Returns:

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

getCustomerDefinedValues

public Map<String,String> getCustomerDefinedValues()

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

Returns:

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

setCustomerDefinedValues

public void setCustomerDefinedValues(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.

Parameters:

customerDefinedValues - (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

withCustomerDefinedValues

public StartSupportDataExportRequest withCustomerDefinedValues(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.

Parameters:

customerDefinedValues - (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

Returns:

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

addCustomerDefinedValuesEntry

public StartSupportDataExportRequest addCustomerDefinedValuesEntry(String key,
                                                                   String value)

Add a single CustomerDefinedValues entry

See Also:

withCustomerDefinedValues(java.util.Map<java.lang.String, java.lang.String>)

clearCustomerDefinedValuesEntries

public StartSupportDataExportRequest clearCustomerDefinedValuesEntries()

Removes all the entries added into CustomerDefinedValues.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartSupportDataExportRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()