Package software.amazon.awssdk.services.marketplacecommerceanalytics.model

Class StartSupportDataExportRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.marketplacecommerceanalytics.model.StartSupportDataExportRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>

@Generated("software.amazon.awssdk:codegen")
public class StartSupportDataExportRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>

Container for the parameters to the StartSupportDataExport operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartSupportDataExportRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static StartSupportDataExportRequest.Builder	builder()
Map<String,String>	customerDefinedValues()	(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
String	dataSetType()	Specifies the data set type to be written to the output csv file.
String	destinationS3BucketName()	The name (friendly name, not ARN) of the destination S3 bucket.
String	destinationS3Prefix()	(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.
boolean	equals(Object obj)
Date	fromDate()	The start date from which to retrieve the data set in UTC.
int	hashCode()
String	roleNameArn()	The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
static Class<? extends StartSupportDataExportRequest.Builder>	serializableBuilderClass()
String	snsTopicArn()	Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.
StartSupportDataExportRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dataSetType

public 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

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

fromDate

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

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.

roleNameArn

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

customerDefinedValues

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

Returns:

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

toBuilder

public StartSupportDataExportRequest.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<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>

Returns:

a builder for type T

builder

public static StartSupportDataExportRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartSupportDataExportRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object